Send messages to Wecom customers

POST

/channel/{publicId}/broadcast-subscriber

This API is used to Send messages to Wecom Customers by using channel 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.peacom.co/eip/partner/channel/3cb69db1-c410-4b83-8d37-84b823be9c06/broadcast-subscriber' \
--header 'apiKey: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "clientMessageId": "3cb69db1-c410-4b83-8d37-84b823be9c06",
    "subscribers": [
        "wrpPFDDQAAQSk"
    ],
    "message": {
        "allowSelect": true,
        "text": "Hello World",
        "attachments": [
            {
                "type": "image",
                "imageUrl": "https://images.pexels.com/photo.jpeg"
            }
        ]
    }
}'

Response Example

200 - Example 1

{
    "clientMessageId": "3cb69db1-c410-4b83-8d37-84b823be9c06",
    "status": 2
}

Modified at 2026-01-06 07:11:41

Sync Wecom agent's customers

Send messages to Wecom Customer Group