API standard and pre-built SDKs in multi-language
The OpenAPI specification of this product (cams/2020-06-06) 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. Create a Resource Access Management (RAM) user with API-only access and use RAM policies to apply the principle of least privilege (PoLP). Alibaba Cloud accounts are only used when explicitly required.
To call APIs securely, configure the following:
A RAM user account
An AccessKey pair for the account
Messenger marketing messages
|
API |
Title |
Description |
| SyncMessengerSubscriptionToken | SyncMessengerSubscriptionToken | Queries the subscription token for Messenger. |
| SyncMessageCampaign | SyncMessageCampaign | Synchronously queries the budget of a message campaign. |
| ListMessengerSubscriptionToken | ListMessengerSubscriptionToken | Lists custom audiences and subscription tokens. |
| ListMessageCampaign | ListMessageCampaign | Queries the list of message campaign budgets. |
| ListCustomAudience | ListCustomAudience | Queries a list of custom audiences. |
| ListChatGroupParticipants | ListChatGroupParticipants | Lists the members of an Instant Messaging (IM) group. |
| GetMessageCampaignInsights | GetMessageCampaignInsights | Querying budget metrics |
| DeleteMessageCampaign | DeleteMessageCampaign | Deletes the budget of a marketing campaign for sending Messenger messages. |
| AddCustomAudienceUser | AddCustomAudienceUser | Adds users to a custom audience. |
Whatsapp Flow
|
API |
Title |
Description |
| PublishFlow | PublishFlow | Publishes a flow. |
| UpdateFlowJSONAsset | UpdateFlowJSONAsset | Updates the content of a flow with JSON. |
| ModifyFlow | ModifyFlow | Modifies the basic information of a flow. |
| ListFlow | ListFlow | Retrieves a list of flows. |
| GetFlowPreviewUrl | GetFlowPreviewUrl | Retrieves a preview URL for a flow. |
| GetFlowJSONAssest | GetFlowJSONAssest | Retrieves the content of a flow in JSON format. |
| GetFlow | GetFlow | Retrieves the details of a flow. |
| DeprecateFlow | DeprecateFlow | Deprecates a flow. |
| DeleteFlow | DeleteFlow | Deletes a flow. A flow can be deleted only when it is in the draft state. |
| CreateFlow | CreateFlow | Creates a flow. |
Phone Management
|
API |
Title |
Description |
| GetPhoneEncryptionPublicKey | Obtain the encrypted public key of the number | Retrieves the encryption public key for a phone number. |
| UpdatePhoneEncryptionPublicKey | Update the encrypted public key of the number | Updates the encryption key for a phone number. |
| UpdatePhoneMessageQrdl | Modify message QR code | Updates a message QR code. |
| ListPhoneMessageQrdl | Query message QR code list | Queries message QR codes. |
| DeletePhoneMessageQrdl | Delete message QR code | Deletes a message QR code. |
| CreatePhoneMessageQrdl | Create message QR code | Creates a message QR code. |
| QueryChatappPhoneNumbers | QueryChatappPhoneNumbers | Queries all phone numbers used for sending messages and their statuses for a customer. |
| QueryChatappBindWaba | QueryChatappBindWaba | Query the WhatsApp Business account you associate with ChatApp. |
Message Sending
|
API |
Title |
Description |
| SendChatappMassMessage | SendChatappMassMessage | Sends messages in bulk. |
| SendChatappMessage | SendChatappMessage | Sends a message. |
Template Management
|
API |
Title |
Description |
| CreateChatappTemplate | CreateChatappTemplate | Creates a message template. After the template is approved, you can use it to send messages. |
| ListChatappTemplate | ListChatappTemplate | Queries message templates. |
| DeleteChatappTemplate | DeleteChatappTemplate | Deletes a message template. |
Product Catalog
|
API |
Title |
Description |
| ListProduct | ListProduct | Queries a list of products in a catalog. |
Statistical Metric
|
API |
Title |
Description |
| GetChatappPhoneNumberMetric | GetChatappPhoneNumberMetric | Queries the message sending metrics for a phone number in a WhatsApp channel. |
| EnableWhatsappROIMetric | EnableWhatsappROIMetric | Enables statistics for WhatsApp metrics. |
| GetChatappTemplateMetric | GetChatappTemplateMetric | Queries the metrics for a marketing template. |
Other
|
API |
Title |
Description |
| GetPreValidatePhoneId | GetPreValidatePhoneId | Obtains the ID for a pre-registered phone number. Use this ID to select the number in an embedded scenario without obtaining a new verification code. |
| ChatappEmbedSignUp | ChatappEmbedSignUp | This embedded API is not required if you use v2 of the embedded software development kit (SDK). |
Others
|
API |
Title |
Description |
| AddChatGroup | AddChatGroup | Creates an IM group. |
| BeeBotAssociate | BeeBotAssociate | Associates FAQs in the knowledge base. |
| BeeBotChat | BeeBotChat | Conducts sessions with the bot based on its unique identifier (ID). |
| ChatappMigrationRegister | ChatappMigrationRegister | Registers a phone number for migration. |
| GetChatappTemplateDetail | GetChatappTemplateDetail | Queries the information of a message template. |
| GetChatappUploadAuthorization | GetChatappUploadAuthorization | Obtains the authentication information that is used to upload a file. |
| GetCommerceSetting | GetCommerceSetting | Queries the business settings of a phone number. |
| GetConversationalAutomation | Get number welcome messages, opening remarks, and commands | Configures welcoming messages, opening remarks, and commands. |
| GetWhatsappConnectionCatalog | GetWhatsappConnectionCatalog | Queries the product catalogs that are associated with a WhatsApp Business account (WABA). |
| GetWhatsappHealthStatus | Get Whatsapp message send health status | Queries the messaging health status of different types of nodes. |
| ListProductCatalog | ListProductCatalog | Queries the product catalogs on the Business Manager platform of Meta. |
| ModifyChatappTemplate | ModifyChatappTemplate | The code of the message template. |
| ModifyPhoneBusinessProfile | ModifyPhoneBusinessProfile | The ID of the request. |
| QueryWabaBusinessInfo | QueryWabaBusinessInfo | Queries the business information about the WhatsApp Business account (WABA). |
| SubmitIsvCustomerTerms | SubmitIsvCustomerTerms | Submits the agreement information for independent software vendor (ISV) customers. |
| TriggerChatFlow | Trigger an Online Flow | Trigger an Online ChatFlow |
| UpdateAccountWebhook | UpdateAccountWebhook | Modifies the callback URL of an account. |
| UpdateConversationalAutomation | Change the number welcome message, opening remarks, and commands | Modifies welcoming messages, opening remarks, and commands for a phone number. |
| UpdatePhoneWebhook | UpdatePhoneWebhook | The HTTP status code returned. \* A value of OK indicates that the call is successful. \* Other values indicate that the call fails. For more information, see \[Error codes]\(~~196974~~). |