Powered by Redocly

Messenger channel messages

Messages exchanged in a channel. Channels are used to communicate with customers or between providers during a ticket.

Retrieve messages [BETA]

Retrieve a list of ticket channel messages. The next token is used to paginate the results. Channels are used to communicate with customers or between providers.

BETA

SecurityOAuth2
Request
query Parameters
channel_id
required
string <uuid>

The identifier of the channel you want to retrieve messages for. A tickets/outsources resource always contains the reference to the channel with the operator of the partnered provided you outsourced to. The tickets/tickets resource contains the reference to the channel with the customer. It can also contain a channel with an operator of the provider that outsourced the ticket to you.

next_token
string

The token to retrieve the next page of results.

Responses
200

Successful response.

Response Schema: application/json
query
object >= 0 properties

Applied query parameters, including defaults.

Array of objects (ChannelMessage) >= 0 items

List of channel messages.

Array (>= 0 items)
id
string <uuid>

Unique identifier of the message.

object or null

Describes attachment for chat message or null when message is not for an attachment.

content
string

The text content of the message.

created_at
string <date-time>

The date-time the message was created.

redacted
boolean

Indicates whether the message content has been redacted.

object

Information about the sender of the message.

type
string

Describes if a channel message contains text or an attachment.

Enum Value Description
text

message is of type text.

attachment

message is of type attachment.

default

An error occurred - see status code and problem response for more information.

get/v2/tickets/messenger-channel/messages
Response samples
application/json
{
  • "query": { },
  • "result": [
    ]
}
➔ Next to Prepared tickets