GET /subscriber/chat-messages

Scope required: (Manage Flow)

Get list of subscriber chat messages.
type: in -> Incoming message from bot user, out -> Ougoing message from bot, agent -> Outgoing message from human agent, note -> Private note, system -> system messages

Servers

Query parameters

Name Type Required Description
limit Integer No

Number of items in the response, between 1 and 100

user_ns String No

Subscriber user_ns, required if no user_id in the query

start_time Integer No

unix timestamp between one month ago and now, e.g. 1786123679.

include_note Integer No

set value 1 to include agent note messages, default is 0

include_system Integer No

set value 1 to include system messages, default is 0

msg_type String No

filter by media type, available types: image, audio, video, file

user_id String No

Subscriber user_id, required if no user_ns in the query

include_bot Integer No

set value 1 to include bot messages, default is 0

end_time Integer No

unix timestamp between one month ago and now, e.g. 1786123679.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.