Modify USMS Template - UpdateUSMSTemplate
Overview
Invoke the UpdateUSMSTemplate interface to modify the unapproved SMS template and resubmit it for review.
💡 Modify message template. Used to modify existing templates. After successful submission, if the template content is modified, the template status will be reset to the initial creation state; if only the template name is modified, it will not be reset.
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is UpdateUSMSTemplate . | Yes |
PublicKey | string | The user’s public key can be obtained from Console  | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
ProjectId | string | Project ID. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface. | Yes |
TemplateId | string | SMS Template ID | Yes |
Template | string | New template content. Either a template name or template content must be provided, otherwise an error will occur. Must be less than or equal to 600 characters. | Yes |
TemplateName | string | New template name. Less than or equal to 32 characters, each Chinese, English, array, and symbol are counted as one character. | No |
Remark | string | Reason for SMS template application, the number of characters should not exceed 128. Each Chinese character, symbol, English letter, number, etc. is counted as one character. | No |
Instruction | string | Template Variable Property Description | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Example
Request Example
https://api.ucloud-global.com/?Action=UpdateUSMSTemplate
&ProjectId=org-bxxxxy
&TemplateId=UTA1908XXXX8B3F
&Template=alertXXXXXXXXXXXXXXXXXXXXXXXX
&TemplateName=ucloud-alert
&Remark=XXXXXXXXXXXXXXX
&UnsubscribeInfo=sUGREgjQ
&Instruction=cmUVPDNr
Response Example
{
"Action": "UpdateUSMSTemplateResponse",
"Message": "",
"RetCode": 0
}