Class CallsResource

Index

Constructors

Methods

create list get count update delete redirect whisper mute

Constructors

constructor

new CallsResource(http: HttpClient, accountSid: string): CallsResource
Parameters
- http: HttpClient
- accountSid: string
Returns CallsResource
- Defined in src/client/api.ts:82

Methods

create

create(opts: CreateCallRequest): Promise<string>
Create a new outbound call.
Parameters
- opts: CreateCallRequest
Returns Promise<string>
- Defined in src/client/api.ts:85

list

list(filter?: ListCallsFilter): Promise<CallInfo[]>
List active calls, optionally filtered.
Parameters
- Optionalfilter: ListCallsFilter
Returns Promise<CallInfo[]>
- Defined in src/client/api.ts:94

get

get(callSid: string): Promise<CallInfo>
Get info about an active call.
Parameters
- callSid: string
Returns Promise<CallInfo>
- Defined in src/client/api.ts:107

count

count(): Promise<CallCount>
Get count of active inbound and outbound calls.

Returns Promise<CallCount>
- Defined in src/client/api.ts:114

update

update(callSid: string, opts: UpdateCallRequest): Promise<void>
Update an active call (redirect, mute, hangup, etc).
Parameters
- callSid: string
- opts: UpdateCallRequest
Returns Promise<void>
- Defined in src/client/api.ts:121

delete

delete(callSid: string): Promise<void>
Terminate a call.
Parameters
- callSid: string
Returns Promise<void>
- Defined in src/client/api.ts:129

redirect

redirect(callSid: string, hook: ActionHook): Promise<void>
Redirect call execution to a new webhook URL.
Parameters
- callSid: string
- hook: ActionHook
Returns Promise<void>
- Defined in src/client/api.ts:136

whisper

whisper(callSid: string, verb: Verb): Promise<void>
Inject a whisper verb (say/play) to one party on the call.
Parameters
- callSid: string
- verb: Verb
Returns Promise<void>
- Defined in src/client/api.ts:141

mute

mute(callSid: string, status: "mute" | "unmute"): Promise<void>
Mute or unmute a call.
Parameters
- callSid: string
- status: "mute" | "unmute"
Returns Promise<void>
- Defined in src/client/api.ts:146