Skip to content
/
Returns a list of users.

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

Returns a list of users.Deprecated

Request

Security
ApiKeyAuth or BearerAuth
Query
emailstring

email to search for

phone_numberstring

phone number to search for

limitinteger<= 200

Maximum number of items per page. With upper bound set to 200.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/integrations-api/v1/users?email=string&phone_number=string&limit=200' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A JSON array of users

Bodyapplication/json
dataArray of objects(User)required
data[].​idstringrequired

The id of the user

data[].​emailstring

The email address associated with the user

data[].​namestring

The name of the user

data[].​rolesArray of strings
data[].​avatar_urlstring

A link to the avatar of the user

data[].​phone_numberstring(PhoneNumberString)

A phone number. Always in E.164 format. See https://support.twilio.com/hc/en-us/articles/223183008-Formatting-International-Phone-Numbers.

pagingobject(Paging)
Response
application/json
{
  "data": [
    { … }
  ],
  "paging": {
    "cursors": { … },
    "next_page": "string",
    "prev_page": "string"
  }
}

Create a userDeprecated

Request

Security
ApiKeyAuth or BearerAuth
Bodyapplication/jsonrequired

The user to create

namestring
emailstring

The email address to be associated with the user. Must not be associated with any other users.

phone_numberstring(PhoneNumberString)

A phone number. Always in E.164 format. See https://support.twilio.com/hc/en-us/articles/223183008-Formatting-International-Phone-Numbers.

curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/integrations-api/v1/users \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "email": "string",
    "phone_number": "string"
  }'

Responses

The user was created

Bodyapplication/json
dataobject(User)required
data.​idstringrequired

The id of the user

data.​emailstring

The email address associated with the user

data.​namestring

The name of the user

data.​rolesArray of strings
data.​avatar_urlstring

A link to the avatar of the user

data.​phone_numberstring(PhoneNumberString)

A phone number. Always in E.164 format. See https://support.twilio.com/hc/en-us/articles/223183008-Formatting-International-Phone-Numbers.

pagingobject(Paging)
Response
application/json
{
  "data": {
    "id": "string",
    "email": "string",
    "name": "string",
    "roles": [ … ],
    "avatar_url": "string",
    "phone_number": "string"
  },
  "paging": {
    "cursors": { … },
    "next_page": "string",
    "prev_page": "string"
  }
}

Returns a list of conversations requested by a specific user.Deprecated

Request

Security
ApiKeyAuth or BearerAuth
Path
userIdstringrequired

Id of the requester

Query
limitinteger<= 200

Maximum number of items per page. With upper bound set to 200.

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/integrations-api/v1/users/{userId}/requested_conversations?limit=200' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A JSON array of conversations

Bodyapplication/json
dataArray of objects(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"
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"
  }
}

Tags

Operations

Queues

Operations

Endpoints

Operations

Conversations

Operations

Message

Operations

Wrapup

Operations

Note

Operations

ActivityLog

Operations

flows

Operations