Broadcast Message

POST

/channel/broadcast

This API is used to Send message to a user with a template by the template publicId.

Request

Authorization

API Key

Add parameter in header

apiKey

Example:

apiKey: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successfully operation

Body

🟠400

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/channel/broadcast' \
--header 'apiKey: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "templateId": "af9461f7-fb50-494d-abb8-e2aee79cd5da",
    "sender": "aab71fc6-ef31-4673-b4f9-6fc7d330ab47",
    "clientMessageId": "bf9461f7-fb50-494d-abb8-e2aee79cd6ab",
    "channel": 8,
    "messages": [
        {
            "phone": "849xxxxx",
            "params": {
                "param1": "Khoa",
                "param2": "236"
            }
        }
    ]
}'

Response Example

200 - Example 1

{
    "clientMessageId": "3cb69db1-c410-4b83-8d37-84b823be9c06",
    "messages": [
        {
            "createdDate": "2019-08-24T14:15:22.123Z",
            "status": 2,
            "publicId": "3cb69db1-c410-4b83-8d37-84b823be9c06"
        }
    ]
}

Modified at 2026-03-11 04:25:53

Webhook payload

Message