Sign in

v1

latestOpenAPI 3.0.02026-07-24378968.5 KB
Chat

/chat

Retrives all chats or filter using a search criteria

get/chat

Query parameters

propertystring required

Name of the property

operator'eq' | 'ne' | 'lt' | 'gt' | 'le' | 'ge' | 'in' | 'nin' required

Comparison operator

[
  {
    "property": "name",
    "operator": "eq"
  }
]
pagenumber

Number of the page

limitnumber

Limit of items per page. MAX = 100, MIN = 1

propertystring required

Name of the property to sort

direction'asc' | 'desc' required

'asc' or 'desc' to order the result

{
  "property": "name",
  "direction": "asc"
}

Headers

octa-agent-emailstring

Response

idstring required

Your chat identification key

numberstring

The number to identify your chat through the application

channel'whatsapp' | 'web' | 'facebook-messenger' | 'instagram' | 'email' | 'widget'

Channel that the conversation occurred

lastMessageDatestring date-time

Date of the last message that was send

status'waiting' | 'talking' | 'closed' | 'missed' | 'started' | 'offline' | 'hidden'

The status of the conversation

closedAtstring date-time

Date the chat was closed

tagsstring[]

The tags that are marked for this conversation

withBotboolean

If a bot was involved in this conversation

unreadMessagesboolean

An attribute that indicates whether there are unanswered messages

createdAtstring date-time

The date the chat was created

updatedAtstring date-time

The date the chat was last updated

origin'outbound' | 'inbound'

Person who started the conversation

botNamestring

Name of the bot that participated in the conversation

conversationOriginstring

Origin of the conversation

statusDetail'in-queue' | 'in-service' | 'abandoned' | 'closed-inactivity' | 'closed-timeout' | 'closed-by-operator' | 'closed-by-customer' | 'closed-by-Bot'

The status detail

agentFirstMessageDatestring

Date of the first message sent by an agent

botAssignedDatestring

Date when the bot assigned the chat

assignedToAgentDatestring

Date when the chat was assigned to an agent

assignedToGroupDatestring

Date when the chat was assigned to a group

Example response

[
  {
    "contact": {
      "name": "Jane Doe",
      "email": "jane_doe@test.com",
      "phoneContacts": [
        {
          "number": "119999999999",
          "countryCode": "55"
        }
      ]
    },
    "agent": {
      "phoneContacts": {
        "number": "119999999999",
        "countryCode": "55"
      }
    }
  }
]