Class CallerId

Hierarchy

UrlSection
- CallerId

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

get

get(): Promise<ExtensionCallerIdInfo>

- Defined in paths/CallerId.ts:13
Since 1.0.28 (Release 8.4)
Returns information on an outbound caller ID of an extension.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
API Group
Light

Returns Promise<ExtensionCallerIdInfo>

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

put

put(body: ExtensionCallerIdInfo): Promise<ExtensionCallerIdInfo>

- Defined in paths/CallerId.ts:26
Since 1.0.28 (Release 8.4)
Updates outbound caller ID information of an extension.
Required Permissions
Permission Description
EditExtensions Viewing and updating my extension info (includes extension name, number, email and phone number)
API Group
Medium

Parameters
- body: ExtensionCallerIdInfo
Returns Promise<ExtensionCallerIdInfo>

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