Sign in

v1

latestOpenAPI 3.0.02026-07-14201133.2 KB
Events

List events

get/self/events

Query parameters

types'CALL'
Example:CALL

Record type

fromDateinteger

Return events that occurred after this point in time

toDateinteger

Return events that occurred before this point in time

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

Filter by event direction

states'INITIALIZING' | 'RINGING' | 'ACTIVE' | 'HELD' | 'REMOTE_HELD' | 'DETACHED' | 'REJECTED' | 'CANCELLED' | 'ANSWERED' | 'MISSED'
Example:ACTIVE,RINGING

Filter events by state

offsetinteger

Page number of events to return

sizeinteger

Return this amount of events in the response

order'DESC' | 'ASC'

Sort in either ascending or descending order'

sortstring

Sort events by property

Response

Successful

accountIdinteger required

Unique identifier of the account

answerTimestring date

Time to answer the event

callerIdstring

Remote caller ID

direction'INBOUND' | 'OUTBOUND' required

Direction of the event

durationinteger

Duration of the call in milliseconds

endTimestring date

End time of the event

externalIdstring

External identifier of the event

idinteger required

Unique identifier of the event

phoneNumberstring required

Unique identifier of the account

smsDatastring
startTimestring date required

Start time of the event

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

Status of the event

type'CALL' required

Record type

uciIdinteger required

Unique identifier of communications provider

userIdinteger required

Unique identifier of the user