Message

Add a historical message to a conversationDeprecated

SecurityApiKeyAuth or BearerAuth
Request
path Parameters
csid
required
integer
Request Body schema: application/json
required

The message to insert.

Array of objects (AttachmentInput)

A list of attachments.

author_id
string (StringId)
channel
string (Channel)

The channel a conversation can be conducted on.

Enum: "callback" "contact_form" "email" "facebook_messenger" "phone" "voice_mail" "widget_chat"
direction
string (Direction)

The direction a conversation can be

Enum: "inbound" "internal" "outbound"
from_email
string (EmailString)

A regular email.

text
string
to_email
string (EmailString)

A regular email.

Responses
200

The message was createde

post/v1/conversations/{csid}/messages/historical
Request samples
application/json
{
  • "channel": "widget_chat",
  • "direction": "outbound",
  • "from_email": "string",
  • "to_email": "string",
  • "text": "string",
  • "author_id": "string",
  • "attachments": [
    • {
      • "url": "string"
      }
    ]
}
Response samples
application/json
{
  • "data": {
    • "id": "string",
    • "created_at": "2015-11-30T00:00:00:000Z",
    • "author_id": "string",
    • "channel": "widget_chat",
    • "direction": "widget_chat",
    • "attributes": {
      • "text": "string",
      • "to_emails": "string",
      • "cc_email": "string",
      • "from_email": "string",
      • "inline_images": "string",
      • "attachments": "string",
      • "direction": "string",
      • "a_phone_number": "string",
      • "b_phone_number": "string",
      • "is_automated_message": "string",
      • "is_auto_reply": "string"
      }
    }
}

Get a list of messages within a conversationDeprecated

SecurityApiKeyAuth or BearerAuth
Request
path Parameters
csid
required
integer
Responses
200

A list of messages

get/v1/conversations/{csid}/messages
Request samples
Response samples
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "created_at": "2015-11-30T00:00:00:000Z",
      • "author_id": "string",
      • "channel": "callback",
      • "direction": "callback",
      • "attributes": {
        • "text": "string",
        • "to_emails": "string",
        • "cc_email": "string",
        • "from_email": "string",
        • "inline_images": "string",
        • "attachments": "string",
        • "direction": "string",
        • "a_phone_number": "string",
        • "b_phone_number": "string",
        • "is_automated_message": "string",
        • "is_auto_reply": "string"
        }
      }
    ]
}