Skip to content

Integrations API [deprecated] (1.0.0)

Welcome to the Dixa integrations API. Remember to set your credentials using the 'Authorize' button. Note that this API is deprecated and equivalent functionality can be found in Dixa API.

Download OpenAPI description
index.json
index.yaml
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/integrations-api
The Server
https://docs.dixa.io

Users

Operations

Tags

Operations

Queues

Operations

Endpoints

Operations

Conversations

Operations

Message

Operations

Get a list of messages within a conversationDeprecated

Request

Security
ApiKeyAuth or BearerAuth
Path
csidintegerrequired
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/integrations-api/v1/conversations/{csid}/messages' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A list of messages

Bodyapplication/json
dataArray of objects(Message)required
data[].​idstring(StringId)required
data[].​created_atstring(Timestamp)required
Example: "2015-11-30T00:00:00:000Z"
data[].​author_idstring(StringId)required
data[].​channelstring(Channel)required

The channel a conversation can be conducted on.

Enum"widget_chat""phone""voice_mail""email""contact_form""callback""facebook_messenger"
data[].​directionstring

The channel a conversation can be conducted on.

Enum"widget_chat""phone""voice_mail""email""contact_form""callback""facebook_messenger"
data[].​attributesobject
Response
application/json
{
  "data": [
    { … }
  ]
}

Add a historical message to a conversationDeprecated

Request

Security
ApiKeyAuth or BearerAuth
Path
csidintegerrequired
Bodyapplication/jsonrequired

The message to insert.

channelstring(Channel)

The channel a conversation can be conducted on.

Enum"widget_chat""phone""voice_mail""email""contact_form""callback""facebook_messenger"
directionstring(Direction)

The direction a conversation can be

Enum"outbound""inbound""internal"
from_emailstring(EmailString)

A regular email.

to_emailstring(EmailString)

A regular email.

textstring
author_idstring(StringId)
attachmentsArray of objects(AttachmentInput)

A list of attachments.

curl -i -X POST \
  'https://docs.dixa.io/_mock/openapi/integrations-api/v1/conversations/{csid}/messages/historical' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "channel": "widget_chat",
    "direction": "outbound",
    "from_email": "string",
    "to_email": "string",
    "text": "string",
    "author_id": "string",
    "attachments": [
      {
        "url": "string"
      }
    ]
  }'

Responses

The message was createde

Bodyapplication/json
dataobject(Message)required
data.​idstring(StringId)required
data.​created_atstring(Timestamp)required
Example: "2015-11-30T00:00:00:000Z"
data.​author_idstring(StringId)required
data.​channelstring(Channel)required

The channel a conversation can be conducted on.

Enum"widget_chat""phone""voice_mail""email""contact_form""callback""facebook_messenger"
data.​directionstring

The channel a conversation can be conducted on.

Enum"widget_chat""phone""voice_mail""email""contact_form""callback""facebook_messenger"
data.​attributesobject
Response
application/json
{
  "data": {
    "id": "string",
    "created_at": "2015-11-30T00:00:00:000Z",
    "author_id": "string",
    "channel": "widget_chat",
    "direction": "widget_chat",
    "attributes": { … }
  }
}

Wrapup

Operations

Note

Operations

ActivityLog

Operations

flows

Operations