Skip to main content
POST
Admin VR Logs

Authorizations

Authorization
string
header
required

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

Body

application/json
startDate
string
required

Start date for the report period

endDate
string
required

End date for the report period

tenantId
number

Tenant ID; lists events across all of its virtual receptionists

vrId
number

Single virtual receptionist ID (legacy; tenant is derived from it)

vrIds
number[]

Filter by virtual receptionist IDs

dialed
string[]

Filter by dialed key or extension

tag
string[]

Filter by call tags

Minimum array length: 1
callOutcome
number[]

Filter by call outcome IDs

Minimum array length: 1
reportType

Report type (Scheduled, Export, or Live)

Available options:
Scheduled
query
string

Search by caller number, name or dialed

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

VR logs or export acknowledgement

Paginated virtual receptionist logs

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