This product(
cams/2020-06-06) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (78410016550) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
| API | Title | Description |
|---|---|---|
| TriggerChatFlow | Trigger an Online Flow | Trigger an Online ChatFlow |
Flow
| API | Title | Description |
|---|---|---|
| PublishFlow | PublishFlow | Publishes a Flow. |
| UpdateFlowJSONAsset | UpdateFlowJSONAsset | Updates a Flow by using JSON content. |
| ModifyFlow | ModifyFlow | Modifies the basic information about a Flow. |
| ListFlow | ListFlow | Queries a list of Flows. |
| GetFlowPreviewUrl | GetFlowPreviewUrl | Obtains the preview URL of a Flow. |
| GetFlowJSONAssest | GetFlowJSONAssest | Queries the JSON content of a Flow. |
| GetFlow | GetFlow | Queries the information about a Flow. |
| DeprecateFlow | DeprecateFlow | Deprecates a Flow. |
| DeleteFlow | DeleteFlow | Deletes a Flow. Only Flows in the DRAFT state can be deleted. |
| CreateFlow | CreateFlow | Creates a Flow. |
Embedded Signup Related APIs
| API | Title | Description |
|---|---|---|
| IsvGetAppId | IsvGetAppId | Obtains the application ID under the ISV account. |
| ChatappBindWaba | ChatappBindWaba | Binds the WhatsApp Business account with ChatApp. |
| GetPermissionByCode | GetPermissionByCode | Obtains permissions based on the authorization code obtained from embedded signup. |
| ChatappSyncPhoneNumber | ChatappSyncPhoneNumber | Synchronizes phone numbers. |
| AddChatappPhoneNumber | AddChatappPhoneNumber | Adds a phone number for a WhatsApp Business account (WABA). |
| GetPhoneNumberVerificationStatus | GetPhoneNumberVerificationStatus | Obtains the verification status of a phone number. |
| GetChatappVerifyCode | GetChatappVerifyCode | Obtains a verification code. |
| ChatappVerifyAndRegister | ChatappVerifyAndRegister | Associates a phone number with a WhatsApp Business account (WABA). |
| ChatappPhoneNumberRegister | ChatappPhoneNumberRegister | Registers a phone number. |
| ChatappPhoneNumberDeregister | ChatappPhoneNumberDeregister | Deregisters a phone number from a WhatsApp Business account (WABA). |
| QueryWabaBusinessInfo | QueryWabaBusinessInfo | Queries the business information about the WhatsApp Business account (WABA). |
| 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~~). |
| UpdateAccountWebhook | UpdateAccountWebhook | Modifies the callback URL of an account. |
| QueryPhoneBusinessProfile | QueryPhoneBusinessProfile | Queries the business information of the account to which a specified phone number is bound. |
| ModifyPhoneBusinessProfile | ModifyPhoneBusinessProfile | The ID of the request. |
| CreateChatappMigrationInitiate | CreateChatappMigrationInitiate | The ID of the number. |
| GetMigrationVerifyCode | GetMigrationVerifyCode | Obtain the verification code for the migration number. |
| ChatappMigrationVerified | ChatappMigrationVerified | Verifies a specified phone number for migration. |
| ChatappMigrationRegister | ChatappMigrationRegister | Registers a phone number for migration. |
| GetChatappUploadAuthorization | GetChatappUploadAuthorization | Obtains the authentication information that is used to upload a file. |
| SubmitIsvCustomerTerms | SubmitIsvCustomerTerms | Submits the agreement information for independent software vendor (ISV) customers. |
| GetCommerceSetting | GetCommerceSetting | Queries the business settings of a phone number. |
| UpdateCommerceSetting | UpdateCommerceSetting | Modifies the business settings of a phone number. |
| ChatappEmbedSignUp | ChatappEmbedSignUp | Queries WhatsApp Business account (WABA) information after embedded signup. You do not need to call this API operation if you use Version 2 of WhatsApp embedded signup. |
Phone Management
| API | Title | Description |
|---|---|---|
| GetWhatsappHealthStatus | Get Whatsapp message send health status | Queries the messaging health status of different types of nodes. |
| UpdateConversationalAutomation | Change the number welcome message, opening remarks, and commands | Modifies welcoming messages, opening remarks, and commands for a phone number. |
| GetConversationalAutomation | Get number welcome messages, opening remarks, and commands | Configures welcoming messages, opening remarks, and commands. |
| GetPhoneEncryptionPublicKey | Obtain the encrypted public key of the number | Queries the encryption public key of a phone number. |
| UpdatePhoneEncryptionPublicKey | Update the encrypted public key of the number | Updates the encryption public key of a phone number. |
| UpdatePhoneMessageQrdl | Modify message QR code | Modifies a quick-response (QR) code that contains a message. |
| ListPhoneMessageQrdl | Query message QR code list | Queries the information about a list of quick-response (QR) codes that contain messages. |
| DeletePhoneMessageQrdl | Delete message QR code | Deletes a quick-response (QR) code that contains a message. |
| CreatePhoneMessageQrdl | Create message QR code | Creates a quick-response (QR) code that contains a message. |
| QueryChatappPhoneNumbers | Query all sending numbers and their status under the customer's account | Queries phone numbers that receive messages and statuses of these numbers under a specified user. |
| QueryChatappBindWaba | Query the Waba bound to the customer | Query the WhatsApp Business account you associate with ChatApp. |
Message Sending
| API | Title | Description |
|---|---|---|
| SendChatappMassMessage | SendChatappMassMessage | Sends a message to multiple phone numbers by using ChatAPP at a time. |
| SendChatappMessage | SendChatappMessage | Sends messages by using ChatAPP. |
Template Management
| API | Title | Description |
|---|---|---|
| CreateChatappTemplate | CreateChatappTemplate | The HTTP status code. \\\\* Example: OK. This parameter indicates that the request is successful. \\\\* Other values indicate that the request fails. For more information, see \\\\[Error codes]\\\(https://www.alibabacloud.com/help/zh/cams/latest/api-error-codes). |
| ModifyChatappTemplate | ModifyChatappTemplate | The code of the message template. |
| ListChatappTemplate | ListChatappTemplate | Queries message templates. |
| GetChatappTemplateDetail | GetChatappTemplateDetail | Queries the information of a message template. |
| DeleteChatappTemplate | DeleteChatappTemplate | Deletes a message template. |
BeeBot
| API | Title | Description |
|---|---|---|
| BeeBotChat | BeeBotChat | Conducts sessions with the bot based on its unique identifier (ID). |
| BeeBotAssociate | BeeBotAssociate | Associates FAQs in the knowledge base. |
Product Catalog
| API | Title | Description |
|---|---|---|
| ListProductCatalog | ListProductCatalog | Queries the product catalogs on the Business Manager platform of Meta. |
| GetWhatsappConnectionCatalog | GetWhatsappConnectionCatalog | Queries the product catalogs that are associated with a WhatsApp Business account (WABA). |
| ListProduct | ListProduct | Queries products in a product catalog. |
Statistical Metric
| API | Title | Description |
|---|---|---|
| GetChatappPhoneNumberMetric | GetChatappPhoneNumberMetric | Queries the number of messages that are sent by using a phone number by a specific metric. |
| EnableWhatsappROIMetric | EnableWhatsappROIMetric | Enables the statistics on the metrics that are related to WhatsApp. |
| GetChatappTemplateMetric | GetChatappTemplateMetric | Queries the metrics about a marketing template. |