GET
/api/callbacks
Get a list of callbacks for your account
Scope:
operator
Request Parameters
Query
assigned_operator
optional
Filter the results using the assigned operator id
assigned_department
optional
Filter the result by the assigned department
status
optional
Filter the results by the status (Open, Escalated, Assigned or Closed)
created_from
optional
Filter by created from to get results after the date
created_to
optional
Filter by created to and get results before the date
start_index
optional
Set start index for result set
count
optional
Set count/limit per page for result sets
Response
Schema
payload
The callbacks data
callbacks
The list of callbacks
assigned_operator
The id of the operator if assigned
assigned_operator_name
The name of the operator if assigned
country_code
The visitor's current ISO2 country code
created_by
The id for the creator of the callback (visitor or operator)
created_time
The date and time for the callback in format YYYY-MM-DDTHH:MM:SSZ
department_name
The name of the department if assigned
fields
The list of fields for the callback
crm_id
The crm id
crm_name
The crm field name
id
The id of the callback field
label
The label of the callback field
value
The submitted value of the callback field
id
The id for the callback
status
The status for the callback will be Open, Escalated, Assigned or Closed
subtitle
The subtitle of the callback
title
The title of the callback
visitor_id
The visitor id associated with the callback
count
The number of callbacks in the page payload
start_index
The start index for the callbacks within the payload
total_rows
The total number of callbacks in the payload
status
The system response status. Will be ok or error
curl
example request
1
curl -H "Authorization: Bearer {{Oauth Token}}"
2
https://developer.livehelpnow.net/api/callbacks
example response
1
{
2
"payload": {
3
"callbacks"
: [{
4
"assigned_operator"
: 1234,
5
"assigned_operator_name"
: "John Doe",
6
"country_code"
: "us",
7
"created_by"
: "d2e1xki31z3a03ojw1aelach-1-40787593",
8
"created_time"
: "2021-03-02T15:17:19",
9
"department_name"
: "support",
10
"fields"
: [{
11
"crm_id"
: 123
12
"crm_name"
: "Full Name"
13
"id"
: 12345
14
"label"
: "Name"
15
"value"
: "John Doe"
16
}],
17
"id"
: 123456
18
"status"
: "Open"
19
"subtitle"
: "Call Test"
20
"title"
: "Call Test"
21
"visitor_id"
: "d2e1xki31z3a03ojw1aelach-1-40787593"
22
}],
23
"count"
: 50,
24
"start_index"
: 1,
25
"total_rows"
: 917
26
},
27
"status": "ok"
28
}