Class SipApi

SipApi - object-oriented interface

Export

SipApi

Hierarchy

BaseAPI
- SipApi

Index

Constructors

Properties

axios basePath configuration

Methods

Constructors

constructor

new SipApi(configuration?, basePath?, axios?): SipApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns SipApi
Inherited from BaseAPI.constructor
- Defined in openapi/base.ts:53

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

dial

dial(roomId, componentId, dialConfig?, options?): Promise<AxiosResponse<void, any>>
Parameters
- roomId: string
  Room ID
- componentId: string
  SIP Component ID
- Optional dialConfig: DialConfig
  Phone Number configuration
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Make a call from the SIP component to the provided phone number

Throws
Memberof
SipApi
- Defined in openapi/api.ts:2469

endCall

endCall(roomId, componentId, options?): Promise<AxiosResponse<void, any>>
Parameters
- roomId: string
  Room ID
- componentId: string
  SIP Component ID
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Summary
Finish call made by SIP component

Throws
Memberof
SipApi
- Defined in openapi/api.ts:2482