Callback Endpoint

The information for the specified callback.

GET //developer.livehelpnow.net/api/callback/{id}

Query Params

Name Expected Type Description
include_notes optional boolean If you would like to include any notes associated
include_tags optional boolean If you would like to include any tags associated

Result

{
 "status": "ok",
 "payload": {
  {
   "id": 12345,
   "status": "Open",
   "created_time": "2017-01-01T10:00:00.000000Z",
   "created_by": "12345",
   "assigned_operator": 12345,
   "assigned_operator_name": "Operator Name",
   "department_id": 12345,
   "department_name": "Department Name",
   "country_code": "US",
   "fields": [
    {
     "id": 12345,
     "crm_id": 48,
     "label": "Field Label",
     "value": "Field Value",
    },
   ...
   ],
   "notes": [
    {
     "id": 12345,
     "name": "Operator Name",
     "type": "Notes added",
     "note": "Hello",
     "is_public": false,
     "is_customer_notified": false,
     "duration": 0,
     "created_time": "2017-01-01T12:00:00.000000Z"
    },
   ...
   ],
   "tags": [
    {
     "id": 12345,
     "name": "Tag"
    },
   ...
   ],
   "actions": [
    {
     "action": "Call Created",
     "created_by": "First Last",
     "created_time": "2017-01-01T12:00:00.000000Z"
    },
   ...
   ]
  }
 }
}

id integer A unique identifier for the callback
status string The status for the callback
Will be Open, Escalated, Assigned or Closed
created_time string The date and time for the callback
created_by string The unique identifier for the creator of the callback (visitor or operator)
assigned_operator integer The unique identifier for the operator if assigned
assigned_operator_name string The name of the operator if assigned
department_id integer The identifier of the department if assigned
department_name string The name of the department if assigned
country_code string The visitor's current ISO2 country code
fields array The list of fields for the callback
 id integer A unique identifier for the callback field
 crm_id integer The LiveHelpNow CRM id for the callback field
 id label The label of the callback field
 id value The submitted value of the callback field
notes array The list of notes for the callback
 id integer A unique identifier for the callback note
 name string The operator name who wrote the callback note
 type string The type of callback note
 note string The callback note
 is_public boolean If the note is public
 is_customer_notified boolean If the customer is notified of the note
 duration integer The duration the note took in seconds (if available)
 created_time string The date time the note was created
tags array The list of tags for the callback
 id integer A unique identifier for the callback tag
 name string The callback tag
actions array The list of actions for the callback
 action string The type of action taken
 created_by string Who performed the action
 created_time string The date time the action was taken