Get Thread Details

Gets details of a thread based on the thread ID.

Permissions

  ----
  Permissions:INTEGRATOR,OPERATOR,SUPERVISOR
  ----

HTTP Request

GET /api/v1/threads/1 HTTP/1.1
Authorization: Bearer <integrator_token>
Host: localhost:8080

HTTP Response Variables

ParameterTypeDescription
idnumberUnique identifier for the thread in edna Chat Center
statusstringCurrent status of the thread
startTimestringDate when the thread was created (that is, when the first client message was received)
stateChangeTimestringDate when the thread changed its status
unreadnumberNumber of unread client messages
unanswerednumberNumber of unanswered client messages
lastAgentnumberLast agent ID
lastAgentLoginstringLast agent login
currentAgentnumberCurrent agent ID
currentAgentLoginstringCurrent agent login
channelnumberChannel of the incoming thread
clientIdnumberUnique identifier of the client in edna Chat Center
clientExternalIdstringUnique identifier of the client in a third-party system
clientNamestringClient’s name
threadUrlstringThread URL
tagsarrayTags assigned to the thread by the agent
infomapThread info for segmentation
info.keystringOther thread info

Status Values

  • NEW (string): The thread is waiting to be distributed to an agent’s queue.
  • UNASSIGNED (string): The thread is waiting to be distributed to another agent’s queue.
  • SUSPENDED (string): This is an incoming thread that was sent outside of working hours.
  • ASSIGNED (string): The thread has been distributed to an agent’s queue. This thread doesn’t have any response messages.
  • REASSIGNED (string): The thread has been distributed to an agent’s queue. This thread has some response messages.
  • ANSWER_NEEDED (string): The thread has been assigned to an agent. The client is waiting for the agent to respond.
  • WAITING (string): The thread has been assigned to the agent. The agent is waiting for the client to respond.
  • IN_PROGRESS (string): The thread has been assigned to an agent. The thread is currently being processed by the agent in the agent WP.
  • CLOSED (string): The thread has been closed.

Channel Values

ChannelTypeAuthorized
1WEBtrue
2MOBILEtrue
3VIBERtrue
4TELEGRAMtrue
5VIBEPRAtrue
6FACEBOOKtrue
7VKONTAKTEtrue
8WEBfalse
9MOBILEfalse
10EMAILfalse

Example of a Successful HTTP Response

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 513
{
    "id": 1,
    "status": "NEW",
    "startTime": "2021-01-21T08:00:00Z",
    "stateChangeTime": "2021-01-21T08:00:00Z",
    "unread": 2,
    "unanswered": 2,
    "currentAgent": 1,
    "currentAgentLogin": "operator1",
    "lastAgent": 2,
    "lastAgentLogin": "operator2",
    "channel": 1,
    "clientId": 1234,
    "clientExternalId": "ACC1234567",
    "clientName": null,
    "threadUrl": "http://threads.im/arm/thread/100",
    "tags": [
        "1",
        "2"
    ],
    "info": {
        "key": "value"
    }
}