Class SipCallsResource

Place and manage SIP calls.

Index

Constructors

Methods

create end get list switchRoom transfer

Constructors

constructor

new SipCallsResource(http: HttpClient): SipCallsResource
Parameters
- http: HttpClient
Returns SipCallsResource

Methods

create

create(options: CreateSipCallOptions): Promise<SipCall>
Place an outbound call.
Parameters
- options: CreateSipCallOptions
Returns Promise<SipCall>

end

end(callId: string): Promise<SipCall>
Hang up a call.
Parameters
- callId: string
Returns Promise<SipCall>

get

get(callId: string): Promise<SipCall>
Parameters
- callId: string
Returns Promise<SipCall>

list

list(params?: ListCallsParams): Promise<Page<SipCall>>
Parameters
- params: ListCallsParams = {}
Returns Promise<Page<SipCall>>

switchRoom

switchRoom(callId: string, options: SwitchRoomInput): Promise<SipCall>
Move an active SIP leg to another room.
Parameters
- callId: string
- options: SwitchRoomInput
Returns Promise<SipCall>

transfer

transfer(callId: string, options?: TransferSipCallInput): Promise<SipCall>
Cold-transfer an answered call.
Parameters
- callId: string
- options: TransferSipCallInput = {}
Returns Promise<SipCall>