Broadcast Template Message

POST

/channel/{publicId}/broadcast

This API is used to Send message to user on different Channels (RCS, Viber, Viber Bot, Whatsapp, Zalo and more ...) with a template publicId

Request

Authorization

API Key

Add parameter in header

apiKey

Example:

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

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Successfully operation

Body

🟠400

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.gomessage.id/eip/partner/channel/3cb69db1-c410-4b83-8d37-84b823be9c06/broadcast' \
--header 'apiKey: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "templateId": "3cb69db1-c410-4b83-8d37-84b823be9c06",
    "partnerTemplateId": "zalo-123",
    "clientMessageId": "3cb69db1-c410-4b83-8d37-84b823be9c06",
    "messages": [
        {
            "phone": "84789811922",
            "params": {}
        }
    ]
}'

Response Example

200 - Example 1

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

Modified at 2025-12-24 07:24:13

Get Channel Status

Send Conversation Message