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

Create a conversationDeprecated

Request

Security
ApiKeyAuth or BearerAuth
Bodyapplication/jsonrequired

The conversation to create. Only callback and contact form conversations are currently supported.

One of:
channelstringrequired

The channel a conversation can be conducted on.

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

The direction a conversation can be

Enum"outbound""inbound""internal"
queue_idstring(StringId)required
requester_idstring(StringId)required
endpoint_idstringrequired
tagsArray of strings

A list of tag names.

curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/integrations-api/v1/conversations \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "channel": "widget_chat",
    "direction": "outbound",
    "queue_id": "string",
    "requester_id": "string",
    "endpoint_id": "string",
    "tags": [
      "string"
    ]
  }'

Responses

The conversation was created

Bodyapplication/json
dataobject(Conversation)required
data.​idintegerrequired

The id of the conversation. May also be referred to as the csid.

data.​created_atstring(Timestamp)required
Example: "2015-11-30T00:00:00:000Z"
data.​requester_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(Direction)required

The direction a conversation can be

Enum"outbound""inbound""internal"
data.​queued_atstring(Timestamp)
Example: "2015-11-30T00:00:00:000Z"
data.​queue_idstring(StringId)
data.​statusstring(Status)required
Enum"open""closed""pending""awaiting_pending"
data.​status_updated_atstring(Timestamp)
Example: "2015-11-30T00:00:00:000Z"
data.​attributesobject
data.​assigned_tostring(StringId)
data.​assigned_atstring(Timestamp)
Example: "2015-11-30T00:00:00:000Z"
Response
application/json
{
  "data": {
    "id": 0,
    "created_at": "2015-11-30T00:00:00:000Z",
    "requester_id": "string",
    "channel": "widget_chat",
    "direction": "outbound",
    "queued_at": "2015-11-30T00:00:00:000Z",
    "queue_id": "string",
    "status": "open",
    "status_updated_at": "2015-11-30T00:00:00:000Z",
    "attributes": {},
    "assigned_to": "string",
    "assigned_at": "2015-11-30T00:00:00:000Z"
  }
}

Get a single conversation by csidDeprecated

Request

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

Responses

A single conversation

Bodyapplication/json
dataobject(Conversation)required
data.​idintegerrequired

The id of the conversation. May also be referred to as the csid.

data.​created_atstring(Timestamp)required
Example: "2015-11-30T00:00:00:000Z"
data.​requester_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(Direction)required

The direction a conversation can be

Enum"outbound""inbound""internal"
data.​queued_atstring(Timestamp)
Example: "2015-11-30T00:00:00:000Z"
data.​queue_idstring(StringId)
data.​statusstring(Status)required
Enum"open""closed""pending""awaiting_pending"
data.​status_updated_atstring(Timestamp)
Example: "2015-11-30T00:00:00:000Z"
data.​attributesobject
data.​assigned_tostring(StringId)
data.​assigned_atstring(Timestamp)
Example: "2015-11-30T00:00:00:000Z"
Response
application/json
{
  "data": {
    "id": 0,
    "created_at": "2015-11-30T00:00:00:000Z",
    "requester_id": "string",
    "channel": "widget_chat",
    "direction": "outbound",
    "queued_at": "2015-11-30T00:00:00:000Z",
    "queue_id": "string",
    "status": "open",
    "status_updated_at": "2015-11-30T00:00:00:000Z",
    "attributes": {},
    "assigned_to": "string",
    "assigned_at": "2015-11-30T00:00:00:000Z"
  }
}

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": { … }
  }
}

Get a list of internal notes of a conversationDeprecated

Request

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

Responses

A list of internal notes

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

Text of the note

Response
application/json
{
  "data": [
    { … }
  ]
}

Get a list of activitylog events for a conversationDeprecated

Request

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

Responses

A list of activitylog events

Bodyapplication/json
dataArray of objects(ActivityLog)required
data[].​idstring(StringId)required
data[].​conversation_idintegerrequired
data[].​activity_timestmapstring(Timestamp)
Example: "2015-11-30T00:00:00:000Z"
data[].​activity_typestring(ActivityType)required

The type of activitylog entry.

Enum"tag_added""tag_removed""conversation_created_by_customer""conversation_created_by_agent""conversation_closed""conversation_pending""conversation_reopened""note_added""message_added_by_customer""message_added_by_agent"
data[].​authorobject(ActivityLogUser)
data[].​attributesTagAddedAttribute (object) or TagRemovedAttribute (object) or ConversationOfferedAttribute (object) or NoteAddedAttribute (object) or MessageAddedAttribute (object) or ConversationAssignedAttribute (object) or ConversationTransferredAttribute (object) or ConversationLanguageUpdatedAttribute (object) or ConversationAutoReplySentAttribute (object) or ConversationRatingScheduledAttribute (object) or ConversationRatingOfferedAttribute (object) or ConversationRatedAttribute (object) or ConversationClaimedAttribute (object) or ConversationCreatedAttribute (object) or ConversationUnassignedAttribute (object)
One of:
Response
application/json
{
  "data": [
    { … }
  ]
}

Get a list of activitylog eventsDeprecated

Request

Security
ApiKeyAuth or BearerAuth
Query
csidsArray of integers

a list of conversation ids associated with events

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/integrations-api/v1/conversations/activitylog?csids=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A list of activitylog events

Bodyapplication/json
dataArray of objects(ActivityLog)required
data[].​idstring(StringId)required
data[].​conversation_idintegerrequired
data[].​activity_timestmapstring(Timestamp)
Example: "2015-11-30T00:00:00:000Z"
data[].​activity_typestring(ActivityType)required

The type of activitylog entry.

Enum"tag_added""tag_removed""conversation_created_by_customer""conversation_created_by_agent""conversation_closed""conversation_pending""conversation_reopened""note_added""message_added_by_customer""message_added_by_agent"
data[].​authorobject(ActivityLogUser)
data[].​attributesTagAddedAttribute (object) or TagRemovedAttribute (object) or ConversationOfferedAttribute (object) or NoteAddedAttribute (object) or MessageAddedAttribute (object) or ConversationAssignedAttribute (object) or ConversationTransferredAttribute (object) or ConversationLanguageUpdatedAttribute (object) or ConversationAutoReplySentAttribute (object) or ConversationRatingScheduledAttribute (object) or ConversationRatingOfferedAttribute (object) or ConversationRatedAttribute (object) or ConversationClaimedAttribute (object) or ConversationCreatedAttribute (object) or ConversationUnassignedAttribute (object)
One of:
pagingobject(Paging)
Response
application/json
{
  "data": [
    { … }
  ],
  "paging": {
    "cursors": { … },
    "next_page": "string",
    "prev_page": "string"
  }
}

Schedule anonymization for specified entityDeprecated

Request

Security
ApiKeyAuth or BearerAuth
Bodyapplication/jsonrequired

Entity info to schedule anonymization

entity_idstringrequired

Id of the entity

entity_typestring(AnonymizationType)required

A type of entity for anonymization.

Enum"user""conversation"
force_anonymizationboolean

If set to true, anonymizes entity regardless of the status of related conversations. Defaults to false

curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/integrations-api/v1/anonymization_request \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "entity_id": "string",
    "entity_type": "user",
    "force_anonymization": true
  }'

Responses

Scheduled anonymization

Bodyapplication/json
dataobject(ScheduleAnonymizationResponse)
Response
application/json
{
  "data": {
    "id": "string",
    "target_entity_id": "string",
    "entity_type": "user",
    "initiated_at": "string",
    "requested_by": "string",
    "processed_at": "string"
  }
}

Get anonymization request for specified idDeprecated

Request

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

Responses

Anonymization request

Bodyapplication/json
dataobject(ScheduleAnonymizationResponse)
Response
application/json
{
  "data": {
    "id": "string",
    "target_entity_id": "string",
    "entity_type": "user",
    "initiated_at": "string",
    "requested_by": "string",
    "processed_at": "string"
  }
}

Message

Operations

Wrapup

Operations

Note

Operations

ActivityLog

Operations

flows

Operations