Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Conversation ID.

queuedMessageId
string
required

The queued message to remove.

Body

application/json

Remove queued message request.

Response

OK

WidgetQueuedMessage is a visitor message sent while the agent was responding. The agent picks queued messages up in order before its next reply; until then a queued message can be removed and the agent never sees it. Once sent, it arrives on the event stream as a userMessage event.

id
string
required
read-only
Example:

"objqa_01HXKD2E5NQM3T9AYWCFQAZGFV"

conversationId
string
required
read-only

The conversation the message was sent to.

Example:

"obj_01HXKD2E5NQM3T9AYWCFQAZGFV"

content
string
required
read-only

The message text.

state
enum<string>
required
read-only
Available options:
STATE_UNSPECIFIED,
STATE_QUEUED,
STATE_SENT,
STATE_REMOVED,
STATE_DISCARDED
createdAt
string<date-time>
required
read-only
sentAt
string<date-time>
read-only

When the agent picked the message up. Unset until the message is sent.

eventId
string
read-only

The userMessage event the message became once sent.