If you apply for a qualification or an SMS signature that involves third-party rights, you must obtain authorization from the third party. You must create a Letter of Authorization before you submit the request.
Operation description
Before you start, read the Letter of Authorization specifications. Download the Letter of Authorization template, fill it out as required, affix your official seal, and then upload the file.
You can use a created Letter of Authorization when you apply for an SMS qualification or an SMS signature. If the qualification or signature is for third-party use, you must create and submit a Letter of Authorization.
After you create a Letter of Authorization, you can call the QuerySmsAuthorizationLetter operation to query its details. Information about letters of authorization created using the API is synchronized with the Short Message Service console.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| AuthorizationLetterPic |
string |
Yes |
The fileKey of the Letter of Authorization.
|
123456/test1719383196031.jpg |
| SignList |
array |
Yes |
A list of delegated SMS signatures. You can specify up to 100 signatures. Note
Authorize all potential signatures in the Letter of Authorization at once. This prevents future signature requests from being rejected because they are not included in the letter, which would require you to submit a new Letter of Authorization. |
|
|
string |
No |
The name of the SMS signature. Adhere to the signature specifications. The name must be 2 to 12 characters long. It cannot contain words such as "test". Symbols such as 【】, (), and [] are not supported. Special characters such as ,, |
菜鸟网络 |
|
| AuthorizationLetterExpDate |
string |
Yes |
The validity period of the Letter of Authorization. The format is Note
Set a reasonable validity period, such as 1 to 3 years. Avoid setting a period that is too long or too short. |
2023-01-01~2026-01-01 |
| Authorization |
string |
Yes |
The authorizer, which is the owner of the signature. The name can be up to 150 characters long. It cannot consist of only digits or contain symbols other than the middle dot ( |
菜鸟网络科技有限公司 |
| OrganizationCode |
string |
Yes |
The Unified Social Credit Code of the authorizer. The length cannot exceed 150 characters. The code must be the same as the Unified Social Credit Code specified in the qualification information that is attached to the signature. Otherwise, the signature cannot be created. |
9****************A |
| ProxyAuthorization |
string |
Yes |
The authorized party, which is the applicant of the signature. The name can be up to 150 characters long. It cannot consist of only digits or contain symbols other than the middle dot ( |
支付宝(中国)网络技术有限公司 |
| AuthorizationLetterName |
string |
Yes |
The name of the Letter of Authorization. The name must be unique among your letters of authorization. The name can be up to 100 characters long and can contain only Chinese characters, English letters, or a combination of them with digits. The name cannot contain symbols or consist of only digits. |
菜鸟公司授权书 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| AccessDeniedDetail |
string |
The details of the access denial. This field is returned only when RAM authentication fails. |
无 |
| RequestId |
string |
The ID of the request. This ID is a unique identifier generated by Alibaba Cloud for the request. You can use it to troubleshoot and locate issues. |
F655A8D5-B967-440B-8683-DAD6FF8DE990 |
| Message |
string |
The description of the status code. |
OK |
| Data |
string |
The ID of the Letter of Authorization. |
10000**** |
| Code |
string |
The status code of the request.
|
OK |
| Success |
boolean |
Indicates whether the API call was successful. Valid values:
Valid values:
|
true |
Examples
Success response
JSON format
{
"AccessDeniedDetail": "无",
"RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990\n",
"Message": "OK",
"Data": "10000****",
"Code": "OK",
"Success": true
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | AuthorizationLetterNameRepeat | The authorization letter name is duplicated. | |
| 400 | AuthorizationLetterDateNotMatchRegex | The format of the authorization letter's effective and expiry date is incorrect. | |
| 400 | AuthorizationLetterDateNotValid | The current time is not within the validity period of the authorization letter. | |
| 400 | AuthorizationLetterNameNotMatchRegex | The authorization letter name cannot be empty and must consist of Chinese, English characters or a combination with numbers, symbols or purely numeric input are not supported. | |
| 400 | AuthorizationLetterNameOverLimit | The authorization letter name exceeds the 100-character length limit. | |
| 400 | AuthorizationNotMatchRegex | The authorizer name cannot be empty and currently does not support any symbols except middle dots, spaces, Chinese brackets, and English parentheses or purely numeric input. | |
| 400 | AuthorizationOssFileNotUploadError | The authorization letter file has not been uploaded. | |
| 400 | AuthorizationOverLimit | The authorizer exceeds the 1000-character length limit. | |
| 400 | ProxyAuthorizationOverLimit | The authorized party exceeds the 1000-character length limit. | |
| 400 | ProxyAuthorizationNotMatchRegex | The authorized party name currently does not support any symbols except middle dots, spaces, Chinese brackets, and English parentheses or purely numeric input. | |
| 400 | SignNumOverLimit | The signature exceeds the limit of 100 entries. | |
| 400 | SignNotMatchRegex | The signature length is limited to 2-12 characters and does not support some special characters. | |
| 400 | OrganizationCodeOverLimit | The organization code is limited to 150 characters. | Social credit code is not allowed to exceed 150 characters |
See for a complete list.
Release notes
See Release Notes for a complete list.