Class OutboundTrunkResource

Outbound SIP trunks — connections used to place calls to a SIP host.

Index

Constructors

Methods

create delete get list update

Constructors

constructor

new OutboundTrunkResource(http: HttpClient): OutboundTrunkResource
Parameters
- http: HttpClient
Returns OutboundTrunkResource

Methods

create

create(options: CreateOutboundTrunkOptions): Promise<SipTrunk>
Parameters
- options: CreateOutboundTrunkOptions
Returns Promise<SipTrunk>

delete

delete(trunkId: string): Promise<MessageResponse>
Parameters
- trunkId: string
Returns Promise<MessageResponse>

get

get(trunkId: string): Promise<SipTrunk>
Parameters
- trunkId: string
Returns Promise<SipTrunk>

list

list(params?: ListTrunksParams): Promise<Page<SipTrunk>>
Parameters
- params: ListTrunksParams = {}
Returns Promise<Page<SipTrunk>>

update

update(trunkId: string, options: UpdateOutboundTrunkOptions): Promise<SipTrunk>
Update an outbound trunk. This is a partial update: omitted fields keep their current value, EXCEPT record, noiseCancellation and enableDtmf, which reset to false when omitted, and geoRegion, which is cleared. Send the complete desired state.
Parameters
- trunkId: string
- options: UpdateOutboundTrunkOptions
Returns Promise<SipTrunk>