Create a new Conversation Message

post

https://api.web1on1.chat/v2/conversation/{conversation_id}/messages

You may create a new message using this action.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

conversation_id

string

required

ID of the Conversation.

Body Params

conversation

string

required

Conversation ID.

text

string

required

Message text or HTML, or the URL of a non-text contentType.

type

string

enum

Defaults to chat

Message type

role

string

enum

Defaults to bot

Role of the message sender in the agent console. Only applies to chat, mention, postback and card messages.

Allowed:

isBackchannel

boolean

Defaults to true

Wether the message is part of the back channel stream aside the main conversation thread.

contentType

string

enum

Defaults to text/plain

Content type. For binary formats, the text property should be to the media URL. Only applies to chat, mention, postback and card messages.

user

string

User ID of the agent that is represented by the message, if applicable (default: user making the API request).

service

string

Service ID of external service that this message gets mirrored with (either as a sender or as a receiver).

touchpoint

string

enum

Defaults to web

Touchpoint/platform source or target at service for this message.

Allowed:

delay

number

Delay in milliseconds to postpone message processing. For chat message with delays of one second or more, a typing indicator is shown.

items

array

An array of list items to present to participants, each item containing one or more actions.

items

actions

array

An array of Action Buttons to present to participants, to serve as a link, reply or postback actions.

actions

results

array

An array of form results objects that were collected from messages with type results.

results

201Created