Dixa
    Nothing Found

Conversations

Add a historical message to a conversationDeprecated

SecurityApiKeyAuth or BearerAuth
Request
path Parameters
csid
required
integer
Request Body schema: application/json
required

The message to insert.

Array of objects (AttachmentInput)

A list of attachments.

author_id
string (StringId)
channel
string (Channel)

The channel a conversation can be conducted on.

Enum: "callback" "contact_form" "email" "facebook_messenger" "phone" "voice_mail" "widget_chat"
direction
string (Direction)

The direction a conversation can be

Enum: "inbound" "internal" "outbound"
from_email
string (EmailString)

A regular email.

text
string
to_email
string (EmailString)

A regular email.

Responses
200

The message was createde

post/v1/conversations/{csid}/messages/historical
Request samples
application/json
{
  • "channel": "widget_chat",
  • "direction": "outbound",
  • "from_email": "string",
  • "to_email": "string",
  • "text": "string",
  • "author_id": "string",
  • "attachments": [
    • {
      • "url": "string"
      }
    ]
}
Response samples
application/json
{
  • "data": {
    • "id": "string",
    • "created_at": "2015-11-30T00:00:00:000Z",
    • "author_id": "string",
    • "channel": "widget_chat",
    • "direction": "widget_chat",
    • "attributes": {
      • "text": "string",
      • "to_emails": "string",
      • "cc_email": "string",
      • "from_email": "string",
      • "inline_images": "string",
      • "attachments": "string",
      • "direction": "string",
      • "a_phone_number": "string",
      • "b_phone_number": "string",
      • "is_automated_message": "string",
      • "is_auto_reply": "string"
      }
    }
}

Create a conversationDeprecated

SecurityApiKeyAuth or BearerAuth
Request
Request Body schema: application/json
required

The conversation to create. Only callback and contact form conversations are currently supported.

One of:
channel
required
string

The channel a conversation can be conducted on.

Enum: "callback" "contact_form" "email" "facebook_messenger" "phone" "voice_mail" "widget_chat"
direction
required
string (Direction)

The direction a conversation can be

Enum: "inbound" "internal" "outbound"
endpoint_id
required
string
queue_id
required
string (StringId)
requester_id
required
string (StringId)
tags
Array of strings

A list of tag names.

Responses
200

The conversation was created

post/v1/conversations
Request samples
application/json
{
  • "channel": "widget_chat",
  • "direction": "outbound",
  • "queue_id": "string",
  • "requester_id": "string",
  • "endpoint_id": "string",
  • "tags": [
    • "string"
    ]
}
Response samples
application/json
{
  • "data": {
    • "id": 0,
    • "created_at": "2015-11-30T00:00:00:000Z",
    • "requester_id": "string",
    • "channel": "callback",
    • "direction": "inbound",
    • "queued_at": "2015-11-30T00:00:00:000Z",
    • "queue_id": "string",
    • "status": "open",
    • "status_updated_at": "2015-11-30T00:00:00:000Z",
    • "attributes": { },
    • "assigned_to": "string",
    • "assigned_at": "2015-11-30T00:00:00:000Z"
    }
}

Get a list of activitylog eventsDeprecated

SecurityApiKeyAuth or BearerAuth
Request
query Parameters
csids
Array of integers

a list of conversation ids associated with events

Responses
200

A list of activitylog events

get/v1/conversations/activitylog
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "conversation_id": 0,
      • "activity_timestmap": "2015-11-30T00:00:00:000Z",
      • "activity_type": "tag_added",
      • "author": {
        • "id": "string",
        • "name": "string",
        • "email": "string",
        • "phone_number": "string"
        },
      • "attributes": {
        • "tag_name": "string"
        }
      }
    ],
  • "paging": {
    • "cursors": {
      • "after": "string",
      • "before": "string"
      },
    • "next_page": "string",
    • "prev_page": "string"
    }
}
Get a list of activitylog events for a conversationDeprecated
SecurityApiKeyAuth or BearerAuth 
Request 
path Parameters
csid
required
integer
 
Responses 
200
A list of activitylog events


get/v1/conversations/{csid}/activitylog
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "conversation_id": 0,
      • "activity_timestmap": "2015-11-30T00:00:00:000Z",
      • "activity_type": "tag_added",
      • "author": {
        • "id": "string",
        • "name": "string",
        • "email": "string",
        • "phone_number": "string"
        },
      • "attributes": {
        • "tag_name": "string"
        }
      }
    ]
}
Get a list of internal notes of a conversationDeprecated
SecurityApiKeyAuth or BearerAuth 
Request 
path Parameters
csid
required
integer
 
Responses 
200
A list of internal notes


get/v1/conversations/{csid}/notes
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "created_at": "2015-11-30T00:00:00:000Z",
      • "requester_id": "string",
      • "text": "string"
      }
    ]
}
Get a list of messages within a conversationDeprecated
SecurityApiKeyAuth or BearerAuth 
Request 
path Parameters
csid
required
integer
 
Responses 
200
A list of messages


get/v1/conversations/{csid}/messages
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "id": "string",
      • "created_at": "2015-11-30T00:00:00:000Z",
      • "author_id": "string",
      • "channel": "callback",
      • "direction": "callback",
      • "attributes": {
        • "text": "string",
        • "to_emails": "string",
        • "cc_email": "string",
        • "from_email": "string",
        • "inline_images": "string",
        • "attachments": "string",
        • "direction": "string",
        • "a_phone_number": "string",
        • "b_phone_number": "string",
        • "is_automated_message": "string",
        • "is_auto_reply": "string"
        }
      }
    ]
}
Get a single conversation by csidDeprecated
SecurityApiKeyAuth or BearerAuth 
Request 
path Parameters
csid
required
integer
 
Responses 
200
A single conversation


get/v1/conversations/{csid}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": 0,
    • "created_at": "2015-11-30T00:00:00:000Z",
    • "requester_id": "string",
    • "channel": "callback",
    • "direction": "inbound",
    • "queued_at": "2015-11-30T00:00:00:000Z",
    • "queue_id": "string",
    • "status": "open",
    • "status_updated_at": "2015-11-30T00:00:00:000Z",
    • "attributes": { },
    • "assigned_to": "string",
    • "assigned_at": "2015-11-30T00:00:00:000Z"
    }
}
Get anonymization request for specified idDeprecated
SecurityApiKeyAuth or BearerAuth 
Request 
path Parameters
requestId
required
string
 
Responses 
200
Anonymization request


get/v1/anonymization_request/{requestId}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "id": "string",
    • "target_entity_id": "string",
    • "entity_type": "user",
    • "initiated_at": "string",
    • "requested_by": "string",
    • "processed_at": "string"
    }
}
Schedule anonymization for specified entityDeprecated
SecurityApiKeyAuth or BearerAuth 
Request 
Request Body schema: application/json
required
Entity info to schedule anonymization


entity_id
required
string
Id of the entity


 
entity_type
required
string (AnonymizationType) 
A type of entity for anonymization.


 Enum: "conversation" "user"  
force_anonymization
boolean
If set to true, anonymizes entity regardless of the status of related conversations. Defaults to false


 
Responses 
200
Scheduled anonymization


post/v1/anonymization_request
Request samples 
application/json
{
  • "entity_id": "string",
  • "entity_type": "user",
  • "force_anonymization": true
}
Response samples 
application/json
{
  • "data": {
    • "id": "string",
    • "target_entity_id": "string",
    • "entity_type": "user",
    • "initiated_at": "string",
    • "requested_by": "string",
    • "processed_at": "string"
    }
}
Why Dixa
Product
Capabilities
Resources
Solutions
Company
Call us now 
© Dixa 2024