UpdateSmsSign-阿里云帮助中心

Modifies an SMS signature that has failed or passed the review. After the modification, the signature is automatically submitted for review and enters the pending review state via autocommit.

Operation description

For details about the changes between the new and original operations, see Announcement on updating signature and template operations for Short Message Service.
You can modify signatures that have failed the review or passed the review. Refer to Suggestions for handling SMS review failures to modify and recommit signatures for review by invoking this operation.
If you want to edit the name of a signature that has failed the review, this operation does not support that. Access the console to make the modification. Short Message Service signature console.
Signature information applied through the API is in synchronization with the Short Message Service console. For related operations on signatures in the console, see SMS signatures.

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

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
SignName	string	Yes	The SMS signature that has not passed the review. You can view signatures that have not passed the review on the China Mainland Messages > Signature Management tab in the console. You can also call the QuerySmsSignList operation to query signatures that have not passed the review.	Alibaba Cloud CAPTCHA.
Remark	string	No	The description of the SMS signature usage scenario. This is one of the reference materials for signature review. The description cannot exceed 200 characters. Note You can provide the scenarios of your online business, along with the actual business website link or marketplace download link. You can provide a complete SMS example that reflects your business scenario. You can provide the pass parameter content of variables and describe in detail the business usage scenario and the reason for selecting the variable property. If the signature involves a government or public institution, include the landline phone number of the institution. A well-documented application description improves the review efficiency for signatures and templates. Failure to follow the guidelines or leaving this field empty may affect the approval of your signature.	Applying for a verification code in a logon scenario.
SignType	integer	No	The signature type. Valid values: 0: verification code. 1: general (default). We recommend that you use the default value: general.	1
MoreData	array	No	Additional materials. Upload supplementary business proof files or business screenshots to help reviewers understand your business details. Refer to Signature application materials to upload relevant materials.
	string	No	The file information uploaded to OSS. The file name cannot contain Chinese characters or special characters. For file upload instructions, see Upload files through OSS.	10098689758*****/1234qwe.png
QualificationId	integer	Yes	The ID of the qualification that has passed the review. 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	The app store link. If the signature source is "launched app", that is, `SignSource` is set to 2, provide an app store link that starts with http:// or https://, and make sure the app is already launched.	http://www.aliyun.com/
SignSource	integer	Yes	The signature source. Valid values: 0: full name or abbreviation of an enterprise or public institution. (Recommended) 5: full name or abbreviation of a trademark. 2: full name or abbreviation of an app. (Not recommended) For more information about signature sources, see Signature sources.	2
ThirdParty	boolean	No	The signature purpose. Valid values: false: for personal use (default). The signature is the enterprise name, website, or product name verified under this account. true: for third-party use. The signature is the enterprise name, website, or product name not verified under this account. Important If the signature is for personal use, select a qualification ID for personal use. If the signature is for third-party use, select a qualification ID for third-party use.	false
AuthorizationLetterId	integer	No	The ID of the authorization letter. When the signature is for third-party use, the authorization letter ID cannot be empty. Otherwise, the signature review will fail. The unified social credit code in the authorization letter must be consistent with the unified social credit code in the qualification information bound to the signature. Otherwise, the signature creation fails.	1000********1234
TrademarkId	integer	No	The trademark entity ID. Note When SignSource is set to 5, the trademark entity ID is required. You can obtain the trademark entity ID by calling the CreateSmsTrademark operation.	1000009081***
AppIcpRecordId	integer	No	The APP-ICP filing entity ID. Note When SignSource is set to 2, the filing entity ID is required. You can obtain the filing entity ID by calling the CreateSmsAppIcpRecord operation.	100001***1234

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID. It is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot issues.	A90E4451-FED7-49D2-87C8-00700A8C4D1D
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
SignName	string	The modified signature name.	China Telecom.
OrderId	string	The ticket number. Reviewers use this parameter when querying the review status. Provide this ticket number if you need to expedite the review.	2004417****

Examples

Success response

JSON format

{
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D1D",
  "Code": "OK",
  "Message": "OK",
  "SignName": "China Telecom.",
  "OrderId": "2004417****"
}

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	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	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	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.