Class RingOut

Hierarchy

UrlSection
- RingOut

Index

Constructors

constructor

Methods

Constructors

constructor

new RingOut(prv: PathSegment, id?: string, service?: any): RingOut

Overrides UrlSection.constructor
- Defined in paths/RingOut.ts:6
Parameters
- prv: PathSegment
- Optional id: string
- Optional service: any
Returns RingOut

Methods

delete

delete(): Promise<void>

- Defined in paths/RingOut.ts:40
Cancels the 2-leg RingOut call.
Required Permissions
Permission Description
RingOut Performing two-legged ring-out phone calls
Usage Plan Group
Heavy

Returns Promise<void>

get

get(): Promise<GetRingOutStatusResponse>

- Defined in paths/RingOut.ts:27
Since 1.0.7 (Release 5.16)
Returns the status of a 2-leg RingOut call.
Required Permissions
Permission Description
RingOut Performing two-legged ring-out phone calls
Usage Plan Group
Light

Returns Promise<GetRingOutStatusResponse>

getEndpoint

getEndpoint(withValue?: boolean): string

Inherited from UrlSection.getEndpoint
- Defined in PathSegment.ts:26
Parameters
- Default value withValue: boolean = true
Returns string

Protected getRest

getRest(): RestClient

Inherited from UrlSection.getRest
- Defined in PathSegment.ts:34
Returns RestClient

post

post(body: MakeRingOutRequest): Promise<GetRingOutStatusResponse>

- Defined in paths/RingOut.ts:14
Since 1.0.7 (Release 5.16)
Makes a 2-leg RingOut call.
Required Permissions
Permission Description
RingOut Performing two-legged ring-out phone calls
Usage Plan Group
Heavy

Parameters
- body: MakeRingOutRequest
Returns Promise<GetRingOutStatusResponse>

toString

toString(withValue?: boolean): string

Inherited from UrlSection.toString
- Defined in PathSegment.ts:18
Parameters
- Default value withValue: boolean = true
Returns string

Generated using TypeDoc