Updates the working channel of an agent

Analytics

Operations

Agents

Operations

List presence

Request

List the presence status for all agents/admins in an organization.

Security

ApiKeyAuth

curl -i -X GET \
  https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents/presence \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of presence status for all agents/admins

Bodyapplication/jsonArray [

userIdstringrequired

requestTimestringrequired

lastSeenstring

presenceStatusstring

values: [Away, Working]

connectionStatusstringrequired

values: [Offline, Online]

activeChannelsArray of strings

]

Response

application/json

[
  {
    "userId": "d31a73fc-d67b-49ec-9534-1f36a0c4c906",
    "requestTime": "2021-12-01T12:46:35.935",
    "lastSeen": "2021-12-01T12:46:35.935",
    "presenceStatus": "Working",
    "connectionStatus": "Online",
    "activeChannels": [ … ]
  },
  {
    "userId": "8026cb51-184b-424f-8686-c6bc7bcf88eb",
    "requestTime": "2021-12-01T12:46:35.935",
    "lastSeen": "2021-12-01T12:46:35.935",
    "presenceStatus": "Working",
    "connectionStatus": "Online",
    "activeChannels": [ … ]
  }
]

List agents

Request

Lists all agents/admins in an organization. It is possible to filter by one of the mutually exclusive parameters: email or phone number. In case both are provided, an error is returned.

Security

ApiKeyAuth

Query

pageLimitinteger(int32)

Maximum number of results per page. May be used in combination with pageKey to change the number of results in between page requests.

pageKeystring

Base64 encoded form of pagination query parameters. Do not try to construct or change programmatically as the internal structure may change without notice.

emailstring

The agent/admin email filter

phonestring

The agent/admin phone number filter

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents?pageLimit=0&pageKey=string&email=string&phone=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of agents/admins

Bodyapplication/json

dataArray of objects(Agent)

metaobject(PaginationLinks)

Response

application/json

{
  "data": [
    { … },
    { … },
    { … },
    { … }
  ]
}

Update agents

Request

Bulk update agents/admins.

Security

ApiKeyAuth

Bodyapplication/json

The list of agent/admin update actions

Array [

idstringrequired

Unique identifier for the agent

displayNamestringrequired

The agent's display name

phoneNumberstring

The agent's primary phone number

additionalEmailsArray of stringsunique

Additional email addresses for the agent

additionalPhoneNumbersArray of stringsunique

Additional phone numbers for the agent

firstNamestring

The agent's first name

lastNamestring

The agent's last name

middleNamesArray of strings

The agent's middle names

avatarUrlstring

The url from which to load the agent's avatar

]

curl -i -X PUT \
  https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",
      "displayName": "Alice Brown",
      "phoneNumber": "+551155256325",
      "additionalEmails": [],
      "additionalPhoneNumbers": [],
      "firstName": "Alice",
      "lastName": "Brown",
      "middleNames": [],
      "avatarUrl": "http://avatar.url"
    }
  ]'

Responses

The list of update action outcomes

Bodyapplication/json

dataArray of BulkActionFailure_BulkError_Agent (object) or BulkActionSuccess_BulkError_Agent (object)(BulkActionOutcome_BulkError_Agent)

Response

application/json

{
  "data": [
    { … }
  ]
}

Create agent

Request

Create an agent.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

The agent's details

displayNamestringrequired

The agent's display name

emailstringrequired

The agent's primary email address

phoneNumberstring

The agent's primary phone number

additionalEmailsArray of stringsunique

Additional email addresses for the agent

additionalPhoneNumbersArray of stringsunique

Additional phone numbers for the agent

firstNamestring

The agent's first name

lastNamestring

The agent's last name

middleNamesArray of strings

The agent's middle names

avatarUrlstring

The url from which to load the agent's avatar

curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "Alice Brown",
    "email": "alice@brown.com",
    "phoneNumber": "+551155256325",
    "additionalEmails": [
      "alice@secondary.email"
    ],
    "additionalPhoneNumbers": [
      "+5566778899"
    ],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [],
    "avatarUrl": "http://avatar.url"
  }'

Responses

The created agent

Bodyapplication/json

dataobject(Agent)required

data.idstring(uuid)required

Unique identifier for the agent

data.createdAtstring(date-time)required

Time when the agent was created

data.displayNamestringrequired

The agent's display name

data.emailstringrequired

The agent's primary email address

data.avatarUrlstring

The url from which to load the agent's avatar

data.phoneNumberstring

The agent's primary phone number

data.additionalEmailsArray of stringsunique

Additional email addresses for the agent

data.additionalPhoneNumbersArray of stringsunique

Additional phone numbers for the agent

data.firstNamestring

The agent's first name

data.lastNamestring

The agent's last name

data.middleNamesArray of strings

The agent's middle names

data.rolesArray of stringsunique

The agent's roles

Response

application/json

{
  "data": {
    "id": "4d2ab456-8510-4a35-b266-e502160d5177",
    "createdAt": "2020-12-16T09:41:43Z",
    "displayName": "Alice Brown",
    "email": "alice@brown.com",
    "avatarUrl": "https://files.dixa.io/public/image_id",
    "phoneNumber": "+551155256325",
    "additionalEmails": [ … ],
    "additionalPhoneNumbers": [ … ],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [],
    "roles": [ … ]
  }
}

Patch agents

Request

Bulk patch agents/admins.

Security

ApiKeyAuth

Bodyapplication/json

List of agent/admin patch actions

Array [

idstringrequired

Unique identifier for the agent

displayNamestring

The agent's display name

phoneNumberstring

The agent's primary phone number

additionalEmailsArray of stringsunique

Additional email addresses for the agent

additionalPhoneNumbersArray of stringsunique

Additional phone numbers for the agent

firstNamestring

The agent's first name

lastNamestring

The agent's last name

middleNamesArray of strings

The agent's middle names

avatarUrlstring

The url from which to load the agent's avatar

]

curl -i -X PATCH \
  https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9b",
      "displayName": "AB",
      "additionalEmails": [],
      "additionalPhoneNumbers": [],
      "middleNames": []
    },
    {
      "id": "434ce9f5-14c8-4be1-a0a8-f755010deb9c",
      "displayName": "JB",
      "additionalEmails": [],
      "additionalPhoneNumbers": [],
      "middleNames": []
    }
  ]'

Responses

The list of patch action outcomes

Bodyapplication/json

dataArray of BulkActionFailure_BulkError_Agent (object) or BulkActionSuccess_BulkError_Agent (object)(BulkActionOutcome_BulkError_Agent)

Response

application/json

{
  "data": [
    { … },
    { … }
  ]
}

List teams

Request

List the teams in which the agent/admin is a member.

Security

ApiKeyAuth

Path

agentIdstring(uuid)required

The agent/admin id

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents/{agentId}/teams' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of teams in which the agent/admin is a member

Bodyapplication/json

dataArray of objects(Team)

Response

application/json

{
  "data": [
    { … },
    { … }
  ]
}

Get presence

Request

Get the presence status for an agent/admin.

Security

ApiKeyAuth

Path

agentIdstring(uuid)required

The agent/admin id

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents/{agentId}/presence' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The agent/admin presence status

Bodyapplication/json

dataobject(UserPresence)required

data.userIdstringrequired

data.requestTimestringrequired

data.lastSeenstring

data.presenceStatusstring

values: [Away, Working]

data.connectionStatusstringrequired

values: [Offline, Online]

data.activeChannelsArray of strings

Response

application/json

{
  "data": {
    "userId": "ec7f7e7b-b437-32ce-8681-45f71d37b53c",
    "requestTime": "2021-12-01T12:46:35.935",
    "lastSeen": "2021-12-01T12:46:35.935",
    "presenceStatus": "Working",
    "connectionStatus": "Online",
    "activeChannels": [ … ]
  }
}

Create agents

Request

Create agents in bulk.

Security

ApiKeyAuth

Bodyapplication/jsonrequired

The list of agent's details

dataArray of objects(CreateAgentInput)

curl -i -X POST \
  https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents/bulk \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "data": [
      {
        "displayName": "Alice Brown",
        "email": "alice@brown.com",
        "phoneNumber": "+551155256325",
        "additionalEmails": [],
        "additionalPhoneNumbers": [],
        "firstName": "Alice",
        "lastName": "Brown",
        "middleNames": [],
        "avatarUrl": "http://avatar.url"
      }
    ]
  }'

Responses

The created agents

Bodyapplication/json

dataArray of BulkActionFailure_BulkError_Agent (object) or BulkActionSuccess_BulkError_Agent (object)(BulkActionOutcome_BulkError_Agent)

Response

application/json

{
  "data": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ]
}

Get agent

Request

Get an agent/admin by id.

Security

ApiKeyAuth

Path

agentIdstring(uuid)required

The agent/admin id

curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents/{agentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The agent/admin

Bodyapplication/json

dataobject(Agent)required

data.idstring(uuid)required

Unique identifier for the agent

data.createdAtstring(date-time)required

Time when the agent was created

data.displayNamestringrequired

The agent's display name

data.emailstringrequired

The agent's primary email address

data.avatarUrlstring

The url from which to load the agent's avatar

data.phoneNumberstring

The agent's primary phone number

data.additionalEmailsArray of stringsunique

Additional email addresses for the agent

data.additionalPhoneNumbersArray of stringsunique

Additional phone numbers for the agent

data.firstNamestring

The agent's first name

data.lastNamestring

The agent's last name

data.middleNamesArray of strings

The agent's middle names

data.rolesArray of stringsunique

The agent's roles

Response

application/json

{
  "data": {
    "id": "4d2ab456-8510-4a35-b266-e502160d5177",
    "createdAt": "2020-12-16T09:41:43Z",
    "displayName": "Alice Brown",
    "email": "alice@brown.com",
    "avatarUrl": "https://files.dixa.io/public/image_id",
    "phoneNumber": "+551155256325",
    "additionalEmails": [ … ],
    "additionalPhoneNumbers": [ … ],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [],
    "roles": [ … ]
  }
}

Update agent

Request

Update an agent/admin.

Security

ApiKeyAuth

Path

agentIdstring(uuid)required

The agent id

Bodyapplication/jsonrequired

The updated details for an agent/admin

displayNamestringrequired

The agent's display name

phoneNumberstring

The agent's primary phone number

additionalEmailsArray of stringsunique

Additional email addresses for the agent

additionalPhoneNumbersArray of stringsunique

Additional phone numbers for the agent

firstNamestring

The agent's first name

lastNamestring

The agent's last name

middleNamesArray of strings

The agent's middle names

avatarUrlstring

The url from which to load the agent's avatar

curl -i -X PUT \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents/{agentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "Alice Brown",
    "phoneNumber": "+551155256325",
    "additionalEmails": [],
    "additionalPhoneNumbers": [],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [
      "Julia"
    ],
    "avatarUrl": "http://avatar.url"
  }'

Responses

The updated agent/admin

Bodyapplication/json

dataobject(Agent)required

data.idstring(uuid)required

Unique identifier for the agent

data.createdAtstring(date-time)required

Time when the agent was created

data.displayNamestringrequired

The agent's display name

data.emailstringrequired

The agent's primary email address

data.avatarUrlstring

The url from which to load the agent's avatar

data.phoneNumberstring

The agent's primary phone number

data.additionalEmailsArray of stringsunique

Additional email addresses for the agent

data.additionalPhoneNumbersArray of stringsunique

Additional phone numbers for the agent

data.firstNamestring

The agent's first name

data.lastNamestring

The agent's last name

data.middleNamesArray of strings

The agent's middle names

data.rolesArray of stringsunique

The agent's roles

Response

application/json

{
  "data": {
    "id": "4d2ab456-8510-4a35-b266-e502160d5177",
    "createdAt": "2020-12-16T09:41:43Z",
    "displayName": "Alice Brown",
    "email": "alice@brown.com",
    "avatarUrl": "https://files.dixa.io/public/image_id",
    "phoneNumber": "+551155256325",
    "additionalEmails": [ … ],
    "additionalPhoneNumbers": [ … ],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [ … ],
    "roles": [ … ]
  }
}

Delete agent

Request

Downgrade an agent/admin to become an end user.

Security

ApiKeyAuth

Path

agentIdstring(uuid)required

The agent/admin id

curl -i -X DELETE \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents/{agentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The agent/admin was successfully downgraded to end user

Response

No content

Patch agent

Request

Patch an agent/admin.

Security

ApiKeyAuth

Path

agentIdstring(uuid)required

The agent/admin id

Bodyapplication/jsonrequired

The agent/admin patch

displayNamestring

The agent's display name

phoneNumberstring

The agent's primary phone number

additionalEmailsArray of stringsunique

Additional email addresses for the agent

additionalPhoneNumbersArray of stringsunique

Additional phone numbers for the agent

firstNamestring

The agent's first name

lastNamestring

The agent's last name

middleNamesArray of strings

The agent's middle names

avatarUrlstring

The url from which to load the agent's avatar

curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/v1/v1/agents/{agentId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "displayName": "Alice Brown",
    "additionalEmails": [],
    "additionalPhoneNumbers": [],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [],
    "avatarUrl": "http://avatar.url"
  }'

Responses

The patched agent/admin

Bodyapplication/json

dataobject(Agent)required

data.idstring(uuid)required

Unique identifier for the agent

data.createdAtstring(date-time)required

Time when the agent was created

data.displayNamestringrequired

The agent's display name

data.emailstringrequired

The agent's primary email address

data.avatarUrlstring

The url from which to load the agent's avatar

data.phoneNumberstring

The agent's primary phone number

data.additionalEmailsArray of stringsunique

Additional email addresses for the agent

data.additionalPhoneNumbersArray of stringsunique

Additional phone numbers for the agent

data.firstNamestring

The agent's first name

data.lastNamestring

The agent's last name

data.middleNamesArray of strings

The agent's middle names

data.rolesArray of stringsunique

The agent's roles

Response

application/json

{
  "data": {
    "id": "4d2ab456-8510-4a35-b266-e502160d5177",
    "createdAt": "2020-12-16T09:41:43Z",
    "displayName": "Alice Brown",
    "email": "alice@brown.com",
    "avatarUrl": "https://files.dixa.io/public/image_id",
    "phoneNumber": "+551155256325",
    "additionalEmails": [ … ],
    "additionalPhoneNumbers": [ … ],
    "firstName": "Alice",
    "lastName": "Brown",
    "middleNames": [],
    "roles": [ … ]
  }
}