1-877-548-3001 Sign in About Contact
Developer

GET

/api/callback/search

Get a list of callbacks for your account based on the generic search.

Scope:

operator

Request Parameters

Query

A

search_term

required

The search term you would like to use

2

start_index

optional

Set start index for result set

2

count

optional

Set count/limit per page for result set

Response

Schema

{}

payload

The callbacks data

{}

callbacks

The list of callbacks

[]

{}

2

assigned_operator

The id of the operator if assigned

A

assigned_operator_name

The name of the operator if assigned

A

country_code

The visitor's current ISO2 country code

A

2

created_by

The id for the creator of the callback (visitor or operator)

A

created_time

The date and time for the callback in format YYYY-MM-DDTHH:MM:SSZ

A

department_name

The name of the department if assigned

fields

The list of fields for the callback

[]

{}

2

crm_id

The crm id

A

crm_name

The crm field name

2

id

The id of the callback field

A

label

The label of the callback field

A

value

The submitted value of the callback field

2

id

The id for the callback

A

status

The status for the callback will be Open, Escalated, Assigned or Closed

A

subtitle

The subtitle of the callback

A

title

The title of the callback

A

visitor_id

The visitor id associated with the callback

2

count

The number of callbacks in the page payload

2

start_index

The start index for the callbacks within the payload

2

total_rows

The total number of callbacks in the payload

A

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/search\?search_term\=chat

      
        

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

 }