UpdateSmsSign-阿里云帮助中心

You can modify rejected or approved signatures. A modified signature is automatically submitted for review, and its status changes to pending review.

Operation description

For details about the updates to the signature and template APIs, see Announcement on Updating Signature & Template APIs for Short Message Service.
You can modify signatures that are either rejected or approved. For guidance on handling review failures, see Handling signature review failures. Call this API to modify and resubmit the signature for review.
You cannot use this API to edit the name of a rejected signature. To edit the name, go to the Short Message Service console.
Signatures you request using this API are synchronized with the Short Message Service console. For information on managing signatures in the console, see 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 name of the rejected SMS signature. You can find rejected SMS signatures on the Domestic Messages > Signature Management page in the console, or by calling the QuerySmsSignList operation.	阿里云验证码
Remark	string	No	A description of the SMS signature's use case. This information is used during the review and must be 200 characters or less. Note Describe the use case for your live service. Include relevant links, such as a website link or an app store link. Provide a complete example of an SMS message that reflects your use case. Provide the values for any variables. Describe the use case in detail and explain why the variables are necessary. If the signature involves a government agency or public institution, provide its official landline number. Providing complete and accurate information accelerates the review process. If you do not provide the required information, your signature application may be rejected.	登录场景申请验证码
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 supporting materials. You can upload supporting business documents or business screenshots to help with the review. For details on what to upload, see Signature application materials.
	string	No	The OSS path of the uploaded file. The file name cannot contain Chinese characters or special characters. For information about how to upload a file, see Upload files via OSS.	10098689758*****/1234qwe.png
QualificationId	integer	Yes	The ID of the approved qualification. Note You must apply for a qualification before applying for an SMS signature. You can find the qualification ID on the qualification management page.	8563**
ApplySceneContent	string	No	The app store link. This parameter is required if the signature source (`SignSource`) is an app (the value is 2). The link must start with `http://` or `https://`, and the app must be published in the app store.	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 trademark name. 2: The full or abbreviated name of an app. (Not recommended) For more information, see signature source.	2
ThirdParty	boolean	No	The signature purpose. Valid values: false: for own use (default). The signature is for a business, website, or product owned by your account's verified entity. true: for third-party use. The signature is for a business, website, or product not owned by your account's verified entity. Important Ensure the selected qualification ID matches the signature purpose (for own use or for third-party use).	false
AuthorizationLetterId	integer	No	The authorization letter ID. This parameter is required if the signature is for third-party use (`ThirdParty` is set to `true`). The Unified Social Credit Code on the authorization letter must match the code in the selected qualification's information.	1000********1234
TrademarkId	integer	No	The trademark entity ID. 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's ICP filing entity. Note This parameter is required if `SignSource` is set to 2. You can obtain the filing entity ID by calling the Create ICP Filing Entity operation.	100001***1234

Response elements

Element	Type	Description	Example
	object	The response body.
RequestId	string	The unique identifier for the request, generated by Alibaba Cloud. Use this ID to troubleshoot issues.	A90E4451-FED7-49D2-87C8-00700A8C4D1D
Code	string	The status code of the request. 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 updated signature name.	登录验证
OrderId	string	The order ID. Reviewers use this ID to look up the submission. Provide this order ID to request an expedited review.	2004417****

Examples

Success response

JSON format

{
  "RequestId": "A90E4451-FED7-49D2-87C8-00700A8C4D1D",
  "Code": "OK",
  "Message": "OK",
  "SignName": "登录验证",
  "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.