SIPEndpointApi
SIPEndpointApi - object-oriented interface
Export
SIPEndpointApi
Extends
BaseAPI
Constructors
new SIPEndpointApi()
new SIPEndpointApi(
configuration
?,basePath
?,axios
?):SIPEndpointApi
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
apiV1SipEndpointByNameGet()
apiV1SipEndpointByNameGet(
name
,options
?):Promise
<AxiosResponse
<SIPEndpointResponseDTO
>>
Parameters
name
string
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<SIPEndpointResponseDTO
>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointCapacityByAliasGet()
apiV1SipEndpointCapacityByAliasGet(
alias
,options
?):Promise
<AxiosResponse
<LimitsByApplicationGroupDTO
>>
Parameters
alias
string
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<LimitsByApplicationGroupDTO
>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointCapacityEndpointIdGet()
apiV1SipEndpointCapacityEndpointIdGet(
endpointId
,options
?):Promise
<AxiosResponse
<LimitsByApplicationGroupDTO
>>
Parameters
endpointId
string
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<LimitsByApplicationGroupDTO
>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointGet()
apiV1SipEndpointGet(
skip
?,take
?,options
?):Promise
<AxiosResponse
<SIPEndpointResponseDTO
[]>>
Parameters
skip?
number
take?
number
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<SIPEndpointResponseDTO
[]>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointIdDelete()
apiV1SipEndpointIdDelete(
id
,options
?):Promise
<AxiosResponse
<void
>>
Parameters
id
string
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<void
>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointIdGet()
apiV1SipEndpointIdGet(
id
,options
?):Promise
<AxiosResponse
<SIPEndpointResponseDTO
>>
Parameters
id
string
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<SIPEndpointResponseDTO
>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointIdPatch()
apiV1SipEndpointIdPatch(
id
,sIPEndpointPatchDTO
?,options
?):Promise
<AxiosResponse
<SIPEndpointResponseDTO
>>
Parameters
id
string
sIPEndpointPatchDTO?
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<SIPEndpointResponseDTO
>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointPost()
apiV1SipEndpointPost(
sIPEndpointAddDTO
?,options
?):Promise
<AxiosResponse
<SIPEndpointResponseDTO
>>
Parameters
sIPEndpointAddDTO?
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<SIPEndpointResponseDTO
>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointReportsEndpointIdGet()
apiV1SipEndpointReportsEndpointIdGet(
endpointId
,fromCreatedTime
?,toCreatedTime
?,fromStatus
?,toStatus
?,skip
?,take
?,options
?):Promise
<AxiosResponse
<SIPReportResponseDTO
[]>>
Parameters
endpointId
string
fromCreatedTime?
string
toCreatedTime?
string
fromStatus?
number
toStatus?
number
skip?
number
take?
number
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<SIPReportResponseDTO
[]>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointReportsGet()
apiV1SipEndpointReportsGet(
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
SIPEndpointApi
apiV1SipEndpointReportsStatusGet()
apiV1SipEndpointReportsStatusGet(
fromCreatedTime
?,toCreatedTime
?,fromStatus
?,toStatus
?,options
?):Promise
<AxiosResponse
<number
>>
Parameters
fromCreatedTime?
string
toCreatedTime?
string
fromStatus?
number
toStatus?
number
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<number
>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointStatusByAliasGet()
apiV1SipEndpointStatusByAliasGet(
alias
,errorsThreshold
?,options
?):Promise
<AxiosResponse
<void
>>
Parameters
alias
string
errorsThreshold?
number
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<void
>>
Throws
Memberof
SIPEndpointApi
apiV1SipEndpointStatusEndpointIdGet()
apiV1SipEndpointStatusEndpointIdGet(
endpointId
,errorsThreshold
?,options
?):Promise
<AxiosResponse
<void
>>
Parameters
endpointId
string
errorsThreshold?
number
options?
RawAxiosRequestConfig
Override http request option.
Returns
Promise
<AxiosResponse
<void
>>
Throws
Memberof
SIPEndpointApi