Delete a broadcast message

Delete a broadcast message sent to all users. By default, this API sends a delete command that removes the original message on mobile clients and replaces it with a deletion notification (RC:RcNtf).

Supports deleting messages sent via:

• Broadcast to all users: /v4/system-channel/message/broadcast-all
• Send notification by tag: /v4/system-channel/push
• Send notification by package name: /v4/system-channel/push

tip

The delete command is stored in message history. Mobile SDKs handle the deletion logic internally.

Request

POST: https://[Base URL](/platform-chat-api/base-url)/v4/system-channel/message/broadcast/delete

Rate limit: 2 per hour, 3 per day (calendar day).

Authentication: All server API requests require signature verification. See API request signing.

Request body

Content type: application/json

Parameter	Type	Required	Description
fromUserId	String	Yes	Sender user ID of the original message.
messageUID	String	Yes	Unique message ID of the message to delete. Currently only obtainable from message history logs (field: msgUID).
sentAt	Number	No	Send time of the original message. Obtainable from message history logs (field: dateTime).
isAdmin	Number	No	Whether the deletion is an admin action. Default: 0.
isDelete	Number	No	Default: 0 (replace with a deletion notification). 1: delete without showing a notification.
extra	String	No	Custom extension data.
disableUpdateLastMsg	Boolean	No	Prevent updating the last message in the channel list.

Request example

HTTP

POST /v4/system-channel/message/broadcast/delete HTTP/1.1
Host: api.sg-light-api.com
App-Key: uwd1c0sxdlx2
Nonce: 14314
Timestamp: 1408710653491
Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
    "fromUserId": "fDR2cVpxxR5zSMUNh3yAwh",
    "messageUID": "5FGT-7VA9-G4DD-4V5P",
    "sentAt": 1507778882124
}

Response

Property	Type	Description
code	Number	Status code. 0 indicates success.

Response example

HTTP

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{"code":0}