Skip to main content

Overview

Broadcasts a message to all users registered under the application.

Request

Authentication Add authentication headers to the request. See Authentication

Method POST

Rate limit 100 requests/second

Endpoint https://API domain/apigateway/messages/broadcast/send

Content-Type application/json

Request Parameters

ParameterData TypeRequiredDescription
sender_idstringYesSender ID. Maximum length: 32 characters.
msg_typestringYesMessage type identifier. Maximum length: 50 characters.
msg_contentstringYesMessage content as a JSON string.

Request Example

POST /apigateway/messages/broadcast/send HTTP/1.1
appkey: appkey
signature: 2e639ae3600a4sdff61fb88b76f485b
nonce: nonce
timestamp: 1672568121910
Content-Type: application/json

{
"sender_id":"userid1",
"msg_type":"text",
"msg_content":"{\"content\":\"aabbcc\"}",
}

Response Example

{
"code":0,
"msg":"sucess"
}