API: Streaming Messaging

Create a new message record

Create a new message record. This endpoint should be used when a Streaming flow is selected or when a messageId/conversationId has to be known in advance.

post/chat/message/create

Request body

channelIdstring uuid required

ID of the channel on which the conversation was or will be initiated.

sourcestring required

The source of the chat conversation to be used for your analytics and debugging purposes.

messagestring text required

Content of the user message.

conversationIdstring uuid

ID of the conversation/thread. If present, will add the newly created message record to the conversation history. Otherwise, will create a new conversation.

senderIdstring

An optional user identifier to be used for your analytics and debugging purposes.

Example request

{
  "source": "WEBSITE",
  "senderId": "email@gmail.com"
}

Response

Response containing details of the newly created message record.

conversationIdstring uuid

ID of the chat conversation/thread.

messageIdstring uuid

ID of the message record that was created.

messageContentstring text

Content of the message that was created.

channelIdstring uuid

ID of the channel on which the conversation was initiated.

createdAtstring date-time

Date time of when the message record was created. UTC Timezone.

Changes

No recorded changes to this endpoint across all 1 revision of this API.