Modify USMS Signature - UpdateUSMSSignature
Overview
Invoke the UpdateUSMSSignature interface to modify the unapproved SMS signature and resubmit for review.
💡 The SMS signature must comply with the UCloud Service Agreement , and the application process for the SMS signature can be referred to the official website’s SMS Signature Review Standards instructions;
ℹ️ After applying for the USMS signature, if it does not pass the review, you can modify the unapproved USMS signature by calling the UpdateUSMSSignature interface and resubmit it for review;
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is UpdateUSMSSignature . | 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 will be used. Sub-accounts must fill in. Please refer to the GetProjectList interface. | Yes |
SigId | string | Signature ID (also known as the work order ID when applying for a text message signature), supports being passed in as an array, for example, in the form of SigIds.0, SigIds.1…SigIds.N. | Yes |
SigContent | string | New SMS signature content; length is 2-12 characters, can include Chinese, numbers, and symbols; no need to fill in 【】or [], the system will automatically add them. | Yes |
SigType | int | Signature types are as follows: 0 - Full or abbreviated name of a company or enterprise; 1 - Full or abbreviated name of an App application; 2 - Full or abbreviated name of a website registered with the Ministry of Industry and Information Technology; 3 - Full or abbreviated name of a public account or mini-program; 4 - Full or abbreviated name of a trademark; 5 - Full or abbreviated name of a government/organ/other unit; | Yes |
SigPurpose | int | Purpose of signature, 0-Self-use, 1-Other’s use; | Yes |
File | string | The content of the qualification proof document for SMS signature needs to be converted into base64 encoding format first, and the converted string is filled in here. The file size does not exceed 4 MB. The content format is as follows: [file type];[code type],[base64] For example: image/jpeg;base64,5YaF5a65”. | No |
CertificateType | int | The type of qualification certificate for the signature must be consistent with the signature type, as follows: 0 - Three-in-one / Business License / Organization Code Certificate / Social Credit Code Certificate; 1 - Screenshot of the App Store backend developer management; 2 - Screenshot of successful filing by the filing service provider (including domain name, website name, filing number); 3 - Screenshot of the management interface of the public account or mini program; 4 - Trademark registration certificate; 5 - Organization code certificate, social credit code certificate;”. | No |
ProxyFile | string | The content of the SMS signature authorization letter needs to be converted into base64 encoding format first, and the converted string is filled in here. The file size does not exceed 4 MB; when you are an agent and use the signature of a third party (that is, SigPurpose is 1-for others), this item is required; the format is similar to File. | No |
Document | string | The URL of the qualification document for the SMS signature. If the review material has not been changed, use the URL link of the uploaded review material, otherwise use the File parameter. | No |
ProxyDoc | string | URL of the SMS signature authorization letter. If the authorization letter has not been changed, fill in the URL link of the uploaded authorization letter here, otherwise use the ProxyFile parameter. | No |
SceneDesc | string | Description of the scenario corresponding to the USMS signature | 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=UpdateUSMSSignature
&ProjectId=org-bxxxxy
&SigId=SIG20190XXX2C1844
&SigType=0
&SigContent=UCloud
&SigPurpose=0
&CertificateType=0
&File=iVBORw0KGgoXXXXXXXXXXXXXXXXXXNSUhEU
&Document=hJJRaVwT
&ProxyDoc=iGNJVNlH
&SceneDesc=LXLCsLks
Response Example
{
"Action": "UpdateUSMSSignatureResponse",
"Message": "",
"RetCode": 0
}