API overview

Updated at:

API standards and multilingual preset SDKs

The OpenAPI of this product (Dysmsapi/2017-05-25) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.

Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.

Custom signature scenarios

If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.

Account and security preparation

Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.

Qualification management

API

Title

Description

SubmitSmsQualification Apply for SMS qualification Submits an SMS qualification application. As required by the Ministry of Industry and Information Technology (MIIT) and carriers for real-name SMS sending, domestic SMS services require qualification credentials of the signature owner. Apply for an SMS qualification first, and then apply for signatures and templates.
QuerySmsQualificationRecord Query SMS qualification list Queries the list of SMS qualifications and their review details. This operation supports filtered query.
QuerySingleSmsQualification Query the details of a single qualification After you apply for SMS qualifications, you can call this operation to query the details of a single qualification.
UpdateSmsQualification Modify SMS qualification Submits a modification request to update SMS qualification information. After submission, the qualification re-enters the review process.
DeleteSmsQualification Delete an SMS qualification Deletes an SMS qualification that is no longer needed.
RequiredPhoneCode Obtain phone verification code Obtains an SMS verification code for verifying the administrator phone number when applying for SMS qualifications.
ValidPhoneCode Verify phone verification code Verifies the phone number and the verification code received when applying for SMS qualifications, which requires administrator phone number verification.

Power of attorney

API

Title

Description

CreateSmsAuthorizationLetter Create an authorization letter 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.
QuerySmsAuthorizationLetter Query letters of authorization Queries created letters of authorization. You can view the review status and authorized signature scope of the letters.

Signature management

API

Title

Description

CreateSmsSign Apply for an SMS signature (new operation) Applies for an SMS signature. An SMS signature identifies the sender. Before sending messages, you must apply for a signature and a template. The system adds the approved signature to the beginning of the message content and sends it together with the message to the recipient.
GetSmsSign Query signature details (new operation) Queries the review details of a signature after you submit a signature application.
QuerySmsSignList Query signature list details Queries all signatures under your account, allowing you to view signature details, including the signature approval status, signature type, and signature name.
UpdateSmsSign Modify an SMS signature (new operation) Modifies an SMS signature that has failed or passed the review. After the modification, the signature is automatically submitted for review and enters the pending review state via autocommit.
DeleteSmsSign Delete an SMS signature Deletes an SMS signature that is no longer needed.
ChangeSignatureQualification Replace the qualification and authorization letter for a signature (to be deprecated) Replaces the qualification and authorization letter for a signature.
AddSmsSign Apply for an SMS signature (deprecated) This operation is deprecated.
ModifySmsSign Modify an SMS signature (discontinued) This operation is discontinued.
QuerySmsSign QuerySmsSign Queries the review status of an SMS signature.

Trademark and ICP filing

API

Title

Description

CreateSmsTrademark Create a trademark entity Creates a trademark entity. Scenarios: when the signature source is a trademark, trademark information needs to be uploaded.
QuerySmsTrademark Query trademark entities Queries the details of trademark entities.
CreateSmsAppIcpRecord Create an ICP filing entity Signatures sourced from online apps are no longer supported. Creates an APP-ICP filing entity. Scenarios: when the signature source is set to APP, ICP filing information needs to be uploaded.
QuerySmsAppIcpRecord Query ICP filing entities Queries the details of ICP filing records.

Template management

API

Title

Description

CreateSmsTemplate Apply for an SMS template (new operation) An SMS template defines the content that recipients receive, including variables and template body. You can apply for verification code, notification, or promotional SMS templates based on your business needs. SMS messages can be sent only after the template is approved.
GetSmsTemplate Query SMS template review details (new operation) Queries the review details of an SMS template, including the review status, after you submit the template for review.
QuerySmsTemplateList Query template list details Queries all templates under your account to view template details, including template review status, templatetype, and template content.
UpdateSmsTemplate Modify an SMS template (new operation) Modifies an SMS template that failed the review. The modified template is automatically submitted for review after this operation is called.
DeleteSmsTemplate Delete an SMS template Deletes an SMS template that is no longer needed.
AddSmsTemplate Apply for an SMS template (discontinued) This operation has been discontinued.
ModifySmsTemplate Modify SMS template (discontinued) This operation is discontinued.
QuerySmsTemplate QuerySmsTemplate This API has been deprecated.
AddTemplateSignRel Associate signatures with a template Associates signatures with a template. After signatures are associated with a template, the SMS service specifications of the template are applied when the template is used to send messages.
DeleteTemplateSignRel Dissociate signatures from a template Dissociates signatures from a template. After the dissociation, the SMS service specifications associated with the signatures no longer apply when the template is used to send messages.

SMS sending

API

Title

Description

SendSms SendSms Sends an SMS message to one or more specified mobile numbers.
SendBatchSms SendBatchSms This operation sends messages to different phone numbers using a single template, with different signatures and template variables for each recipient.

Send query

API

Title

Description

QuerySendDetails Query SMS sending details Queries the SMS sending records and sending status of a single phone number.
QuerySendStatistics Query SMS sending statistics Queries the statistics on SMS messages sent, including the sending time, the number of successfully sent messages, and the number of receipts received.

Digital SMS

API

Title

Description

CreateDigitalSignOrder Manage digital SMS signatures Manages digital SMS signature operation orders.
QueryDigitalSignByName Query Digital Message SMS Signature Retrieves the details of a digital SMS signature by its name.
CreateDigitalSmsTemplate Create a digital short message template Creates a digital short message template.

Card SMS

API

Title

Description

GetOSSInfoForCardTemplate Retrieve OSS upload information Retrieves the OSS resource configuration information for card messages. This information is used for subsequent OSS file upload operations.
GetMediaResourceId Retrieve media resource ID Converts images and videos uploaded by users to the card message OSS storage into resource data for unified management, and returns resource IDs that users can manage on their own.
CreateCardSmsTemplate Create a card SMS template Creates a card SMS template.
QueryCardSmsTemplate Query card message template status Queries the review status of a card message template and returns review information from mobile phone manufacturers.
CheckMobilesCardSupport Check whether a phone number supports card messages (legacy) Checks whether a phone number supports card messages.
QueryMobilesCardSupport Query whether phone numbers support card SMS (new operation) Queries whether phone numbers support card SMS.
GetCardSmsLink Retrieve card SMS short uRLs Retrieves short URLs for card SMS messages.
GetCardSmsDetails Query card SMS sending records and status for a single phone number Queries the sending records and sending status of card SMS messages for a single phone number.
QueryCardSmsTemplateReport Queries the parsing data of a specified card SMS template Queries the parsing data of a specified card SMS template. The parsing data includes the number of successful SMS parsing receipts, the number of message exposures, and the number of message clicks.
SendCardSms Send a card short message Sends a card short message.
SendBatchCardSms Send card messages in a batch Sends card messages to multiple recipients in a batch.

5G messaging

API

Title

Description

Signature Signature
UpgradeToRCSSignature Upgrade an SMS signature to a 5G message signature Upgrades an approved SMS signature to a 5G message signature.
UpdateRCSSignature Edit a 5G SMS signature Modifies the signature information of an existing 5G message signature.
GetRCSSignature Query 5G message signature details Queries the details of a 5G message signature.
Fixed menu Fixed menu
AddRcsSignMenu Create or edit a 5G message persistent menu Creates or edits a 5G message persistent menu.
QueryRcsSignMenuByVersion Query 5G message persistent menu details by version Queries the details of a 5G message persistent menu by a specified version.
Template Template
CreateRCSTemplate Create a template Creates a 5G messaging template.
QueryRCSTemplate Query template details Queries the details of a 5G message template.
Material Material
CreateRCSAsset Upload a 5G message asset Creates a 5G message asset.
DeleteRCSAsset Delete a 5G message asset Deletes a 5G message asset.
QueryRCSAssetList Query 5G message asset list Queries the details of 5G message assets in batches.
QueryRCSAssetDetail Query 5G message asset details Queries the details of a single 5G message asset.
Message sending Message sending
SendRCS Send initial downlink 5G message Sends an initial downlink 5G message.
SendRCSReply Send 5G message interactive downlink Sends an interactive downlink 5G message to reply to a user's uplink message.
Query terminal compatibility Query terminal compatibility
QueryRCSMobileCapable Batch query 5G messaging compatibility of phone numbers Queries the 5G messaging compatibility of multiple phone numbers in a synchronous batch request.
CreateRCSMobileCapableTask Create a 5G device capability query task Creates an asynchronous task to query the 5G capability of mobile devices.
QueryRCSMobileCapableTaskResult Query 5G capability check task result Queries the task result of a 5G capability check for mobile devices.

Retrieve OSS upload information

API

Title

Description

GetQualificationOssInfo Obtain the OSS configuration information for qualification materials/authorization letters Obtains the OSS resource configuration information for qualification materials. This configuration information will be used for subsequent uploads of qualification files such as authorization letters and enterprise certificates.
GetOSSInfoForUploadFile Retrieve OSS configuration for signature or template materials Retrieves the OSS resource configuration information that is used for subsequent OSS file upload operations.
GetSmsOcrOssInfo Retrieve OCR image recognition OSS information Retrieves the OSS information for OCR.

Conversion rate for domestic-to-international SMS

API

Title

Description

SmsConversionIntl Report conversion feedback for international SMS sent from chinese mainland Reports the delivery status of each message (by MessageId) to the Alibaba Cloud international SMS platform.
ConversionDataIntl Report domestic-to-international conversion rate data Reports SMS conversion rate statistics to the Alibaba Cloud SMS platform.

Short link management

API

Title

Description

AddShortUrl Create a short URL Creates a short URL.
DeleteShortUrl Delete a short URL Deletes a short URL. After deletion, the short URL becomes unusable and cannot be restored to the original URL.
QueryShortUrl Query short URL status Queries the status of a short URL to determine whether the short URL is available.

Tag management

API

Title

Description

ListTagResources Queries the tags of a template Tags are markers that you add to templates. Each tag consists of a key-value pair (Key-Value). You can query the template codes bound to a tag key-value pair, or query all tags bound to a specific template.
TagResources Add template tags Tags can mark resources, allowing enterprises or individuals to categorize templates of the same type for easier search and resource aggregation. Calls this operation to attach tags to SMS templates.
UntagResources Delete Template Tags Tags can mark resources, allowing enterprises or individuals to categorize templates of the same type for easier search and resource aggregation. If a template is no longer applicable to its currently bound tags, you can unbind the tags from the template. You can delete a single tag or delete tags in batches.

Other

API

Title

Description

GetSmsTemplateList Query template list Queries the details of a template list (new operation).
SendTestVerification Send a test SMS message Sends a test verification code SMS message.