Sign in

v1

latestOpenAPI 3.0.02026-08-062420.2 KB

Returns a list of messages.

get/v1/message_export

Query parameters

created_afterstring date

Filter for conversations created after this date. Format should be yyyy-mm-dd or Unix timestamp in ms

created_beforestring date

Filter for conversations created before this date. Format should be yyyy-mm-dd or Unix timestamp in ms

Response

Array of messages

idstring uuid

Id of the message

csidinteger

Id of the conversation the message belongs to

created_atinteger

Timestamp of when the message was created

initial_channelstring

The channel through which the communication was established

author_namestring

Name of the author of the message

author_emailstring

Email of the author of the message

direction'inbound' | 'outbound'

Direction of the conversation

textstring

The full message text. Not relevant for PSTN phone and voicemail channels

from_phone_numberstring

Phone number the conversation was initiated from. Relevant only for PTSN phone and voicemail channels

to_phone_numberstring

Phone number the conversation was aimed for. Relevant only for PTSN phone and voicemail channels

durationnumber

Length of the call/voicemail. Relevant only for PTSN phone and voicemail channels

recording_urlstring

Link to the recording of the call. Relevant only for PTSN phone channel

voicemail_urlstring

Link to the voicemail. Relevant only for voicemail channel

tostring[]

Email address(es) a conversation was aimed for. Relevant only for email and contact form channels

fromstring

Email address a conversation was initiated from. Relevant only for email and contact form channels

ccstring[]

Email address(es) included in the email as CC. Relevant only for email channel

bccstring[]

Email address(es) included in the email as BCC. Relevant only for email channel

attached_filesstring[]

Link(s) to files that have been attached to the message. Relevant only for email and Facebook Messenger channel

is_automated_messageboolean

Whether a message has been generated automatically or by an agent. Relevant only for widget chat

chat_input_questionstring

Input question initiating the conversation. Relevant only for widget chat

chat_input_answerstring

Input answer initiating the conversation. Relevant only for widget chat

chat_menu_textstring

Menu text initiating the conversation. Relevant only for widget chat

form_submissionobject

Form submission associated with the message. Relevant only for Messenger and ContactForm channels

Example response

[
  {
    "initial_channel": "widgetchat",
    "chat_input_question": "How can we help?",
    "chat_input_answer": "None of the above",
    "chat_menu_text": "Please input your order number.",
    "form_submission": {
      "name": "John Doe",
      "email": "johndoe@gmail.com",
      "phone": "+4512345678"
    }
  }
]