Skip to content
Dixa API/
/
Link a conversation to a...

Dixa API (beta)

Download OpenAPI description
index.json
index.yaml
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

Get conversation

Request

Get a conversation by id.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The conversation

Bodyapplication/json
dataAnonymizedConversation (object) or ChatConversation (object) or ContactFormConversation (object) or EmailConversation (object) or FacebookMessengerConversation (object) or GenericConversation (object) or MessengerConversation (object) or PstnPhoneConversation (object) or SmsConversation (object) or TwitterConversation (object) or WhatsAppConversation (object)(Conversation)required
One of:
data.​idinteger(int64)required
data.​requesterIdstring(uuid)required
data.​channelstringrequired

values: [WhatsApp, Voicemail, WidgetChat, FacebookMessenger, Twitter, Email, ContactForm, Callback, PstnPhone, Sms, Messenger]

data.​createdAtstring(date-time)required
data.​directionstring

values: [Inbound, Internal, Outbound]

data.​statestring

values: [AwaitingPending, Closed, Open, Pending]

data.​stateUpdatedAtstring(date-time)
data.​anonymizedAtstring(date-time)required
data.​linkEmailForward (object) or FollowUp (object) or SideConversation (object)(ConversationLink)
One of:
data.​customAttributesArray of objects(CustomAttribute)
data.​transportExpiresAtstring(date-time)
Response
application/json
{
  "data": {
    "id": 1,
    "requesterId": "d58c8b1c-85ad-4678-a6c8-7442945f3836",
    "channel": "WidgetChat",
    "createdAt": "2020-12-16T09:41:43Z",
    "direction": "Outbound",
    "state": "Open",
    "stateUpdatedAt": "2020-12-16T09:41:43Z",
    "assignment": { … },
    "queue": { … },
    "browserInfo": { … },
    "language": "en",
    "link": { … },
    "customAttributes": [ … ],
    "_type": "ChatConversation"
  }
}

List linked conversations

Request

Lists all linked child conversations for the given conversation ID, such as transcripts and side conversations.

Security
ApiKeyAuth
Path
conversationIdinteger(int64)required
curl -i -X GET \
  'https://docs.dixa.io/_mock/openapi/dixa-api/beta/beta/conversations/{conversationId}/linked' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

The list of conversations requested by an EndUser

Bodyapplication/json
dataArray of AnonymizedConversation (object) or ChatConversation (object) or ContactFormConversation (object) or EmailConversation (object) or FacebookMessengerConversation (object) or GenericConversation (object) or MessengerConversation (object) or PstnPhoneConversation (object) or SmsConversation (object) or TwitterConversation (object) or WhatsAppConversation (object)(Conversation)
Response
application/json
{
  "data": [
    { … }
  ]
}

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