CreateSmsAuthorizationLetter

Updated at:

Creates an authorization letter. If the qualification is applied for third-party use or the signature involves third-party rights, you must obtain third-party authorization and create an authorization letter before submitting the application.

Operation description

  • Before you begin, read the Authorization letter specifications, download the authorization letter template, fill in the template according to the specifications, stamp it, and upload it.

  • The authorization letter you create can be used when you apply for SMS qualifications or SMS signatures. If your qualification or signature involves third-party use, you must create and submit an authorization letter.

  • After creating an authorization letter, you can call QuerySmsAuthorizationLetter to query the details of the created authorization letter. Authorization letter information created through the API is synchronized to the Short Message Service console.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

AuthorizationLetterPic

string

Yes

The fileKey of the authorization letter.

  1. The file information of the authorization letter uploaded to OSS. Download the authorization letter template, fill in the template according to the specifications, stamp it, and upload it. File upload requirements:

  • The file name cannot contain Chinese characters or special characters.

  • Only images in jpg, png, gif, or jpeg format are supported. The image size cannot exceed 5 MB.

  1. For information about how to obtain the fileKey, see Upload a file through OSS.

123456/test1719383196031.jpg

SignList

array

Yes

The list of authorized signatures. The number of signatures cannot exceed 100.

Note

We recommend that you authorize all signatures that you may need in the authorization letter at one time. This prevents signature applications from being rejected because the signature is not within the scope of the authorization letter, which would require you to create a new authorization letter.

string

No

The SMS signature name. Follow the signature specifications. The name must be 2 to 12 characters in length. It cannot contain words such as "test". It cannot contain symbols such as 【】, (), or []. It cannot contain special characters such as commas, periods, or spaces.

Cainiao Network

AuthorizationLetterExpDate

string

Yes

The validity period of the authorization letter. Format: YYYY-MM-DD~YYYY-MM-DD.

Note

The recommended validity period is 1 to 3 years. Set a reasonable time period to avoid an excessively long or short validity period.

2023-01-01~2026-01-01

Authorization

string

Yes

The authorizer, which is the signature owner. Only the middle dot ·, Chinese brackets 【】(), English parentheses (), and spaces are supported as symbols. Other symbols or pure numeric input is not allowed. The maximum length is 150 characters.

Cainiao Network Technology Co., Ltd

OrganizationCode

string

Yes

The unified social credit code of the authorizer. The maximum length is 150 characters. The credit code must be consistent with the unified social credit code field in the qualification information bound to the signature. Otherwise, the signature creation fails.

9****************A

ProxyAuthorization

string

Yes

The authorized party, which is the signature applicant. Only the middle dot ·, Chinese brackets 【】(), English parentheses (), and spaces are supported as symbols. Other symbols or pure numeric input is not allowed. The maximum length is 150 characters.

Alipay (China) Network Technology Co., Ltd

AuthorizationLetterName

string

Yes

The name of the authorization letter. The name cannot be the same as any of your other authorization letters. Only Chinese characters, English letters, or combinations with numbers are supported. Symbols or pure numeric input is not allowed. The maximum length is 100 characters.

Cainiao Company Authorization Letter

Response elements

Element

Type

Description

Example

object

AccessDeniedDetail

string

The details about the access denial. This field is returned only when the RAM permission verification fails.

None

RequestId

string

The request ID generated by Alibaba Cloud for this request. You can use it to troubleshoot issues.

F655A8D5-B967-440B-8683-DAD6FF8DE990

Message

string

The description of the status code.

OK

Data

string

The ID of the authorization letter.

10000****

Code

string

The request status code.

  • OK indicates that the request was successful.

  • For other error codes, see the error code list in this section or API error codes.

OK

Success

boolean

Indicates whether the API call was successful. Valid values:

  • true: The call was successful.

  • false: The call failed.

Valid values:

  • true :

    true

  • false :

    false

true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "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. The signature length is limited to 2-18 characters, and does not support "test", "test" [] [],,. Special characters such as brackets and spaces
400 OrganizationCodeOverLimit The organization code is limited to 150 characters. Social credit code is not allowed to exceed 150 characters

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.