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

Wrapup

Operations

Note

Operations

ActivityLog

Operations

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"
  }
}

flows

Operations