Create an internal note in a conversation by providing the conversation id.
The created internal note
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, Agent was not found, Invalid date format
An entity in this request could not be found
Internal failure during request processing
{- "message": "A sample note",
- "agentId": "a53b25da-f676-4c52-acac-58c9280aa23d",
- "createdAt": "2021-12-01T12:46:36.581Z[GMT]"
}
{- "data": {
- "id": "eb31acbb-13f9-4ce7-abd3-44dd86266741",
- "authorId": "5e8a300e-787e-47cd-af53-fc1ccc37933d",
- "createdAt": "2021-12-01T12:46:36.581Z[GMT]",
- "csid": 9456,
- "message": "A sample note"
}
}
Create internal notes in a conversation by providing the conversation id.
The created internal notes
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body
An entity in this request could not be found
Internal failure during request processing
{- "data": [
- {
- "message": "A sample note",
- "agentId": "a53b25da-f676-4c52-acac-58c9280aa23d",
- "createdAt": "2021-12-01T12:46:36.581Z[GMT]"
}, - {
- "message": "Another sample note"
}
]
}
{- "data": [
- {
- "data": {
- "id": "eb31acbb-13f9-4ce7-abd3-44dd86266741",
- "authorId": "5e8a300e-787e-47cd-af53-fc1ccc37933d",
- "createdAt": "2021-12-01T12:46:36.581Z[GMT]",
- "csid": 9456,
- "message": "A sample note"
}, - "_type": "BulkActionSuccess"
}, - {
- "error": {
- "message": "An agent with id:... cannot be found in org."
}, - "_type": "BulkActionFailure"
}
]
}
Add a message to a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field. Currently Email, WidgetChat and Messenger channels are supported.
The message to be added to a conversation
The added message
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, Invalid input for Message, Failure to download attachment, Duplicate externalId, Unsupported ConversationChannel
An entity in this request could not be found
Internal failure during request processing
{- "content": {
- "value": "I need some help!",
- "_type": "Html"
}, - "_type": "Inbound"
}
{- "data": {
- "content": {
- "value": "An amazing message",
- "_type": "Html"
}, - "direction": "Outbound",
- "authorId": "bac5a02c-15b3-44da-ae1e-ab7b9db4aa89",
- "messageId": "87bac308-e49f-4134-84cc-96b868f1e1e4",
- "createdAt": "2021-06-09T08:18:37.284Z"
}
}
Request the anonymization of a conversation.
The conversation's anonymization request status
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: query parameter force
{- "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"
}
}
Request the anonymization of a single message in a conversation.
The message's anonymization request status
Invalid value for: path parameter conversationId, Invalid value for: path parameter messageId, Invalid value extracted from request context
{- "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"
}
}
Claim a conversation for a given agent. To avoid taking over assigned conversations, set the force
paremeter to false
The conversation was successfully claimed
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body
An entity in this request could not be found
Internal failure during request processing
{- "agentId": "5a556159-9c21-4f3e-a44f-d323deb80d16",
- "force": false
}
{- "message": "Invalid value in request"
}
Mark a conversation as closed by providing its id.
The conversation was successfully closed
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not agent/admin
An entity in this request could not be found
{- "userId": "5a556159-9c21-4f3e-a44f-d323deb80d16"
}
{- "message": "Decoding failure in request"
}
Create a conversation. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field.
The id of the created conversation
Invalid value extracted from request context, Invalid value for: body, Invalid input for Message, Failure to download attachment, Duplicate externalId, Unsupported ConversationChannel
An entity in this request could not be found
Internal failure during request processing
{- "requesterId": "9c2a2cce-699f-4a72-89d9-fda5bc8dec8b",
- "emailIntegrationId": "my-integration@email.dixa.io",
- "subject": "order #123",
- "message": {
- "content": {
- "value": "My order hasn't shipped",
- "_type": "Text"
}, - "attachments": [ ],
- "_type": "Inbound"
}, - "language": "en",
- "_type": "Email"
}
{- "data": {
- "id": 100
}
}
Create a rating result for a specific conversation.
The rating result to be created for a conversation
The created conversation rating result
Internal failure during request processing
{- "userId": "d3cf6f15-1497-4e71-92f2-9b3b228352bd",
- "ratingResult": {
- "ratingType": "CSAT",
- "value": 4,
- "_type": "NumericResultInput"
}, - "comment": "Best customer service ever!",
- "offeredTime": "2024-03-11T16:39:30Z",
- "submittedTime": "2024-03-11T16:39:30Z"
}
{- "data": {
- "ratingResultId": "33cf4e5e-9ce9-461c-b668-be9b712b717c"
}
}
Get a conversation by id.
The conversation
Invalid value for: path parameter conversationId, Invalid value extracted from request context
An entity in this request could not be found
Internal failure during request processing
{- "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": {
- "agentId": "0e4d0ead-dc69-470a-9b3a-e7eb16a56453",
- "assignedAt": "2020-12-16T11:00:34Z"
}, - "queue": {
- "id": "cd87b232-64c8-4ad5-b81a-6f9233352d97",
- "queuedAt": "2020-12-16T10:40:40Z"
}, - "browserInfo": {
- "name": "Chrome 9",
- "version": "91.0.4472.114",
- "ipAddress": "127.0.0.1",
}, - "language": "en",
- "link": {
- "parentId": 1234,
- "_type": "SideConversation"
}, - "customAttributes": [
- {
- "id": "e14708a6-eed9-495c-9d88-c72331e9e247",
- "name": "My Attribute",
- "identifier": "my_attribute",
- "value": "My Attribute Value"
}
], - "_type": "ChatConversation"
}
}
Import a previously created conversation into Dixa. For inbound messages the author is assumed to be the requester of the conversation (end user). For outbound messages the author is specified using the agentId field.
The type of conversation to import
The id of the imported conversation
Invalid value extracted from request context, Invalid value for: body, Invalid input for Message, Failure to download attachment, Unsupported ConversationChannel, Requester does not exist, Agent does not exist
An entity in this request could not be found
Internal failure during request processing
{- "genericChannelName": "MyCustomChat",
- "requesterId": "9c2a2cce-699f-4a72-89d9-fda5bc8dec8b",
- "requesterConnectionStatus": "Connected",
- "direction": "Inbound",
- "messages": [
- {
- "content": {
- "value": "My order hasn't shipped",
- "_type": "Text"
}, - "attachments": [ ],
- "createdAt": "2021-12-01T13:00:00.003Z",
- "_type": "InboundImport"
}, - {
- "content": {
- "value": "Our bad, sorry",
- "_type": "Text"
}, - "agentId": "cd4ceb58-bb3a-443c-9cd8-4f088feafe5b",
- "attachments": [
- {
- "prettyName": "shipwreck"
}
], - "createdAt": "2021-12-01T14:00:00.004Z",
- "_type": "OutboundImport"
}
], - "createdAt": "2021-12-01T11:00:00.001Z",
- "assignment": {
- "agentId": "cd4ceb58-bb3a-443c-9cd8-4f088feafe5b",
- "assignedAt": "2021-12-01T12:00:00.002Z"
}, - "_type": "GenericConversationImport"
}
{- "data": {
- "id": 100,
- "partialErrors": [
- {
- "message": "The conversation could not be assigned"
}, - {
- "message": "Invalid attachment url in message. externalId: 42"
}
]
}
}
Get the activity log for a conversation by providing the conversation id.
Activity log entries for a conversation
Invalid value for: path parameter conversationId, Invalid value extracted from request context
Internal failure during request processing
{- "data": [
- {
- "id": "fca291e5-8670-41bd-b502-842fd9542e27",
- "conversationId": 1,
- "activityTimestamp": "2021-12-01T12:46:36.581Z[GMT]",
- "activityType": "ConversationAssignedActivityType",
- "_type": "ConversationAssigned",
- "author": {
- "id": "a53b25da-f676-4c52-acac-58c9280aa23d",
- "name": "Dale Cooper",
- "email": "dc@dixa.com",
- "phoneNumber": "+4534343434"
}
}
]
}
List all conversations flows in an organization.
The list of conversation flows
Invalid value extracted from request context, Invalid value for: query parameter channel
Internal failure during request processing
{- "data": [
- {
- "id": "d546e9a8-82c2-409f-b688-e9199ea69f83",
- "name": "Default call flow",
- "channel": "PstnPhone",
- "contactEndpointId": "+559912443333"
}
]
}
Get all internal notes for a particular conversation by providing the conversation id.
List of internal notes for a conversation sorted from oldest to newest
Invalid value for: path parameter conversationId, Invalid value extracted from request context
An entity in this request could not be found
Internal failure during request processing
{- "data": [
- {
- "id": "3346b99c-8128-4276-ac40-5f30c959e5e7",
- "authorId": "c68f42a5-1453-497a-940f-ff36ed4f1631",
- "createdAt": "2021-01-20T09:00:00Z",
- "csid": 7392,
- "message": "A note to remember"
}, - {
- "id": "22b8e6b6-4576-4dc0-ab05-60f81e8b0708",
- "authorId": "124d54bb-92d6-41c9-a675-788d6a8c821e",
- "createdAt": "2021-01-22T12:00:00Z",
- "csid": 7392,
- "message": "A note to forget"
}
]
}
Lists all linked child conversations for the given conversation ID, such as transcripts and side conversations.
The list of conversations requested by an EndUser
Invalid value for: path parameter conversationId, Invalid value extracted from request context
An entity in this request could not be found
Internal failure during request processing
{- "data": [
- {
- "id": 12341,
- "requesterId": "7bcf1f2d-70c0-4f87-8c5b-bed2c8b247e9",
- "channel": "WidgetChat",
- "createdAt": "2022-07-26T12:09:21Z",
- "direction": "Inbound",
- "state": "Open",
- "stateUpdatedAt": "2022-07-26T12:12:53Z",
- "assignment": {
- "agentId": "01107a2e-4ff0-4a87-bb48-a19af298394d",
- "assignedAt": "2022-07-26T12:12:53Z"
}, - "queue": {
- "id": "6b9087b3-9ab7-4af4-936d-3290996faedb",
- "queuedAt": "2022-07-26T12:09:54Z"
}, - "toEmail": "something@email.dixa.com",
- "fromEmail": "some.one@somewhere.com",
- "integrationEmail": "something@email.dixa.com",
- "language": "en",
- "subject": "Important Request",
- "link": {
- "parentId": 1234,
- "_type": "SideConversation"
}, - "_type": "EmailConversation"
}
]
}
Get all messages for a particular conversation by providing the conversation id. Note that messages in ContactForm
conversations can have attributes of "_type": "EmailAttributes"
if they are created through a webform, or "_type": "ContactFormAttributes"
when created through a chat widget.
List of messages for a conversation sorted from oldest to newest
Invalid value for: path parameter conversationId, Invalid value extracted from request context
An entity in this request could not be found
{- "data": [
- {
- "id": "11b95893-0514-4606-a5d8-1880172b3a55",
- "authorId": "41646d42-edc0-493e-ac7b-814d9ff40a2e",
- "externalId": "13244",
- "createdAt": "2021-12-01T12:46:36.581Z[GMT]",
- "attributes": {
- "emailContent": {
- "content": {
- "value": "Hello",
- "_type": "Text"
}, - "_type": "Regular"
}, - "from": {
- "email": "some-help@email.dixa.io",
- "name": "Help"
}, - "to": [
- {
- "email": "someone@somecompany.com",
- "name": "Some One"
}
], - "cc": [ ],
- "bcc": [ ],
- "isAutoReply": false,
- "inlineImages": [ ],
- "attachments": [
], - "direction": "Outbound",
- "originalContentUrl": {
}, - "_type": "EmailAttributes"
}
}
]
}
List all activity logs for an organization.
The full list of activity logs for an organization with pagination
Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: query parameter fromDatetime, Invalid value for: query parameter toDatetime, Validation failure when retrieving data
Internal failure during request processing
{- "data": [
- {
- "id": "d85a7bd7-79da-4f10-b021-12e4c2c20024",
- "conversationId": 1,
- "activityTimestamp": "2021-12-01T12:46:36.581Z[GMT]",
- "activityType": "ConversationAssignedActivityType",
- "_type": "ConversationAssigned",
- "author": {
- "id": "a53b25da-f676-4c52-acac-58c9280aa23d",
- "name": "Dale Cooper",
- "email": "dc@dixa.com",
- "phoneNumber": "+4534343434"
}
}, - {
- "id": "324d0108-31b7-4678-8862-c8780a297f8f",
- "conversationId": 2,
- "activityTimestamp": "2021-12-01T12:46:36.581Z[GMT]",
- "activityType": "ConversationAssignedActivityType",
- "_type": "ConversationAssigned",
- "author": {
- "id": "67ff39b6-b1ee-4d5f-91ee-168d4668c4ba",
- "name": "Bob Ross",
- "email": "br@dixa.com",
- "phoneNumber": "+4532323232"
}
}
]
}
Get the ratings for a particular conversation by providing the conversation id.
List of ratings for a conversation
Invalid value for: path parameter conversationId, Invalid value extracted from request context
An entity in this request could not be found
Internal failure during request processing
{- "data": [
- {
- "id": "33cf4e5e-9ce9-461c-b668-be9b712b717c",
- "ratingScore": 4,
- "ratingType": "Csat",
- "ratingComment": "Super good!",
- "conversationChannel": "PstnPhone",
- "agentId": "a53b25da-f676-4c52-acac-58c9280aa23d",
- "userId": "6d0c5791-e40a-46d4-bba1-1364ce4578ed",
- "ratingStatus": "Offered",
- "language": "English",
- "timestamps": { }
}
]
}
Get the tags for a particular conversation by providing the conversation id.
List of tags for a conversation
Invalid value for: path parameter conversationId, Invalid value extracted from request context
An entity in this request could not be found
Internal failure during request processing
{- "data": [
- {
- "id": "b794a74a-625b-4303-8237-9b11668a9605",
- "name": "example",
- "state": "Active"
}, - {
- "id": "b794a74a-625b-4303-8237-9b11668a9605",
- "name": "example",
- "state": "Active"
}, - {
- "id": "b794a74a-625b-4303-8237-9b11668a9605",
- "name": "example",
- "state": "Active"
}, - {
- "id": "b794a74a-625b-4303-8237-9b11668a9605",
- "name": "example",
- "state": "Active"
}
]
}
Patch custom attributes of a conversation
The custom attributes of an conversation to be patched. This should map the custom attribute id to the desired attribute value. Format: Map[UUID, Option[AttributeValue].
additional property | Array of strings or string AttributeValue values: String[] if the type of the custom attribute is Select or String if the type of the custom attribute is Text |
The patched conversation attributes
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, Invalid input for patching
The user who issued the access token used in the request is not authorized to perform the operation
An entity in this request could not be found
{- "2f5515b6-7e98-4f4d-9010-bfd2a27d4f35": "012345",
- "e14708a6-eed9-495c-9d88-c72331e9e247": [
- "str1",
- "str2"
]
}
{- "data": [
- {
- "id": "2f5515b6-7e98-4f4d-9010-bfd2a27d4f35",
- "name": "Conversation attribute",
- "identifier": "conversation_attribute",
- "value": "012345"
}, - {
- "id": "e14708a6-eed9-495c-9d88-c72331e9e247",
- "name": "Conversation attribute 2",
- "identifier": "conversation_attribute_2",
- "value": [
- "str1",
- "str2"
]
}
]
}
Reopen a conversation and offer it in the same queue. Falls back to the default organization queue if the conversation has no target queue.
The conversation was successfully reopened and offered in the same queue
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not agent/admin
An entity in this request could not be found
Internal failure during request processing
{- "userId": "a53b25da-f676-4c52-acac-58c9280aa23d"
}
{- "message": "Decoding failure in request"
}
Search for conversations containing a particular text.
The search results for the searched parameters
Invalid value extracted from request context, Invalid value for: query parameter pageLimit, Invalid value for: query parameter pageKey, Invalid value for: query parameter query, Invalid value for: query parameter exactMatch
The user who issued the access token used in the request is not authorized to perform the operation
Internal failure during request processing
{- "data": [
- {
- "id": 1234,
- "highlights": {
- "subject": [
- "<em class=\"highlight\">Cancel my order</em>"
]
}, - "innerHits": [
- {
- "id": "dadcaea0-4135-4e8a-a5bf-05d4658facba",
- "highlight": {
- "text": "I want to <em class=\"highlight\">cancel my order</em> as soon as possible"
}
}
], - "_type": "ConversationSearchHit"
}
]
}
Tag a conversation. You may only use active tags to tag conversations.
The conversation was successfully tagged
Invalid value for: path parameter conversationId, Invalid value for: path parameter tagId, Invalid value extracted from request context
An entity in this request could not be found
Internal failure during request processing
{- "message": "Invalid value in request"
}
Transfer a conversation to a target queue.
The conversation was successfully transferred to the target queue
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body, User not found, User is not agent/admin, Queue does not exist
An entity in this request could not be found
Internal failure during request processing
{- "queueId": "92f8d193-b26f-4a62-86a3-bb03ee0915e9",
- "userId": "a53b25da-f676-4c52-acac-58c9280aa23d"
}
{- "message": "Decoding failure in request"
}
Untag a conversation. You may remove active or inactive tags from a conversation.
The conversation was successfully untagged
Invalid value for: path parameter conversationId, Invalid value for: path parameter tagId, Invalid value extracted from request context
An entity in this request could not be found
Internal failure during request processing
{- "message": "Invalid value in request"
}
Update the end user connection status in a conversation.
End user connection status updated
Invalid value for: path parameter conversationId, Invalid value extracted from request context, Invalid value for: body
An entity in this request could not be found
Internal failure during request processing
{- "status": "Connected"
}
{- "message": "Decoding failure in request"
}