Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
In-App Chat

Send Group In-App Chat

Send a group message via In-App Chat.

post/communications/send_inappchat/group

Headers

x-api-keystring required

A valid api key. If you don't have one, please request one through the Web Integration screen.

Request body

send_message_as_type_idinteger required

ObjectType Id

send_message_as_idinteger

send_from user id

send_to_client_idsstring required

groupsend message to this list of clients

chat_namestring

Body text of the message to send.

chat_bodystring required

Body text of the message to send.

Example request

{
  "send_message_as_id": 1234567891234567
}

Response

Sid of the conversation created or updated with the message sent and Sid of the message sent.

conversation_idstring required

id of conversation created

chat_namestring

Body text of the message to send.

chat_bodystring required

Body text of the message to send.

Example response

{
  "send_from": {
    "send_message_as_id": 1234567891234567
  }
}