Sign in

v1

latestOpenAPI 3.0.02026-07-14201133.2 KB
Calls

Put call on hold

put/self/calls/{id}/hold

Path parameters

idstring required

Unique identifier of the call

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