All Products
Search

This Product

    Chat App Message Service:SendChatappMassMessage

    Document Center

    Chat App Message Service:SendChatappMassMessage

    Last Updated:Sep 29, 2026

    Sends Chat App messages in batches.

    Operation description

    QPS limits

    • The QPS limit for this operation is 10 calls per second per user. If the limit is exceeded, API calls are throttled, which may affect your business. Call this operation at a reasonable rate.

    • A single request supports a maximum of 1,000 phone numbers.

    Status changes

    You can monitor message delivery status changes through MNS or HTTP. For more information, see Receipt messages.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cams:SendChatappMassMessage

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ChannelType

    string

    Yes

    The channel type. Valid values:

    • whatsapp

    • messenger

    • instagram

    • viber

    whatsapp
    TemplateCode

    string

    No

    The template code. You can view the template code on the Channel Management > Manage > Template Design page.

    1119***************
    Language

    string

    Yes

    The language. For a list of language codes, see Language codes.

    en
    From

    string

    Yes

    The sender's phone number.

    • If ChannelType is whatsapp, this is the phone number registered and bound to WhatsApp. You can view it on the Channel Management > Manage > WABA Management > Number Management page.

    • If ChannelType is messenger, this is the Page ID of the public page. You can view it on the Channel Management > Manage > Public Pages page.

    • If ChannelType is instagram, this is the Instagram professional account ID (Account ID). You can view it on the Channel Management > Manage > Professional Accounts page.

    • If ChannelType is viber, this is the Viber service number ID (Service ID). You can view it on the Channel Management > Manage > Service Number Management page.

    861387777****
    CustWabaId deprecated

    string

    No

    The WABA ID of the ISV customer. This parameter is deprecated. Use CustSpaceId instead, which is the instance ID for direct customers. You can view it on the Channel Management page.

    cams-8c8*********

    FallBackId

    string

    No

    The fallback policy ID. This parameter applies to the international site only and can be ignored on the China site. You can view the policy ID on the Fallback Policy page.

    S0****
    FallBackContent

    string

    No

    The custom fallback content. This parameter applies to the international site only and can be ignored on the China site.

    Fallback SMS
    TaskId

    string

    No

    The custom task ID.

    10000****
    SenderList

    array<object>

    No

    The list of recipient phone numbers.

    array<object>

    No

    The recipient phone number.

    TemplateParams

    object

    No

    The collection of template parameters.

    string

    No

    The template parameter. The value is in key-value format, where the key is the parameter name and the value is the parameter value.

    { "param1": "value1", "param2": "value2" }
    FlowAction

    object

    No

    The Flow message object.

    FlowActionData

    object

    No

    The collection of default Flow parameters.

    any

    No

    The default Flow parameter. The value is in key-value format, where the key is the parameter name and the value is the parameter value.

    { "name": "name" }
    FlowToken

    string

    No

    The custom Flow token information.

    kde****
    Payload

    array

    No

    The list of trigger message identifiers for buttons.

    string

    No

    The trigger message for a button.

    payloadtext
    To

    string

    No

    The recipient's phone number.

    • If ChannelType is whatsapp, this is the recipient's phone number.

    • If ChannelType is messenger, this is the Page-Scoped User ID generated when the user interacts with a Facebook page message.

    • If ChannelType is instagram, this is the Instagram User ID generated when the user interacts with an Instagram business account or creator account.

    • If ChannelType is viber, this is the recipient's phone number.

    861386666****

    ProductAction

    object

    No

    The product information. This parameter applies only to the WhatsApp channel type and represents the product information you uploaded to Meta.

    ThumbnailProductRetailerId

    string

    No

    The product catalog ID. You can obtain it by calling the ListProductCatalog operation.

    skkks99****
    Sections

    array<object>

    No

    The list of product categories. A maximum of 10 categories and 30 products are supported.

    array<object>

    No

    The product category.

    Title

    string

    No

    The category name. You can view it on the Channel Management > Manage > Catalog Management > Product Management page, or obtain it by calling the ListProduct operation.

    abcd
    ProductItems

    array<object>

    No

    The list of product information.

    object

    No

    The product information.

    ProductRetailerId

    string

    No

    The product ID. You can view it on the Channel Management > Manage > Catalog Management > Product Management page, or obtain it by calling the ListProduct operation.

    ksi3****
    RecipientType

    string

    No

    The recipient type, such as individual.

    individual
    IsvCode deprecated

    string

    No

    The ISV verification code used to verify whether a sub-account is authorized by an ISV. This parameter is deprecated and can be ignored.

    skdi3kksloslikd****
    CustSpaceId

    string

    No

    The space ID of the ISV sub-customer, or the instance ID for direct customers. You can view it on the Channel Management page.

    cams-8c8*********
    Ttl

    integer

    No

    The timeout period for sending Viber messages. This parameter applies to the international site only and can be ignored on the China site. Unit: seconds. Valid values: 30 to 1209600.

    46
    Label

    string

    No

    The Viber message type. This parameter applies to the international site only and can be ignored on the China site. Valid values:

    • pormotion: marketing and promotional messages.

    • transaction: notification messages.

    promotion
    Tag

    string

    No

    The tag information. Specifies a custom tag for Viber messages.

    Tag

    FallBackDuration

    integer

    No

    The fallback trigger duration. This parameter applies to the international site only and can be ignored on the China site. If no delivery receipt is returned within the specified duration, a fallback is triggered. If this parameter is not set, the fallback is not triggered based on this duration — a fallback occurs only when the message fails to send or a failure status report is received. Unit: seconds. Minimum value: 60. Maximum value: 43200.

    120
    FallBackRule

    string

    No

    The fallback rule. This parameter applies to the international site only and can be ignored on the China site. Valid values:

    • undelivered: triggers a fallback when the message cannot be delivered to the endpoint. During the sending phase, the template and parameters must pass validation. Checks for blocked templates or blocked phone numbers are not performed. If this parameter is left empty, this rule is used by default.

    • sentFailed: triggers a fallback when validation of the template, template variables, or other parameters fails. Only the following parameters are strictly validated: channelType, type, messageType, to, and from (whether they exist).

    undelivered
    TemplateName

    string

    No

    The template name. You can view the template name on the Channel Management > Manage > Template Design page.

    test_name

    Response elements

    Element

    Type

    Description

    Example

    object

    The returned data.

    AccessDeniedDetail

    string

    The details of the access denial.

    None
    RequestId

    string

    The request ID.

    90E63D28-E31D-1EB2-8939-A9486641****
    Message

    string

    The error message.

    User not authorized to operate on the specified resource.
    GroupMessageId

    string

    The batch message ID.

    890000010002****
    Code

    string

    The request status code.

    • A return value of OK indicates that the request was successful.

    • For other error codes, see Error code list.

    OK

    Examples

    Success response

    JSON format

    {
  "AccessDeniedDetail": "None",
  "RequestId": "90E63D28-E31D-1EB2-8939-A9486641****",
  "Message": "User not authorized to operate on the specified resource.",
  "GroupMessageId": "890000010002****",
  "Code": "OK"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 Product.Unsubscript You have not subscribed to the specified product. You have not subscribed to the specified product.
    400 Ram.PermissionDeny You are not authorized to perform the operation.
    400 System.LimitControl The system is under flow control. The system is under flow control.
    400 Unknown.ResourceOwnerId The resource does not belong to the current user. The resource does not belong to the current user.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.