GET
/api/callback/{id}
Get information for the specified callback
Scope:
operator
Request Parameters
Path
id
required
The id of the callback to get information about
Query
include_notes
optional
Set to true to include any associated notes
include_tags
optional
Set to true to include any associated tags
Response
Schema
payload
The callback data
action_date
The date and time for the callback action in format YYYY-MM-DDTHH:MM:SSZ
actions
The list of actions for the callback
action
The list of actions for the callback
action_log
The action that occurred
created_time
The date and time for the callback action in format YYYY-MM-DDTHH:MM:SSZ
assigned_operator
The id for 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_id
The identifier of the department if assigned
department_name
The name of the department if assigned
duration_sec
The length of the call in seconds
fields
The list of fields for the callback
crm_id
The crm id for the callback field
id
The id for the callback field
label
The label of the callback field
value
The submitted value of the callback field
id
The id for the callback
notes
The list of notes for the callback
created_by
The id of the note creator
created_time
The note created time
duration
The duration of the note
id
The note id
is_customer_notified
True if the customer is notified else false
is_public
True if the note is public else false
name
The note name
note
The note text
operator_info
The operator info
operator_name
The operator name
picture_path
The operator picture path
operator_accepted
true if accepted, false if not
source_type_id
The source type id of the call
status
The status for the callback will be Open, Escalated, Assigned or Closed
status_id
The status id of the call
subtitle
The subtitle of the callback
tags
The list of tags for the callback
The tag id
title
The title of the callback
visitor_id
The id of the visitor
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/callback/{{1234567}}
example response
1
{
2
"payload": {
3
"action_date"
: 1234,
4
"actions"
: [{
5
"action"
: "Call Assigned",
6
"action_log"
: "John Doe (jdoe) to John Doe (jdoe)",
7
"created_time"
: "2021-06-29T14:54:49"
8
}],
9
"assigned_operator"
: 1234,
10
"assigned_operator_name"
: "John Doe",
11
"country_code"
: "US",
12
"created_by"
: "system",
13
"created_time"
: "2020-04-28T21:40:56",
14
"department_id"
: 1,
15
"department_name"
: "Help Desk",
16
"duration_sec"
: 0
17
"fields"
: [{
18
"crm_id"
: 123,
19
"id"
: 12345,
20
"label"
: "Name",
21
"value"
: "John"
22
}],
23
"id"
: 1234567,
24
"notes": [{
25
"created_by"
: 1234,
26
"created_time"
: "2021-06-30T10:45:04",
27
"duration"
: 0,
28
"id"
: 1234567,
29
"is_customer_notified"
: false,
30
"is_public"
: false,
31
"name"
: "Test",
32
"note"
: "This is a test note"
33
"operator_info": {
34
"operator_name"
: "John Doe",
35
"picture_path"
: "https://cdn.livehelpnow.net/operators/photos/03241-C67SY84B.png"
36
}
37
}],
38
"operator_accepted"
: true,
39
"source_type_id"
: 1,
40
"status"
: "Assigned",
41
"status_id"
: 30,
42
"subtitle"
: "subtitle",
43
"tags"
: [350, 352]
44
"title"
: "title",
45
"visitor_id"
: "6f83df80-d39b-4a9f-a2b6-892d88ea4ab2-1-BDgXtjZ1"
46
},
47
"status": "ok"
48
}