API standards and multilingual preset SDKs
The OpenAPI of this product (cams/2020-06-06) 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.
IM group management
|
API |
Title |
Description |
| AddChatGroup | AddChatGroup | Creates an IM group. |
| AddChatGroupInviteLink | Add an IM group invite link | Adds an invite link for an IM group. |
| DeleteChatGroupInviteLink | Delete an IM group invitation link | Deletes an IM group invitation link. |
| DeleteChatGroupParticipants | DeleteChatGroupParticipants | Removes members from an IM group. |
| ListChatGroupParticipants | Get IM group member list | Retrieves the member list of an IM group. |
| ListChatGroup | List IM groups | Retrieves the list of IM groups. |
| UpdateChatGroup | Modify IM group information | Modifies the information of an IM group. |
| DeleteChatGroup | Delete an IM group | Deletes a successfully created IM group. |
Messenger marketing messages
|
API |
Title |
Description |
| SyncMessengerSubscriptionToken | Sync custom audience token | Queries the Messenger subscription token. |
| SyncMessageCampaign | SyncMessageCampaign | Synchronously queries the budget. |
| ListMessengerSubscriptionToken | ListMessengerSubscriptionToken | Queries custom audiences and subscription tokens. |
| ListMessageCampaign | ListMessageCampaign | Retrieves a list of budgets. |
| ListCustomAudience | ListCustomAudience | Queries a list of custom audiences. |
| GetMessageCampaignInsights | GetMessageCampaignInsights | Retrieves campaign metrics. |
| DeleteMessageCampaign | DeleteMessageCampaign | Deletes the budget for a marketing campaign. |
| CreateMessageCampaign | CreateMessageCampaign | Creates a budget. |
| CreateCustomAudience | CreateCustomAudience | Creates a custom audience. |
| AddCustomAudienceUser | AddCustomAudienceUser | Adds users to a custom audience. |
Instance/Space management
|
API |
Title |
Description |
| ListInstance | Query instance list | Queries a list of instances. |
| QueryInstance | QueryInstance | Gets the details of a specified instance. |
Flow editor
|
API |
Title |
Description |
| TriggerChatFlow | Trigger an Online Flow | Triggers an online chat flow that has a manual trigger. |
Whatsapp Flow
|
API |
Title |
Description |
| CreateFlow | Create a flow | Creates a Flow. |
| ListFlow | Query flow list | Queries the list of Flows. |
| GetFlow | Get flow details | Retrieves the details of a Flow. |
| SyncFlow | Sync a whatsApp flow | Syncs a WhatsApp flow. |
| ModifyFlow | Modify flow basic information | Modifies the basic information of a flow. |
| UpdateFlowJSONAsset | Update flow content by using JSON | Updates the content of a flow by using JSON. |
| GetFlowJSONAssest | Retrieve flow JSON content | Retrieves the JSON-formatted content of a Flow. |
| GetFlowPreviewUrl | Get flow preview URL | Retrieves the preview URL of a Flow. |
| PublishFlow | Publish a flow | Publishes a Flow. |
| DeprecateFlow | Deprecate a flow | Deprecates a Flow. |
| DeleteFlow | Delete a flow | Deletes a Flow (only Flows in DRAFT status can be deleted). |
Embedded integration
|
API |
Title |
Description |
| IsvGetAppId | Retrieve app ID | Retrieves the App ID for an ISV. |
| ChatappBindWaba | Bind WABA | Binds a WhatsApp Business Account (WABA) through the northbound interface. |
| GetPermissionByCode | Obtain authorization permissions by using the embedded code | Obtains authorization permissions by using the code obtained from the embedded integration. |
| ChatappSyncPhoneNumber | Sync phone number information | Synchronizes phone number information. |
| AddChatappPhoneNumber | Add whatsApp phone number | Adds a phone number to a WABA. |
| GetPhoneNumberVerificationStatus | Query phone number verification status | Retrieves the verification status of a phone number. |
| GetChatappVerifyCode | GetChatappVerifyCode | Requests a verification code to be sent to the specified phone number. |
| ChatappVerifyAndRegister | Verify phone number and register | Verifies a verification code and registers through the northbound interface. |
| ChatappPhoneNumberRegister | Register phone number | Registers a phone number through the northbound interface. |
| ChatappPhoneNumberDeregister | Deregister a whatsApp phone number | Deregisters a phone number from WABA. |
| QueryWabaBusinessInfo | QueryWabaBusinessInfo | Queries the business information about the WhatsApp Business account (WABA). |
| UpdatePhoneWebhook | Modify phone number callback URL information | Modifies the callback URL information for a phone number. |
| UpdateAccountWebhook | UpdateAccountWebhook | Modifies the callback URL of an account. |
| QueryPhoneBusinessProfile | Query phone number business information | Queries the business information of a phone number. |
| ModifyPhoneBusinessProfile | Modify phone number commercial information | Modifies the commercial information of a phone number. |
| CreateChatappMigrationInitiate | CreateChatappMigrationInitiate | Initiates the migration of a phone number. |
| GetMigrationVerifyCode | Retrieve verification code for migration phone number | Retrieves the verification code for a migration phone number. |
| ChatappMigrationVerified | Verify phone number for migration | Verifies a phone number for migration. |
| ChatappMigrationRegister | Migrate phone number registration | Migrates a phone number registration. |
| GetChatappUploadAuthorization | GetChatappUploadAuthorization | Obtains the authentication information that is used to upload a file. |
| GetCommerceSetting | GetCommerceSetting | Queries the business settings of a phone number. |
| UpdateCommerceSetting | UpdateCommerceSetting | Updates the commerce settings for a phone number. |
| SyncBusinessAppHistory | Sync business app historical messages | Synchronizes business app historical records. |
Phone number management
|
API |
Title |
Description |
| GetWhatsappHealthStatus | Get Whatsapp message send health status | Queries the messaging health status of different types of nodes. |
| UpdateConversationalAutomation | Modify welcome message, conversation starters, and commands for a phone number | Modifies the welcome message, conversation starters, and commands for a phone number. |
| GetConversationalAutomation | Get number welcome messages, opening remarks, and commands | Queries the conversational automation settings for a phone number. |
| GetPhoneEncryptionPublicKey | Retrieve the encryption public key of a phone number | Retrieves the encryption public key of a phone number. |
| UpdatePhoneEncryptionPublicKey | Update the encryption public key of a phone number | Updates the encryption public key of a phone number. |
| UpdatePhoneMessageQrdl | Modify a message QR code | Modifies a message QR code. |
| ListPhoneMessageQrdl | Query message QR code list | Queries the list of message QR codes. |
| DeletePhoneMessageQrdl | Delete a message QR code | Deletes a message QR code. |
| CreatePhoneMessageQrdl | Create a 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 | Queries the WhatsApp Business Account (WABA) that is bound to a customer account. |
| UpdateWhatsappUserName | Update whatsApp business phone number username | Updates the WhatsApp username for a business phone number. |
| DeleteWhatsappUserName | Delete whatsApp business phone number user name | Deletes the WhatsApp user name for a business phone number. |
| GetWhatsappUserName | Get whatsApp business phone number username | Retrieves the WhatsApp username for a business phone number. |
| GetWhatsappUserNameSuggestions | Retrieve whatsApp suggested user name for a business phone number | Retrieves the suggested user name for a WhatsApp business phone number. |
Message sending
|
API |
Title |
Description |
| SendChatappMassMessage | Send chat app messages in batches | Sends Chat App messages in batches. |
| SendChatappMessage | Send a chatApp message | Sends a Chat App Message Service message. |
| WhatsappCall | WhatsApp voice call | Calls, answers, or hangs up a WhatsApp voice call. The WhatsApp voice call feature is currently in an invite-only phase. To use this feature, contact your account manager or customer service representative to request allowlisting. This feature cannot be used without allowlisting. |
Template management
|
API |
Title |
Description |
| CreateChatappTemplate | Create a chat app template | Creates a message template. After the template is approved, you can use it to send messages. |
| ModifyChatappTemplate | Modify a chat app template | Modifies a message template. Only templates that have not been reviewed or that failed the review can be modified. |
| ListChatappTemplate | Query chat app message template list | Retrieves a list of message templates. |
| GetChatappTemplateDetail | Query chatApp template details | Retrieves the details of a Chat App Message Service message template. |
| DeleteChatappTemplate | DeleteChatappTemplate | Deletes a message template. |
| CheckDirectSendMessageSample | Validate whatsApp direct-send template content | Validates the content of a WhatsApp direct-send template. |
| GetAutoGeneratedTemplate | GetAutoGeneratedTemplate | Retrieves auto-generated templates. |
| ArchiveChatappTemplate | Archive template | Archives a Chat App Message Service template. Currently, only WhatsApp templates support archiving. |
Product catalog
|
API |
Title |
Description |
| ListProductCatalog | List product catalogs | Queries the catalog list of the Meta Business platform. |
| GetWhatsappConnectionCatalog | GetWhatsappConnectionCatalog | Queries the product catalogs that are associated with a WhatsApp Business account (WABA). |
| ListProduct | ListProduct | Retrieves products in a catalog. |
Statistical metrics
|
API |
Title |
Description |
| GetChatappPhoneNumberMetric | Query phone number sending volume metrics | Queries the message sending volume metrics for a WhatsApp channel phone number. |
| EnableWhatsappROIMetric | Enable whatsApp ROI metric collection | Enables WhatsApp-related metric collection. |
| GetChatappTemplateMetric | Retrieve marketing template metrics | Retrieves metrics related to marketing-type templates. |
| RequestWhatsappConversionApi | Request whatsApp conversions API | Sends a request to the WhatsApp Conversions API. |
Others
|
API |
Title |
Description |
| ListChatappMessage | Query message list | Queries the message list. |
| GetPreValidatePhoneId | GetPreValidatePhoneId | Gets the ID for a pre-validated phone number. Use this ID to select the number in the Embedded Signup flow without obtaining a new verification code. |
| CreateChatFlow | Create a flow | Creates a flow. |
| CreateChatFlowByImport | Create and import a flow | Creates and imports a flow. |
| CreateChatFlowLogSetting | Create flow log setting | Creates a flow log setting. |
| CreateFlowVersion | Create flow version | Creates a new flow version by copying an existing flow version. |
| DeleteChatFlow | Delete a flow | Deletes a flow. |
| DeleteFlowVersion | Delete a flow version | Deletes a flow version. |
| FlowBindPhone | Bind a phone number or merchant account ID to a flow | Binds a phone number or merchant account ID to a flow. |
| FlowRebindPhone | Rebind a phone number or merchant account ID to a flow | Rebinds a phone number or merchant account ID to a flow. |
| FlowUnbindPhone | Dissociate a phone number or merchant account ID from a flow | Dissociates a phone number or merchant account ID from a flow. |
| GetChatFlowTemplate | Query flow template details | Queries the details of a flow template. |
| ListBindingRelationsForFlowVersion | Query bound phone numbers or business account iDs | Queries the list of phone numbers or business account IDs bound to a flow based on the flow code. |
| ListChatFlow | List flows | Lists flows. |
| ListChatFlowTemplate | List flow templates | Lists flow templates. |
| ListFlowNodePrototypeV2 | List flow component prototypes | Lists flow component prototypes. |
| ListFlowVersion | List flow versions | Lists flow versions. |
| OfflineFlowVersion | Offline a flow version | Offlines a flow version. |
| OnlineFlowVersion | Publish a flow version | Publishes a flow version. |
| ReadChatFlow | Retrieve flow details | Retrieves the details of a flow. |
| ReadChatFlowLogSetting | View flow log settings | Queries the flow log settings. |
| ReadFlowVersion | Get flow version | Retrieves a flow version. |
| UpdateChatFlow | Update flow basic information | Updates the basic information of a flow based on the flow code. |
| UpdateChatFlowLogSetting | Update flow log settings | Updates the flow log settings. |
| UpdateContactById | Update contact information | Modifies a contact. |
| UpdateFlowVersion | Update flow version DSL data | Updates the DSL data of a flow version, used for updating the flow version on the canvas. |
| GetChatappPhoneNumberSetting | Get chatApp phone number configuration | Retrieves other controls for a ChatApp phone number. |
| BeeBotAssociate | Chatbot association | Retrieves associated FAQs from the knowledge base based on user input. |
| BeeBotChat | Initiate a chatbot conversation | Initiates a conversation with a chatbot by using the unique chatbot identifier (chatbot ID). |
| ChatappEmbedSignUp | Embedded entry | Provides the northbound embedded interface. Use the v2 version when calling the embedded SDK, and ignore this operation. |
| SubmitIsvCustomerTerms | SubmitIsvCustomerTerms | Submits the agreement information for independent software vendor (ISV) customers. |
| AddAddressRecoverSuspend | Change destination, resume, or pause | Submits a request to change the destination, resume, or pause. |
| AddAuditViberOpen | AddAuditViberOpen | Signs up for a Viber account. |
| AddContacts | Add contact | Edits a contact - add contact. |
| AddGroup | Add a group | Adds a group. |
| AddMarketingFlow | Create a campaign | Creates a campaign. |
| BindInstagramPage | Associate a page with an instance | Associates a page with an instance. |
| BindMessengerPage | Bind a messenger page | Binds the selected pageId. |
| CopyTemplate | Copy template | Copies a template. |
| CreateWhatsappConversionApi | Retrieve pageId by embedded code | Retrieves and stores the pageId based on the embedded code. |
| DeleteContactsByIds | Batch delete contacts | Deletes contacts by selecting and removing them. |
| DeleteGroupById | Delete a group | Deletes a group. |
| DeleteInstagramPage | Delete an instagram page | Deletes a page from an Instagram instance. |
| DeleteMarketingFlow | Delete a marketing campaign | Deletes a marketing campaign. |
| DeleteMessengerPage | Delete a messenger public page | Deletes a Messenger page. |
| GeneratePresignedUrl | Retrieve a temporary URL | Retrieves a temporary URL. |
| GetAuditRequestByTypeUnAudit | Viber pending review ticket | Queries pending review tickets for an individual by type. |
| GetChatappOpenStatus | Query chatApp activation status | Queries the activation status of ChatApp. |
| GetCustomerSite | Query customer source site | Queries the source site of a customer. |
| GetDownloadExcelList | Download excel data | Downloads Excel data. |
| GetFbInstagramPages | Instagram public page list | Retrieves the list of Instagram pages for an instance. |
| GetFbMessengerPages | List messenger public pages | Retrieves the list of Facebook page IDs. |
| GetGroupExist | Check whether a group name is duplicate | Queries whether a group name already exists. |
| GetPledgeTemplateAddress | Download URL for letter of guarantee template | Retrieves the download URL for the letter of guarantee template. |
| GetViberByRequestNo | GetViberByRequestNo | Retrieves the application by its requestNo. |
| GetViberPauseTimes | Query the number of available pause requests for viber | Queries the number of times that a pause can be requested. |
| GetWhatsappConversionApi | Get embedded authorization | Retrieves the embedded authorization page. |
| ListAllGroups | Query group list | Queries the list of groups. |
| ListFacebookPosts | List facebook posts | Queries the list of Facebook posts. |
| ListFlowNodeGroup | List flow component groups | Lists flow component groups. |
| ListInstagramPage | List instagram public pages | Retrieves the Instagram pages associated with an instance. |
| ListInstagramPosts | List instagram posts | Queries the list of Instagram posts. |
| ListMarketingFlow | Query marketing campaign list | Queries a list of marketing campaigns. |
| ListViberServiceMessage | Display viber service number information | Displays the Viber service number card for an application form. |
| MoveContactToGroup | Modify contact groups | Modifies the group associations of contacts. |
| OpenChatappService | Activate chat app message service | Activates the Chat App Message Service. |
| PauseMarketingFLow | Pause a campaign | Pauses a service. |
| RemoveContactById | Remove a single contact | Removes a single contact from the current group. |
| UpdateAuditRequest | UpdateAuditRequest | Modifies a Viber application. |
| UpdateGroupName | Modify group name | Renames a group. |
| UpdateMarketingFLow | Modify campaign information | Modifies campaign information. |
| ChangeResourceGroup | Move resource to a resource group | Moves a resource to a different resource group. |
| CreateInstance | CreateInstance | Creates an instance. |
| DeleteContacts | Delete a contact | Deletes a contact from the contact list. |
| DeleteInstance | DeleteInstance | Deletes the specified instance. |
| ListWhatAppTemplate | ListWhatAppTemplate | Lists message templates. |
| UpdateInstance | UpdateInstance | Updates the specified instance. |
| SubmitVerifyCodeResult | SubmitVerifyCodeResult | Submits the result of a verification code check. |
| BindDmAccount | Associate a DM account | Associates a DM account. |
| CreateMessengerPage | Authorize embedded messenger | Authorizes an embedded messenger. |
| GetChatFlowMetric | Retrieve chatFlow runtime data | Retrieves ChatFlow runtime data. |
| ListBindDmAccount | Query bound mailbox account | Queries the bound DM account. |
| ListDmAccount | Query directMail accounts | Queries the DirectMail accounts under your Alibaba Cloud account. |
| ListDmTag | Query directMail tag list | Queries the tags of DirectMail. |
| ListPageAdAccount | Query page ad accounts | Queries the list of ad accounts bound to a page. |
| ModifyChatappTemplateProperties | Modify template properties | Modifies some properties of a template. |
| QueryMMLActive | Query MML status | Queries whether a marketing message is effective. |
| UnbindDmAccount | Unbind a dm account | Unbinds an email account. |
| UpdateWabaMmlStatus | Update MML status after MML embedding is complete | Updates the MML status of a WABA. |