Skip to main content
GET
List calls

Authorizations

Authorization
string
header
required

JWT Bearer token. Obtain a token via your identity provider and pass it in the Authorization: Bearer <token> header.

Scopes

REAL_CALL_READ_ACCESS

Query Parameters

page
integer
default:0

Zero-based page index.

Required range: 0 <= x <= 100000
Example:

0

pageSize
integer
default:30

Items per page.

Required range: 1 <= x <= 100
Example:

30

Case-insensitive substring match against the file name, or an exact, case-sensitive match against the SIP call id.

Maximum string length: 256
Example:

"a1b2c3"

conclusion
enum<string>[]

Filter by conclusion. Repeatable: pass the parameter once per value to match any of them.

Conclusions you can filter the call list by.

Available options:
AUTHENTIC,
SUSPICIOUS,
MANIPULATED,
INCONCLUSIVE
callDirection
enum<string>[]

Filter by call direction. Repeatable: pass the parameter once per value to match any of them.

Direction of the call relative to the organization. UNKNOWN when the integration did not report one.

Available options:
INBOUND,
OUTBOUND,
UNKNOWN
status
enum<string>

Filter by processing state. Processing state of the stream.

Available options:
COMPLETED,
PROCESSING
Example:

"COMPLETED"

originalFileId
string

Returns the call created from this uploaded file. The call is created asynchronously after the simulate request, so items is empty until it is ready; poll until it appears. Globally unique ID built to be chronologically sortable by timestamp

Example:

"2nYn7qqkM5678Ks99ykvmZAr7pz"

sortBy
enum<string>

Field to sort by. The server defaults to CALL_TIME when omitted. Field to sort the call list by.

Available options:
CALL_TIME,
CONCLUSION,
TIME_TO_CONCLUSION
Example:

"CALL_TIME"

sortDirection
enum<string>

Sort order.

Available options:
ASC,
DESC
Example:

"ASC"

Response

A page of calls.

Paged list of calls.

items
object[]
required
pagination
object
required

Page-based pagination metadata.