CreateSmsSign-阿里云帮助中心

Applies for an SMS signature. An SMS signature identifies the sender of an SMS message. Before sending SMS messages, you must apply for a signature and a template. The system adds the approved SMS signature to the beginning of the SMS message content and sends it to the recipient together with the message content.

Operation description

For details about the changes between the new operation and the original operation, see Announcement on updating the signature and template operations for SMS.
Users who verify your identity - Individual account can submit one formal signature application per calendar day under the same Alibaba Cloud account. Users who verify your identity - Enterprise account have no such limit. For details about the differences between individual and enterprise user benefits, see Before you begin.
Read the Signature specifications to understand the specific requirements for SMS signature review.
Signature information submitted through the operation is synchronized to the SMS console. For console-related operations, see SMS signature.
After you commit a signature application, you can use the GetSmsSign operation to query the signature review status and details. You can also configure receipt messages and use SignSmsReport to receive signature review status notifications.

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 signature name. Follow the Signature specifications when specifying the signature name: The name must be 2 to 12 characters in length and must not contain words such as "测试" or "test". The name must not contain symbols such as 【】, (), or []. The name must not contain special characters such as 、，。 or spaces. Note Signature names are case-sensitive. For example, 【Aliyun 通信】 and 【aliyun 通信】 are treated as two different signatures. If your verification code signature and general-purpose signature have the same name, the system uses the general-purpose signature to send SMS messages by default.	Alibaba Cloud verification code
Remark	string	No	The description of the SMS signature scenario. This is one of the reference items for signature review. The description can be up to 200 characters in length. Note You can describe the usage scenarios of your online business and provide links to your website or app marketplace download page. You can provide a complete SMS example that reflects your business scenario. You can pass parameter values for variables and describe in detail the business scenarios and the reason for choosing the variable property. If the signature involves a government or enterprise organization, provide the fixed-line phone number of that organization. A well-documented application description improves the efficiency of signature and template review. Incomplete or non-compliant descriptions may affect the approval of your signature review.	Verification code for login scenario
SignType	integer	No	The signature type. Valid values: 0: Verification code. 1: General-purpose (default value). Use the default value: General-purpose.	1
MoreData	array	No	Additional materials. Upload supporting business documents or screenshots to help reviewers understand your business details. See Signature application materials and upload the relevant materials.
	string	No	The information about the file uploaded to OSS. For file upload operations, see Upload objects to OSS.	10098689758*****/123qwe.png
QualificationId	integer	Yes	The ID of an approved qualification. Note Before applying for an SMS signature, apply for a qualification first. You can view the qualification ID on the Qualification management page.	8563**
ApplySceneContent	string	No	Important Signatures sourced from live apps are no longer supported. The app store link. If the signature source is a live app, that is, SignSource is set to 2, enter an app store link that starts with http:// or https:// and make sure the app is live.	http://www.aliyun.com/
SignSource	integer	Yes	The signature source. Valid values: 0: Full or abbreviated name of an enterprise or institution. (Recommended) 5: Full or abbreviated name of a trademark. 2: Full or abbreviated name of an app. (Not recommended) For detailed descriptions of signature sources, see Signature source. Valid values: 0 : Full or abbreviated name of an enterprise or institution. 1 : Full or abbreviated name of a website with an ICP filing from the Ministry of Industry and Information Technology. 2 : Full or abbreviated name of an app. 3 : Full or abbreviated name of an official account or mini program. 4 : Full or abbreviated name of a store on an e-commerce platform. 5 : Full or abbreviated name of a trademark.	0
ThirdParty	boolean	No	The intended use of the signature. Valid values: false: Own use (default value). The signature is the name of an enterprise, website, or product verified under this account. true: Third-party use. The signature is the name of an enterprise, website, or product not verified under this account. Important If the signature is for own use, select an own-use qualification ID. If the signature is for third-party use, select a third-party qualification ID.	false
AuthorizationLetterId	integer	No	The ID of the authorization letter. If the signature is for third-party use, the authorization letter ID is required. Otherwise, the signature review will not be approved. The unified social credit code in the authorization letter must match the unified social credit code in the qualification information bound to the signature. Otherwise, signature creation will fail.	1000********1234
TrademarkId	integer	No	The trademark entity ID. Note When SignSource is set to 5, you must provide the trademark entity ID. You can obtain the trademark entity ID by calling the CreateSmsTrademark operation. To comply with carrier real-name registration requirements, provide the relevant field information. Otherwise, the probability of "review rejection or carrier registration failure" increases significantly.	1000009081***
AppIcpRecordId	integer	No	The APP ICP filing entity ID. Note When SignSource is set to 2, you must provide the ICP filing entity ID. You can obtain the ICP filing entity ID by calling the CreateSmsAppIcpRecord operation.	10000****029

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. This is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot and locate issues.	CCA2BCFF-2BA7-427C-90EE-AC6994748623
Code	string	The request status code. Valid values: OK: The request was successful. For other error codes, see Error code list.	OK
Message	string	The description of the status code.	successful
SignName	string	The signature name.	Alibaba Cloud
OrderId	string	The ticket number. Reviewers use this parameter when querying reviews. Provide this ticket number if you need to expedite the review.	2004415****

Examples

Success response

JSON format

{
  "RequestId": "CCA2BCFF-2BA7-427C-90EE-AC6994748623",
  "Code": "OK",
  "Message": "successful",
  "SignName": "Alibaba Cloud",
  "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.	The authorization letter does not belong to this 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.	The associated trademark entity does not exist.
400	AppIcpRecordNotExist	The APP-ICP record does not exist.	The associated APP ICP filing entity 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.