v1

latestOpenAPI 3.1.02026-07-24318141.2 MB

Send a Custom Chat Message

Send a custom message to a chat room. This can be used to send rich data as a chat message that can be interpreted by the SDK to perform some action or display additional content.

post/{chat_room_id}/custom-messages/

Path parameters

chat_room_idstring required

Chat Room ID

Request body

custom_datastring required

String data to send with the chat message. Typically contains a string JSON payload to be decoded by the client SDK

program_date_timestring date

ISO-8601 Program Date Time to associate with the chat message.

Response

201

idstring

chat_room_idstring

sender_idstring

sender_nicknamestring

{"stackTrail":"paths:/{chat_room_id}/custom-messages/:post:responses:201:content:application/json:schema:properties:sender_image_url","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/{chat_room_id}/custom-messages/:post:responses:201:content:application/json:schema:properties:badge_image_url","oasType":"schema","type":"unknown"}

sender_profile_urlstring

created_atstring

custom_datastring

{"stackTrail":"paths:/{chat_room_id}/custom-messages/:post:responses:201:content:application/json:schema:properties:program_date_time","oasType":"schema","type":"unknown"}

Example response

{
  "id": "9709cc92-83b3-4e32-b2d0-9029b2f2a0d8",
  "chat_room_id": "1b494165-188f-4e16-9766-ac1d1f1ac925",
  "sender_id": "c8d2922f-8324-4a9a-97f6-88851c53d331",
  "sender_nickname": "Gautam Aggarwal",
  "sender_profile_url": "https://cf-blast.livelikecdn.com/api/v1/profiles/c8d2922f-8324-4a9a-97f6-88851c53d331/",
  "created_at": "2021-09-16T12:24:32.423815+00:00",
  "custom_data": "{\"text\": \"This is a custom chat message\"}"
}