Skip to content

Dixa API (beta)

Download OpenAPI description
Languages
Servers
Mock server
https://docs.dixa.io/_mock/openapi/dixa-api/beta
https://dev.dixa.io

Analytics

Operations

Agents

Operations

End Users

Operations

Chatbots

Operations

Anonymization

Operations

Custom Attributes

Operations

Teams

Operations

Conversations

Operations

Anonymize conversation

Request

Request the anonymization of a conversation.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required

the id of the conversation to anonymize

Query
forceboolean

Whether to force close the conversation if it is found in a non closed state.

Default false
curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/anonymize?force=false' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The conversation's anonymization request status

Bodyapplication/json
dataobject(AnonymizationRequestStatus)required
data.​idstring(uuid)required
data.​_typestringrequired

values: [Conversation, Message, User]

data.​initiatedAtstring(date-time)required
data.​targetEntityIdstringrequired
data.​requestedBystring(uuid)required
data.​processedAtstring(date-time)
data.​entityTypeConversationAnonymizationType (object) or MessageAnonymizationType (object) or UnknownAnonymizationType (object) or UserAnonymizationType (object)(DeprecatedAnonymizationType)Deprecatedrequired

Replaced by _type field

One of:
Deprecated

Replaced by _type field

object(ConversationAnonymizationType)
Response
application/json
{ "data": { "id": "87bac308-e49f-4134-84cc-96b868f1e1e4", "entityType": "ConversationAnonymizationType", "_type": "Conversation", "initiatedAt": "2021-12-01T12:46:36.581Z[GMT]", "targetEntityId": "10749", "requestedBy": "b165fdaa-51d6-44b0-bfcd-5f431d623fa7" } }

Anonymize message

Request

Request the anonymization of a single message in a conversation.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required

the id of the conversation in which the message belongs

messageIdstring(uuid)required

the id of the message to anonymize

curl -i -X PATCH \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/messages/{messageId}/anonymize' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The message's anonymization request status

Bodyapplication/json
dataobject(AnonymizationRequestStatus)required
data.​idstring(uuid)required
data.​_typestringrequired

values: [Conversation, Message, User]

data.​initiatedAtstring(date-time)required
data.​targetEntityIdstringrequired
data.​requestedBystring(uuid)required
data.​processedAtstring(date-time)
data.​entityTypeConversationAnonymizationType (object) or MessageAnonymizationType (object) or UnknownAnonymizationType (object) or UserAnonymizationType (object)(DeprecatedAnonymizationType)Deprecatedrequired

Replaced by _type field

One of:
Deprecated

Replaced by _type field

object(ConversationAnonymizationType)
Response
application/json
{ "data": { "id": "b165fdaa-51d6-44b0-bfcd-5f431d623fa7", "entityType": "MessageAnonymizationType", "_type": "Message", "initiatedAt": "2021-12-01T12:46:36.581Z[GMT]", "targetEntityId": "10749_1b9adc49-62f7-4056-a9c0-c18c1f25afdb", "requestedBy": "4c7af391-b7fd-4560-9d82-b3464eef8776" } }

Close conversation

Request

Mark a conversation as closed by providing its id.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
Bodyapplication/json

An optional agent/admin to close the conversation

userIdstring(uuid)
curl -i -X PUT \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/close' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "userId": "5a556159-9c21-4f3e-a44f-d323deb80d16"
  }'

Responses

The conversation was successfully closed

Response
No content

Messages

Operations

Internal Notes

Operations

Ratings

Operations

Tags

Operations

Queues

Operations

Contact Endpoints

Operations

Webhooks

Operations

Templates

Operations

Business Hours

Operations

Knowledge

Operations

Organization

Operations