QuerySmsSignList-阿里云帮助中心

Queries all signatures under your account, allowing you to view signature details, including the signature approval status, signature type, and signature name.

Operation description

This operation queries the signature details that were initially created or most recently approved under your current account. To query additional information such as common scenarios content or file materials uploaded during the application, invoke the GetSmsSign operation to query the approval details of a single signature by signature name.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

dysms:QuerySmsSignList

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageIndex	integer	No	The current page number. Default value: 1.	1
PageSize	integer	No	The number of signatures displayed per page. Default value: 10. Valid values: 1 to 50.	10

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	F655A8D5-B967-440B-8683-DAD6FF8DE990
Code	string	The request status code. Valid values: OK: The request was successful. For other error codes, see Error codes.	OK
Message	string	The description of the status code.	OK
SmsSignList	array<object>	The result list.
	array<object>	The result list.
SignName	string	The signature name.	Alibaba Cloud.
AuditStatus	string	The signature approval status. Valid values: AUDIT_STATE_INIT: Under review. AUDIT_STATE_PASS: Approved. AUDIT_STATE_NOT_PASS: Rejected. Check the Reason response parameter for the rejection reason. AUDIT_STATE_CANCEL: Review canceled.	AUDIT_STATE_NOT_PASS
CreateDate	string	The date and time when the SMS signature was created, in the format of yyyy-MM-dd HH:mm:ss.	2020-06-04 11:42:17
Reason	object	The review remarks. If the review status is Approved or Under review, the Reason parameter displays "No review remarks". If the review status is Rejected, the Reason parameter displays the specific reason for rejection.
RejectSubInfo	string	The remarks for the rejection.	The file cannot prove the authenticity of the information. Upload a new file.
RejectDate	string	The time when the signature was rejected, in the format of yyyy-MM-dd HH:mm:ss.	2020-06-04 13:35:10
RejectInfo	string	The reason for the rejection.	The file cannot prove the authenticity of the information. Upload a new file.
BusinessType	string	The signature scenario type. Valid values: Verification code type. General type.	Verification code type.
OrderId	string	The ticket number. Reviewers use this parameter when querying reviews. Provide this ticket number if you need to expedite the review.	2005098****
AuthorizationLetterId	integer	The ID of the authorization letter.	1000********1234
authorizationLetterAuditPass	boolean	The review status of the authorization letter. Valid values: true: Approved. false: Not approved (includes all statuses other than approved). Valid values: true : true false : false	true
TrademarkId	integer	The ID of the trademark entity.	1000009081***
AppIcpRecordId	integer	The ID of the APP-ICP filing entity.	1000001***123
TotalCount	integer	The total number of signatures.	100
CurrentPage	integer	The current page number. Default value: 1.	1
PageSize	integer	The number of signatures displayed per page. Default value: 10. Valid values: 1 to 50.	10

Examples

Success response

JSON format

{
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990\n",
  "Code": "OK",
  "Message": "OK",
  "SmsSignList": [
    {
      "SignName": "Alibaba Cloud.",
      "AuditStatus": "AUDIT_STATE_NOT_PASS",
      "CreateDate": "2020-06-04 11:42:17",
      "Reason": {
        "RejectSubInfo": "The file cannot prove the authenticity of the information. Upload a new file.",
        "RejectDate": "2020-06-04 13:35:10",
        "RejectInfo": "The file cannot prove the authenticity of the information. Upload a new file."
      },
      "BusinessType": "Verification code type.",
      "OrderId": "2005098****",
      "AuthorizationLetterId": 0,
      "authorizationLetterAuditPass": true,
      "TrademarkId": 0,
      "AppIcpRecordId": 0
    }
  ],
  "TotalCount": 100,
  "CurrentPage": 1,
  "PageSize": 10
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.