Sign in

v1

latestOpenAPI 3.0.02026-07-14201133.2 KB
Calls

List active calls

Lists currently active calls

get/self/calls

Query parameters

fromDateinteger

Return calls that occurred after this point in time

toDateinteger

Return calls that occurred before this point in time

direction'INBOUND' | 'OUTBOUND'
Example:INBOUND,OUTBOUND

Filter by call direction. For multiple criteria, seperate values by a comma.

states'INITIALIZING' | 'RINGING' | 'ACTIVE' | 'HELD' | 'REMOTE_HELD'
Example:ACTIVE,RINGING

Filter calls by state. For multiple criteria, seperate values by a comma.

offsetinteger

Page number of calls to return

sizeinteger

Return this amount of calls in the response

order'DESC' | 'ASC'

Sort in either ascending or descending order

sortstring

Sort calls by property

Response

Successful

accountIdinteger required

Unique identifier of the account

answerTimestring date

Time to answer the call

callerIdstring

Remote caller ID

direction'INBOUND' | 'OUTBOUND' required

Direction of the call

durationinteger required

Duration of the call in milliseconds

endTimestring date

End time of the call

externalIdstring

External identifier of the call

idinteger required

Unique identifier of the call

phoneNumberstring required

Unique identifier of the account

startTimestring date required

Start time of the call

state'INITIALIZING' | 'RINGING' | 'ACTIVE' | 'HELD' | 'REMOTE_HELD' | 'DETACHED' | 'REJECTED' | 'CANCELLED' | 'ANSWERED' | 'MISSED' required

Status of the call

type'CALL' required

Record type

uciIdinteger required

Unique identifier of communications provider

userIdinteger required

Unique identifier of the user