curl --request POST \
  --url https://api.periskope.app/v1/message/broadcast \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-phone: <x-phone>' \
  --data '{
  "message": "Hello, World!",
  "chat_ids": "12042354354XXX@g.us, 905301234567-1574073754@g.us, 9190043XXXXX@g.us"
}'
{
  "broadcast_id": "cedsnfhf-rewjin-0rt4vm-3r3jf9i"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your apiKey generated in Periskope API settings.

Headers

x-phone
string
required

Organisation phone number(with country code) and without any spaces or special characters.

e.g. 9190043XXXXX

Body

application/json
label
string

You can send a broadcast to all the chats that have a specific label.

Provide a single label ID that belongs to all the chats to which the message needs to be sent.

e.g. label-jamslkwaxzbsdvqt

You can find the chat label IDs using the List all org labels (Chat) API.

You must provide either a label or chat_ids. If both are provided, the label will be ignored.

chat_ids
string

Comma separated chat IDs to which the message needs to be sent.

for e.g. 12058946XXX@g.us, 9198765XXXXX@c.us

message
any
media
object

Response

200 - application/json

The response is of type object.

Was this page helpful?

Send a messageGet message