API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (Dysmsapi/2017-05-25) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.
Custom signature
If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).
Before you begin
An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.
Qualification Management
|
API |
Title |
Description |
| SubmitSmsQualification | Request SMS Qualification | According to the real-name requirements for sending text messages set by the Ministry of Industry and Information Technology (MIIT) and carriers, Domestic SMS requires submission of certificate information of the entity to which the signature belongs. Please first request SMS qualification, and then apply for a signature and template. |
| QuerySmsQualificationRecord | Query Qualification List | After you submit a request for SMS qualification, you can use this API to query the list of qualifications and their review details. Filtered queries based on conditions are supported. |
| QuerySingleSmsQualification | Query the details of a single qualification | After you request SMS qualification, you can use this API to query the details of a single qualification. |
| UpdateSmsQualification | Modify Short Message Service Qualification | If you need to update your Short Message Service qualification information, you can submit a modification request through this API. After submission, the request will re-enter the Review Process. |
| DeleteSmsQualification | Delete SMS Qualification | If you no longer use a Short Message Service qualification or need to delete it for other reasons, you can invoke this API or delete the qualification in the Short Message Service console. |
| RequiredPhoneCode | Obtain Phone Verification Code | When requesting SMS qualifications, you must authenticate the administrator's phone number. Use this API to obtain a text message verification code. |
| ValidPhoneCode | Validate Phone Verification Code | When requesting SMS qualifications, you must authenticate the administrator's phone number. This API validates the phone number and the received verification code. |
Letter of Authorization
|
API |
Title |
Description |
| CreateSmsAuthorizationLetter | Create a Letter of Authorization | If the purpose of the requested qualification is for third-party use or the requested SMS signature involves third-party rights, you must obtain third-party authorization and create a Letter of Authorization before submitting your request. |
| QuerySmsAuthorizationLetter | Query Authorization Letters | Query created Letters of Authorization to view their review status and authorized SMS signature scope. |
Signature Management
|
API |
Title |
Description |
| CreateSmsSign | Apply for SMS Signature (New Interface) | An SMS signature identifies the SMS sender. To send an SMS message, you must first apply for a signature and a template. The system then prepends the approved signature to the message content and sends the complete message to the recipient. |
| GetSmsSign | Query Signature Details (New Interface) | Query SMS Signature Details |
| QuerySmsSignList | Query Detail of Sign List | You can use this API to query all signatures under your account, allowing you to view signature details such as the review status, signature type, and signature name. |
| UpdateSmsSign | Update SMS Signature (New Interface) | You can modify rejected or approved signatures. A modified signature is automatically submitted for review, and its status changes to pending review. |
| ChangeSignatureQualification | Replace the Qualification and Letter of Authorization for a Signature (to be unpublished) | Updates the qualification and authorization letter for a signature. |
Trademark and ICP filing
|
API |
Title |
Description |
| CreateSmsTrademark | Create Trademark Entity | Create a trademark entity. This is used when the signature source is set to Trademark, requiring you to upload trademark information. |
| QuerySmsTrademark | Query trademark entity | Queries the details of one or more trademarks. |
| CreateSmsAppIcpRecord | Create an ICP Filing Entity | Create an APP-ICP filing entity. This is used when the signature source is set to APP, requiring the upload of ICP filing information. |
| QuerySmsAppIcpRecord | Query ICP Filing Entity | Queries icp record details. |
Template Management
|
API |
Title |
Description |
| GetSmsTemplate | Query SMS Template Audit Details (New Interface) | Query Text SMS Template Details |
Smart SMS
|
API |
Title |
Description |
| CreateDigitalSignOrder | Digital Message SMS Signature Management | Creates an order to add, update, or delete a digital message signature. |
| QueryDigitalSignByName | Query Digital Message SMS Signature | Retrieves the details of a digital SMS signature by its name. |
| CreateDigitalSmsTemplate | Digital SMS Template Creation | Creates a digital SMS template. |
Card SMS
|
API |
Title |
Description |
| QueryMobilesCardSupport | Query Whether a Phone Number Supports Card SMS (New API) | Query whether a phone number supports Card SMS. |
Obtain OSS Upload Information
|
API |
Title |
Description |
| GetQualificationOssInfo | Obtain OSS Configuration Information for Qualification Materials or Letter of Authorization | Obtain the OSS resource configuration information, which will be used for subsequent operations such as uploading authorization letters, enterprise certificates, and other qualification documents. |
| GetSmsOcrOssInfo | Obtain OCR Image Recognition OSS Information | Obtain OSS information for OCR |
Others
|
API |
Title |
Description |
| AddShortUrl | AddShortUrl | Creates a short URL. |
| AddSmsSign | AddSmsSign | Creates a signature. |
| AddSmsTemplate | AddSmsTemplate | Creates a message template. |
| CheckMobilesCardSupport | CheckMobilesCardSupport | Queries whether some mobile phone numbers support card messages. |
| ConversionDataIntl | ConversionDataIntl | Sends conversion rate information to Alibaba Cloud SMS. |
| CreateCardSmsTemplate | CreateCardSmsTemplate | Creates a card SMS template. |
| CreateSmsTemplate | Apply for SMS Template (New Interface) | A message template defines the content of an SMS message. This content includes the message text and any variables. You can create templates for various business needs, such as sending verification codes, notifications, or promotional messages. A template must be approved before you can use it to send messages. |
| DeleteShortUrl | DeleteShortUrl | Deletes a short URL. After deletion, the short URL is no longer usable and cannot be resolved to the source URL. |
| DeleteSmsSign | DeleteSmsSign | Deletes a signature. |
| DeleteSmsTemplate | DeleteSmsTemplate | Deletes a message template. |
| GetCardSmsDetails | Query the card SMS sending records and status for a single phone number. | Query card sending details |
| GetCardSmsLink | GetCardSmsLink | Queries the short URLs of a card messages template. |
| GetMediaResourceId | GetMediaResourceId | Converts a resource uploaded to the specified Object Storage Service (OSS) bucket for unified management. Then, a resource ID is returned. You can manage the resource based on the ID. |
| GetOSSInfoForCardTemplate | GetOSSInfoForCardTemplate | Queries the OSS configuration information about card messages. |
| GetOSSInfoForUploadFile | Text SMS Obtain OSS Upload Information | SMS File Upload, Get Authorization Info |
| ListTagResources | ListTagResources | Queries the tags of a message template. |
| ModifySmsSign | ModifySmsSign | Modifies a rejected signature and submit it for approval. Signatures that are pending approval or have been approved cannot be modified. |
| ModifySmsTemplate | ModifySmsTemplate | Modifies the information of an unapproved message template and submits it for review again. |
| QueryCardSmsTemplate | QueryCardSmsTemplate | Queries the review status of a message template. |
| QueryCardSmsTemplateReport | QueryCardSmsTemplateReport | Queries sent card messages. |
| QuerySendDetails | QuerySendDetails | Queries the delivery records and status of SMS messages sent to a single phone number. |
| QuerySendStatistics | QuerySendStatistics | Queries message delivery statistics, including send dates, the number of successfully sent messages, and the number of received delivery receipts. |
| QueryShortUrl | QueryShortUrl | Checks the status and availability of a short link. |
| QuerySmsSign | QuerySmsSign | Queries the review status of an SMS signature. |
| QuerySmsTemplate | QuerySmsTemplate | This API has been deprecated. |
| QuerySmsTemplateList | QuerySmsTemplateList | Queries message templates. |
| SendBatchCardSms | SendBatchCardSms | Sends multiple card messages at a time. |
| SendBatchSms | SendBatchSms | Call this operation to send messages to multiple phone numbers, using a single SMS template with a unique SMS signature and set of template variables for each recipient. |
| SendCardSms | SendCardSms | Sends a card message. |
| SendSms | SendSms | Sends an SMS message to one or more specified mobile numbers. |
| SmsConversionIntl | SmsConversionIntl | Reports the status of an OTP message to Alibaba Cloud SMS. |
| TagResources | TagResources | Attaches tags to a message template. |
| UntagResources | UntagResources | Deletes tags from a message template. |
| UpdateSmsTemplate | Update SMS Template (New Interface) | This API modifies a template that failed review and automatically resubmits it. |
该文章对您有帮助吗？