Conversations

Create New Conversation

Creating a conversation in OXVO requires a source ID.

Learn more about source_id: https://docs.oxvo.com/guides/developers/api-guide/

post/v1/workspaces/{workspace_id}/conversations

Request

  • Base URL: https://api.oxvo.com
  • URL: https://api.oxvo.com/v1/workspaces/{workspace_id}/conversations
  • Auth: one of:
    • API key in header api_access_token
    • API key in header api_access_token

Request body

source_idstring required

Conversation source id

inbox_idinteger

Id of inbox in which the conversation is created <br/> Allowed Inbox Types: Website, Phone, Api, Email

contact_idinteger

Contact Id for which conversation is created

additional_attributesobject

Lets you specify attributes like browser information

custom_attributesobject

The object to save custom attributes for conversation, accepts custom attributes key and value

status'open' | 'resolved' | 'pending'

Specify the conversation whether it's pending, open, closed

assignee_idinteger

Agent Id for assigning a conversation to an agent

team_idinteger

Team Id for assigning a conversation to a team\

snoozed_untilstring date-time

Snoozed until date time

Example request

{
  "source_id": "1234567890",
  "inbox_id": 1,
  "contact_id": 1,
  "additional_attributes": {
    "browser": "Chrome",
    "browser_version": "89.0.4389.82",
    "os": "Windows",
    "os_version": "10"
  },
  "custom_attributes": {
    "attribute_key": "attribute_value",
    "priority_conversation_number": 3
  },
  "status": "open",
  "assignee_id": 1,
  "team_id": 1,
  "snoozed_until": "2030-07-21T17:32:28Z",
  "message": {
    "content": "Hello, how can I help you?",
    "template_params": {
      "name": "sample_issue_resolution",
      "category": "UTILITY",
      "language": "en_US",
      "processed_params": {
        "1": "OXVO"
      }
    }
  }
}

Response

Success

idnumber

ID of the conversation

account_idnumber

Account Id

inbox_idnumber

ID of the inbox

Changes

No recorded changes to this operation across all 1 revision of this API.