SIPOutboundApi

SIPOutboundApi - object-oriented interface

Export

SIPOutboundApi

Extends

  • BaseAPI

Constructors

new SIPOutboundApi()

new SIPOutboundApi(configuration?, basePath?, axios?): SIPOutboundApi

Parameters

configuration?

basePath?

string = BASE_PATH

axios?

AxiosInstance = globalAxios

Returns

Inherited from

BaseAPI.constructor

Properties

axios

protected axios: AxiosInstance = globalAxios

Inherited from

BaseAPI.axios


basePath

protected basePath: string = BASE_PATH

Inherited from

BaseAPI.basePath


configuration

protected configuration: undefined | Configuration

Inherited from

BaseAPI.configuration

Methods

apiV1SipOutboundByNameGet()

apiV1SipOutboundByNameGet(name, options?): Promise<AxiosResponse<SIPOutboundResponseDTO>>

Parameters

name

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SIPOutboundResponseDTO>>

Throws

Memberof

SIPOutboundApi


apiV1SipOutboundGet()

apiV1SipOutboundGet(skip?, take?, options?): Promise<AxiosResponse<SIPOutboundResponseDTO[]>>

Parameters

skip?

number

take?

number

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SIPOutboundResponseDTO[]>>

Throws

Memberof

SIPOutboundApi


apiV1SipOutboundIdDelete()

apiV1SipOutboundIdDelete(id, options?): Promise<AxiosResponse<void>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<void>>

Throws

Memberof

SIPOutboundApi


apiV1SipOutboundIdGet()

apiV1SipOutboundIdGet(id, options?): Promise<AxiosResponse<SIPOutboundResponseDTO>>

Parameters

id

string

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SIPOutboundResponseDTO>>

Throws

Memberof

SIPOutboundApi


apiV1SipOutboundIdPatch()

apiV1SipOutboundIdPatch(id, sIPOutboundPatchDTO?, options?): Promise<AxiosResponse<SIPOutboundResponseDTO>>

Parameters

id

string

sIPOutboundPatchDTO?

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SIPOutboundResponseDTO>>

Throws

Memberof

SIPOutboundApi


apiV1SipOutboundPost()

apiV1SipOutboundPost(sIPOutboundAddDTO?, options?): Promise<AxiosResponse<SIPOutboundResponseDTO>>

Parameters

sIPOutboundAddDTO?

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SIPOutboundResponseDTO>>

Throws

Memberof

SIPOutboundApi


apiV1SipOutboundReportsGet()

apiV1SipOutboundReportsGet(fromCreatedTime?, toCreatedTime?, fromStatus?, toStatus?, skip?, take?, options?): Promise<AxiosResponse<SIPReportResponseDTO[]>>

Parameters

fromCreatedTime?

string

toCreatedTime?

string

fromStatus?

number

toStatus?

number

skip?

number

take?

number

options?

RawAxiosRequestConfig

Override http request option.

Returns

Promise<AxiosResponse<SIPReportResponseDTO[]>>

Throws

Memberof

SIPOutboundApi

Found a mistake? Let us know.

Enroll in beta

Request invite to our private Beta program for developers to join the waitlist. No spam, we promise.