Class VoiceV2CallsApi

Index

Methods

get interactByCallId interactByCallName list start

Methods

get

get(data: GetCallByIdRequestData): Promise<Voice.v2.Call>
Retrieve call details by call ID Retrieve detailed information about a specific call using its unique identifier.
Parameters
- data: GetCallByIdRequestData
  The data to provide to the API call.
Returns Promise<Voice.v2.Call>

interactByCallId

interactByCallId(data: PatchCallByIdRequestData): Promise<void>
Patch an ongoing call by call ID Interact with an ongoing call by submitting a set of SVAML commands. Use this to force disconnect, play messages, bridge with another call, or perform other call control actions.
Parameters
- data: PatchCallByIdRequestData
  The data to provide to the API call.
Returns Promise<void>

interactByCallName

interactByCallName(data: PatchCallBySessionAndNameRequestData): Promise<void>
Patch an ongoing call by session ID and call name Interact with an ongoing call identified by its session and call name by submitting a set of SVAML commands. Use this to force disconnect, play messages, bridge with another call, or perform other call control actions.
Parameters
- data: PatchCallBySessionAndNameRequestData
  The data to provide to the API call.
Returns Promise<void>

list

list(data?: ListCallsRequestData): ApiListPromise<Voice.v2.Call>
List calls made with Sinch Voice API List and filter calls made with Sinch
Parameters
- Optionaldata: ListCallsRequestData
  The data to provide to the API call.
Returns ApiListPromise<Voice.v2.Call>

start

start(data: CreateCallRequestData): Promise<CallResponse>
Create and initiate an outbound voice call Create a new outbound call associated to the project's default service or to the service specified in the serviceId query parameter. For a batch of outbound call sessions, use voice.v2.batches.start instead.
Parameters
- data: CreateCallRequestData
  The data to provide to the API call.
Returns Promise<CallResponse>