QuerySmsSignList-阿里云帮助中心

Call this operation to query all SMS signatures under your account and view details such as the approval status, type, and name.

Operation description

This operation queries the details of the first-created or most recently approved version of an SMS signature under your account. To query more information, such as the application scenario, uploaded files, and approval details for a single SMS signature by its name, call the GetSmsSign operation.

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 page number. The default value is 1.	1
PageSize	integer	No	The number of signatures per page. The default value is 10. Valid values: 1 to 50.	10

Response elements

Element	Type	Description	Example
	object	The returned data.
RequestId	string	The request ID.	F655A8D5-B967-440B-8683-DAD6FF8DE990
Code	string	The request status code. Valid values: OK: The request was successful. For a list of other error codes, see Error codes.	OK
Message	string	The description of the status code.	OK
SmsSignList	array<object>	The list of results.
	array<object>	The list of results.
SignName	string	The name of the SMS signature.	阿里云
AuditStatus	string	The approval status of the SMS signature. Valid values: AUDIT_STATE_INIT: The signature is being reviewed. AUDIT_STATE_PASS: The signature is approved. AUDIT_STATE_NOT_PASS: The signature is rejected. For the reason for rejection, see the Reason parameter. AUDIT_STATE_CANCEL: The review is canceled.	AUDIT_STATE_NOT_PASS
CreateDate	string	The date and time when the SMS signature was created. The format is yyyy-MM-dd HH:mm:ss.	2020-06-04 11:42:17
Reason	object	The review remarks. If `AuditStatus` is AUDIT_STATE_PASS or AUDIT_STATE_INIT, the value of this parameter is "No review remarks". If `AuditStatus` is AUDIT_STATE_NOT_PASS, this parameter indicates the reason for rejection.
RejectSubInfo	string	The remarks for the rejection.	文件不能证明信息真实性，请重新上传。
RejectDate	string	The time when the signature was rejected. The format is yyyy-MM-dd HH:mm:ss.	2020-06-04 13:35:10
RejectInfo	string	The reason for the rejection.	文件不能证明信息真实性，请重新上传。
BusinessType	string	The type of the signature scenario. Valid values: Captcha. General.	验证码类型
OrderId	string	The ticket ID. Reviewers use this parameter to query reviews. Provide this ticket ID to request an expedited review.	2005098****
AuthorizationLetterId	integer	The ID of the Letter of Authorization.	1000********1234
authorizationLetterAuditPass	boolean	The approval status of the Letter of Authorization. Valid values: true: approved. false: not approved (this 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 record entity.	1000001***123
TotalCount	integer	The total number of signatures.	100
CurrentPage	integer	The current page number. The default value is 1.	1
PageSize	integer	The number of signatures per page. The default value is 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": "阿里云",
      "AuditStatus": "AUDIT_STATE_NOT_PASS",
      "CreateDate": "2020-06-04 11:42:17",
      "Reason": {
        "RejectSubInfo": "文件不能证明信息真实性，请重新上传。",
        "RejectDate": "2020-06-04 13:35:10",
        "RejectInfo": "文件不能证明信息真实性，请重新上传。"
      },
      "BusinessType": "验证码类型",
      "OrderId": "2005098****",
      "AuthorizationLetterId": 0,
      "authorizationLetterAuditPass": true,
      "TrademarkId": 0,
      "AppIcpRecordId": 0
    }
  ],
  "TotalCount": 100,
  "CurrentPage": 1,
  "PageSize": 10
}

Error codes

See for a complete list.

Release notes

See Release Notes for a complete list.