Call session list

get

https://temvox.com/api/v1/search/cis/calls

Use this endpoint to search list of call sessions.

Query Params

fields

string

required

Comma-separated list of enum names. Example- id,phone,duration,taskId,taskName,botId,botName,regionId,timezone,status,shortNumber,transferredToOperator,linkToLog,createdAt,updatedAt,startedAt,price,messages,messagesAsString,additional,externalId,dialogResults,responder,nps,isFinished,recordPath,operatorDuration,botDuration,markers

limit

integer

≤ 1000

Defaults to 10

Maxium number of returning records. (max 1000)

offset

integer

Starting point to return records from a result set.

page

integer

Page number, used to paginate over all records.

output

string

enum

Determines the output format.

Allowed:

filename

string

Base filename (without extension) to be downloaded.

archive

boolean

Determines whether the zip archive should be returned.

from

string

The start date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

to

string

The end date (for example, 2018-05-27T21:30:54+00:00). (For get request need encode url)

keyword

string

Search keyword to match all fields.

sort

string

Comma-separated list of fields to sort by. Each sort field can have special prefix indicating a desirable sort order: + (ascending order, default) or - (descending order). The available sort fields: createdAt,updatedAt,startedAt,duration.

companyId

integer

The company identifier.

taskId

string

The call task identifier.

id

string

The call identifier.

phone

string

Phone number.

status

string

Comma-separated list of enum statuses. Example- CANCEL,ANSWERED,NOANSWER,BUSY,CONGESTION,CHANUNAVAIL,FAILED,BLACKLIST,DIAL,INPROGRESS,FZ230,INVALID,UNAVAILABLE,EMPTY_AON

filterPeriodBy

string

Field for filtering by from and to. The available fields: createdAt,updatedAt,startedAt. Default - createdAt

Responses

400

Invalid input parameters

401

User is not authenticated

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json