GetSmsSign-阿里云帮助中心

After you request an SMS signature, you can call this operation to query the approval details of the signature.

Operation description

This operation queries information about only the first created signature or the latest approved signature.
For more information about the changes to the new and original operations, see Announcement on updates of SMS signature and template operations in Short Message Service.
Review time: Alibaba Cloud typically reviews an SMS signature within 2 hours after it is submitted. Reviews are conducted from 9:00 to 21:00 from Monday to Sunday, and are postponed on public holidays.
If an SMS signature is rejected, the reason for the rejection is returned. For more information, see Suggestions on how to handle a rejected SMS signature. You can call the UpdateSmsSign operation or modify the rejected SMS signature on the Signatures page in the console.
You can call the QuerySmsSignList operation to query all SMS signatures under your account, including their approval statuses, types, and names.
The queries per second (QPS) limit for a single user is 150. If you exceed the limit, API calls are throttled, which may affect your business. We recommend that you call this operation at a reasonable rate.

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:GetSmsSign

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SignName	string	Yes	The name of the SMS signature. The signature must be an existing one under your account. Obtain the signature from the response to the CreateSmsSign operation. View the signature on the Signatures page.	阿里云

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. Alibaba Cloud generates this ID to uniquely identify a request. Use this ID to troubleshoot issues.	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 API error codes.	OK
Message	string	The description of the status code.	OK
SignName	string	The name of the SMS signature.	登录验证
SignStatus	integer	The approval status of the signature. Valid values: 0: The signature is pending approval. 1: The signature is approved. 2: The signature is rejected. For more information, see the `AuditInfo.RejectInfo` parameter. 10: The approval is canceled.	2
CreateDate	string	The date and time when the SMS signature was created.	2024-06-03 10:02:34
OrderId	string	The ticket ID. Reviewers use this ID to query the review progress. Provide this ticket ID to accelerate the review.	20044156924
QualificationId	integer	The qualification ID. This is the ID of the qualification associated with the SMS signature application.	2004393****
Remark	string	A description of the SMS signature's use case. The description can be up to 200 characters long.	登录场景验证码
AuditInfo	object	The approval information.
RejectInfo	string	The reason the signature was rejected.	通过资质信息，不能判断是否可以申请此签名。
AuditDate	string	The time the signature was reviewed.	2024-06-03 12:02:34
FileUrlList	array	A list of supplementary business certificates or screenshots of business scenarios.
	string	Information about the file uploaded to OSS.	10098689758*****/1234qwe.png
SignCode	string	The code of the SMS signature.	SIGN_100000077042023_17174665*****_ZM2kG
SignTag	string	The signature tag. Valid values: 2: The signature is created by a user. 3: The signature is provided by the system. 4: The signature is a test signature. 5: The signature is a trial signature.	2
ApplyScene	string	The content of the application scenario.	http://www.aliyun.com/
ThirdParty	boolean	Indicates whether the signature is for personal use or for third-party use. false: The signature is for personal use. This is the default value. true: The signature is for third-party use.	false
SignUsage	string	The use case of the signature.	已注册商标名称。
RegisterResult	integer	This parameter is deprecated. Use the `SignIspRegisterDetailList` parameter to view the registration results of carriers. The result of the signature's real-name registration. Valid values: 0: Registration failed. 1: Registration succeeded. 2: Registration expired. -1: No status. For more information about real-name registration for SMS signatures and suggested operations, see Real-name registration for SMS signatures.	1
AuthorizationLetterId	integer	The ID of the Letter of Authorization.	1000********1234
AuthorizationLetterAuditPass	boolean	The approval status of the Letter of Authorization. Valid values: true: The Letter of Authorization is approved. false: The Letter of Authorization is not approved. This includes all statuses other than approved. Valid values: true : true false : false	true
SignIspRegisterDetailList	array<object>	A list of carrier registration statuses. To get the data for this parameter, you must update the SDK to version 4.1.2 or later.
	array<object>
RegisterStatus	integer	The registration status. Valid values: 0: Registration failed. The failure may be because the qualification information is inconsistent with the information registered with the Ministry of Industry and Information Technology (MIIT) or the carrier does not support the registration. Log on to the Short Message Service console to view the specific reason for the failure and perform the prompted operations. 1: Registered and pending verification. At least one sub-port number has been approved by a carrier. Send verification codes or notification messages to phone numbers of different carriers in small batches for verification. 2: Registration expired. The registration expires if no messages are sent using the signature for more than six months. To re-enable the signature, submit a new registration request in the Short Message Service console. 3: Registration successful. At least one sub-port number has been approved by a carrier. The message delivery success rate meets the expectation after verification. Continue to monitor the delivery success rate. -1: Registering. The registration result from the carrier has not been received. Wait until the registration status of the signature changes to Registered and pending verification before you send messages in batches. You can try sending messages in small batches using the signature to observe the delivery effect. -2: Not registered. The reason may be that the signature is not associated with real-name qualifications or the associated qualification information is incomplete. Modify the current qualifications or edit the signature and associate it with other qualifications to submit a new registration request. For more information about real-name registration for SMS signatures and suggested operations, see Real-name registration for SMS signatures.	0
OperatorCode	string	The carrier type. Valid values: mobile: China Mobile unicom: China Unicom telecom: China Telecom	telecom
OperatorCompleteTime	string	The time the carrier provided feedback, in `yyyy-MM-dd HH:mm:ss` format.	2025-06-13 15:55:26
RegisterStatusReasons	array<object>	A list of reasons for the registration status.
	object
ReasonCode	string	The code of the reason for the registration status. Valid values: UNBINDING_QUA: The signature is not associated with a qualification. BINDING_INCOMPLETE_QUA: The information about the associated qualification is incomplete. NON_REGISTER: No registration request is submitted. REGISTERING: The signature is being registered. DETECTING: No detection is initiated or the detection is in progress. DETECT_SUCCESS: The registration is successful. QUALIFICATION_ERROR: The registration failed due to a qualification-related issue. SIGNATURE_ERROR: The registration failed due to a signature-related issue. SIGNATURE_QUALIFICATION_ERROR: The signature does not match the qualification. ONE_CODE_MULTIPLE_SIGN: The registration failed due to an extension code-related issue. OTHERS_ERROR: The registration failed due to other reasons. REGISTER_TIMEOUT: The registration timed out. NO_SEND_RECORD: No messages were sent using the signature for more than six months. EXT_CODE_RECYCLE: The extension code is reclaimed. SUBPORT_RECYCLE: The sub-port is managed by the carrier.	REGISTER_TIMEOUT
ReasonDescList	array	A list of reason descriptions. A reason code may have zero or more descriptions.
	string	The reason description.	报备超时。
TrademarkId	integer	The ID of the trademark entity.
AppIcpRecordId	integer	The ID of the APP ICP filing entity.

Examples

Success response

JSON format

{
  "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
  "Code": "OK",
  "Message": "OK",
  "SignName": "登录验证",
  "SignStatus": 2,
  "CreateDate": "2024-06-03 10:02:34",
  "OrderId": "20044156924",
  "QualificationId": 0,
  "Remark": "登录场景验证码",
  "AuditInfo": {
    "RejectInfo": "通过资质信息，不能判断是否可以申请此签名。",
    "AuditDate": "2024-06-03 12:02:34\n"
  },
  "FileUrlList": [
    "10098689758*****/1234qwe.png\n"
  ],
  "SignCode": "SIGN_100000077042023_17174665*****_ZM2kG",
  "SignTag": "2",
  "ApplyScene": "http://www.aliyun.com/\n",
  "ThirdParty": false,
  "SignUsage": "已注册商标名称。",
  "RegisterResult": 1,
  "AuthorizationLetterId": 0,
  "AuthorizationLetterAuditPass": true,
  "SignIspRegisterDetailList": [
    {
      "RegisterStatus": 0,
      "OperatorCode": "telecom",
      "OperatorCompleteTime": "2025-06-13 15:55:26",
      "RegisterStatusReasons": [
        {
          "ReasonCode": "REGISTER_TIMEOUT",
          "ReasonDescList": [
            "报备超时。"
          ]
        }
      ]
    }
  ],
  "TrademarkId": 0,
  "AppIcpRecordId": 0
}

Error codes

HTTP status code	Error code	Error message	Description
400	ForbiddenAction	Access to the account is denied. Please contact the administrator.
404	SignatureNotFound	The signature does not exist.	The corresponding signature cannot be found under the account.

See for a complete list.

Release notes

See Release Notes for a complete list.