CreateSmsSign-阿里云帮助中心

An SMS signature identifies the sender. Before sending messages, you must apply for a signature and a template. The system automatically prepends the approved signature to the message content before sending it to the recipient.

Operation description

For details about the new API and changes to the original API, see Announcement on Updating Signature & Template Interfaces for Short Message Service.
An individual verified user can apply for one official signature per calendar day for each Alibaba Cloud account. This limit does not apply to enterprise verified users. See Usage notes for the differences in benefits between individual and enterprise users.
The Signature Specifications describe the review standards for SMS signatures.
Signatures submitted via the API are synchronized with the Short Message Service console. To manage signatures in the console, see SMS Signature.
After submitting a signature application, you can call GetSmsSign to query its review status and details. You can also Configure Delivery Receipts to receive signature review notifications via SignSmsReport.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SignName	string	Yes	The sign name. The sign name must comply with the signature specifications: The sign name must be 2 to 12 characters long and cannot contain test-related words, such as `test`. You cannot add symbols such as 【】, (), or []. Special characters such as 、, ,, ., or spaces are not supported. Note Sign names are case-sensitive. For example, `Alibaba Cloud Communications` and `alibaba cloud communications` are considered two different signatures. If your verification code and general signatures share the same name, the system defaults to using the general signature for sending messages.	阿里云验证码
Remark	string	No	The use case description for the signature. This description is used for the signature review and must not exceed 200 characters. Note Provide the use case for your launched service, including links to your website or app in an app store. Provide a complete sample message that demonstrates your business scenario. Explain the values passed as variables and describe the business scenario to justify their use. If the signature is for a government agency or public institution, provide their landline phone number. A detailed description can expedite the review of your signature and template. An incomplete or non-compliant description may result in the rejection of your signature application.	登录场景使用验证码
SignType	integer	No	The signature type. Valid values: 0: verification code. 1: general (default). We recommend using the default value: general.	1
MoreData	array	No	Additional materials. You can upload supplementary business documents or screenshots to help reviewers understand your business. For information about what to upload, see Signature application materials.
	string	No	Information about the file uploaded to OSS. For instructions on how to upload files, see Upload files to OSS.	10098689758*****/123qwe.png
QualificationId	integer	Yes	The ID of an approved qualification. Note Before you apply for a signature, you must first apply for a qualification. You can find the qualification ID on the qualification management page.	8563**
ApplySceneContent	string	No	Important Using a launched app as a signature source is no longer supported. The URL of your app in an app store. If the signature source is a launched app (which means the `SignSource` parameter is set to 2), you must provide an app store URL that starts with `http://` or `https://`.	http://www.aliyun.com/
SignSource	integer	Yes	The signature source. Valid values: 0: The full or abbreviated name of an enterprise or public institution. (Recommended) 5: The full or abbreviated name of a trademark. 2: The full or abbreviated name of an app. (Not recommended) For more information about signature sources, see Signature source.	0
ThirdParty	boolean	No	The signature purpose. Valid values: false: for own use (default). The signature belongs to an enterprise, website, or product verified under your account. true: for third-party use. The signature belongs to an enterprise, website, or product not verified under your account. Important Select a qualification ID that matches the signature's purpose (own use or third-party use).	false
AuthorizationLetterId	integer	No	The ID of the authorization letter. This parameter is required if the signature is for third-party use. The Unified Social Credit Code on the authorization letter must match the one in the associated qualification information. An application for a third-party signature will be rejected if this ID is missing or the codes do not match.	1000********1234
TrademarkId	integer	No	The ID of the trademark entity. Note This parameter is required if `SignSource` is set to `5`. You can obtain the trademark entity ID by calling the Create trademark entity operation.	1000009081***
AppIcpRecordId	integer	No	The ID of the app ICP filing entity. Note This parameter is required if `SignSource` is set to `2`. You can obtain the app ICP filing entity ID by calling the Create ICP filing entity operation.	10000****029

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. This unique identifier is generated by Alibaba Cloud and helps you troubleshoot issues.	CCA2BCFF-2BA7-427C-90EE-AC6994748623
Code	string	The request status code. Valid values: `OK`: The request was successful. For other error codes, see the error code list.	OK
Message	string	The message returned with the response.	successful
SignName	string	The signature name.	阿里云
OrderId	string	The work order ID. Reviewers use this ID to check the review status. You must also provide this ID to request an expedited review.	2004415****

Examples

Success response

JSON format

{
  "RequestId": "CCA2BCFF-2BA7-427C-90EE-AC6994748623",
  "Code": "OK",
  "Message": "successful",
  "SignName": "阿里云",
  "OrderId": "2004415****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ForbiddenAction	Access to the account is denied. Please contact the administrator.
400	ParameterMismatch.ThirdParty	The type of signature, whether for personal use or for a third party, should be consistent with the qualifications.	Whether the signature is used by a third party should be consistent with the qualification.
400	SignName.Exists	Sorry, this signature already exists and cannot be applied for again.	Sorry, this signature already exists and cannot be reapplied.
400	InvalidQualification	The qualification should be approved.	Invalid qualification, qualification should be approved.
400	InvalidSignName	The signature cannot contain spaces, special symbols, or all numbers.	The signature cannot contain special characters such as simplified Chinese, English, or spaces other than digits, and cannot be all digits.
400	InvalidApplySceneContent	For certain signature sources, the applySceneContent should be an HTTP or HTTPS link.	invalid application scenario, under some signature sources, The application scenario should be an HTTP or HTTPS link.
400	MissApplySceneContent	In some signature sources, the applySceneContent is required.	Under some signature sources, the application scenario is required.
400	MissingSignName	The signature name cannot be empty.	Signature name cannot be empty
400	SmsAuthorizationLetterNotMatch	Please bind the available authorization letter whose the social credit code is same to the the social credit code of qualification.	Please bind the available authorization letter whose the social credit code is same to the the social credit code of qualification
400	SmsAuthorizationLetterNotExist	Authorization does not belong to the customer.
400	SmsSignNotAuthorized	the signature is not in the sign scope of the authorization letter.	The signature is not within the scope of the authorization.
400	TrademarkNotExist	The trademark does not exist.
400	AppIcpRecordNotExist	The APP-ICP record does not exist.
404	QualificationNotFound	Qualification does not exist.	Qualification does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.