Skip to main content
POST
Admin Call Logs

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
tenantId
number
required

Tenant ID

startDate
string
required

Start date for the report period

endDate
string
required

End date for the report period

direction

Call direction filter (IN or OUT)

Available options:
IN
tag
string[]

Filter by call tags

Minimum array length: 1
callOutcome
number[]

Filter by call outcome IDs

Minimum array length: 1
users

Filter by user peer names, or 'ALL' for all users

groups
object[]

Filter by groups (queue, huntlist, or branch)

reportType

Report type (Scheduled, Export, or Live)

Available options:
Scheduled
recorded
boolean

Filter by recorded calls only

cidNum
string

Filter by caller ID number

query
string

Search calls by caller/dialed number or name

paginated
integer
default:1

1 = paginated response, 0 = full list

Required range: 0 <= x <= 1
page
number

Page number

recordsPerPage
number

Records per page

sortBy
string

Sort column

Maximum string length: 50
sortDirection
enum<string>

Sort direction

Available options:
asc,
desc

Response

200 - application/json

Paginated call logs or export acknowledgement

Paginated call logs

records
object[]
required
page
number
required
maxPage
number
required
totalRecords
number
required