All Products
Search

This Product

    Chat App Message Service:API overview

    Document Center

    Chat App Message Service:API overview

    Last Updated:Feb 02, 2026

    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. 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.

    IM Audience Group Management

    API

    Title

    Description
    AddChatGroup AddChatGroup Creates an Instant Messaging (IM) group.
    AddChatGroupInviteLink AddChatGroupInviteLink Adds an invite link for an Instant Messaging (IM) group.
    DeleteChatGroupInviteLink DeleteChatGroupInviteLink Deletes an IM group invitation link.
    DeleteChatGroupParticipants DeleteChatGroupParticipants Deletes members from an Instant Messaging (IM) group.
    ListChatGroup ListChatGroup Retrieves a list of Instant Messaging (IM) groups.
    UpdateChatGroup UpdateChatGroup Updates the information for an IM chat group.
    DeleteChatGroup DeleteChatGroup Deletes an Instant Messaging (IM) group.

    Messenger marketing messages

    API

    Title

    Description
    SyncMessageCampaign SyncMessageCampaign Synchronously queries the budget.
    ListMessengerSubscriptionToken ListMessengerSubscriptionToken Queries a list of custom audiences and subscription tokens.
    ListMessageCampaign ListMessageCampaign Retrieves a list of budgets.
    ListCustomAudience ListCustomAudience Queries a list of custom audiences.
    ListChatGroupParticipants ListChatGroupParticipants Retrieves the list of members in an Instant Messaging (IM) group.
    GetMessageCampaignInsights GetMessageCampaignInsights You can query budget metrics.
    DeleteMessageCampaign DeleteMessageCampaign Delete the budget for a marketing campaign that sends Messenger messages.
    CreateMessageCampaign CreateMessageCampaign Create a budget.
    CreateCustomAudience CreateCustomAudience Creates a custom audience.
    AddCustomAudienceUser AddCustomAudienceUser Adds users to a custom audience.

    Whatsapp Flow

    API

    Title

    Description
    CreateFlow CreateFlow Creates a flow.
    ListFlow ListFlow Retrieves a list of flows.
    GetFlow GetFlow Retrieves the details of a flow.
    ModifyFlow ModifyFlow Modifies the basic information of a flow.
    UpdateFlowJSONAsset UpdateFlowJSONAsset Updates the content of a flow with JSON.
    GetFlowJSONAssest GetFlowJSONAssest Retrieves the content of a flow in JSON format.
    GetFlowPreviewUrl GetFlowPreviewUrl Retrieves a preview URL for a flow.
    PublishFlow PublishFlow Publishes 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.

    Embedded Signup Related APIs

    API

    Title

    Description
    IsvGetAppId IsvGetAppId Gets the App ID for an Independent Software Vendor (ISV).
    ChatappBindWaba ChatappBindWaba Binds a WhatsApp Business Account (WABA).
    GetPermissionByCode GetPermissionByCode Gets permissions using the code obtained from the embeded signup flow.
    ChatappSyncPhoneNumber ChatappSyncPhoneNumber Synchronizes phone numbers.
    AddChatappPhoneNumber AddChatappPhoneNumber Adds a phone number to a WhatsApp Business Account (WABA).
    GetPhoneNumberVerificationStatus GetPhoneNumberVerificationStatus Retrieves the verification status of a phone number.
    GetChatappVerifyCode GetChatappVerifyCode Requests a verification code to be sent to the specified phone number.
    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).
    QueryPhoneBusinessProfile QueryPhoneBusinessProfile Queries the business information of a phone number.
    CreateChatappMigrationInitiate CreateChatappMigrationInitiate Initiates the migration of a phone number.
    GetMigrationVerifyCode GetMigrationVerifyCode Gets the verification code for phone number migration.
    ChatappMigrationVerified ChatappMigrationVerified Verifies a phone number for migration.
    UpdateCommerceSetting UpdateCommerceSetting Updates the commerce settings for a phone number.

    Phone Management

    API

    Title

    Description
    GetPhoneEncryptionPublicKey Obtain the encrypted public key of the number Retrieves the 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 Retrieves 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 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.
    ChatappEmbedSignUp ChatappEmbedSignUp This embedded API is not required if you use v2 of the embedded software development kit (SDK).

    Others

    API

    Title

    Description
    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.
    SyncMessengerSubscriptionToken SyncMessengerSubscriptionToken Queries the subscription token for Messenger.
    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~~).
    WhatsappCall WhatsappCall Place, answer, and end WhatsApp voice calls.