Class AnsweringRule

Hierarchy

UrlSection
- AnsweringRule

Index

Constructors

constructor

Methods

Constructors

constructor

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

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

Methods

delete

delete(): Promise<void>

- Defined in paths/AnsweringRule.ts:50
Returns Promise<void>

get

get(query?: GetQuery): Promise<void>

- Defined in paths/AnsweringRule.ts:16
Since 1.0.15 (Release 7.0)
Returns the extension answering rules.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
Usage Plan Group
Light

Parameters
- Optional query: GetQuery
Returns Promise<void>

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

list

list(): Promise<CompanyAnsweringRuleList>

- Defined in paths/AnsweringRule.ts:61
Since 1.0.31 (Release 9.2)
Returns a list of company answering rules.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
API Group
Medium

Returns Promise<CompanyAnsweringRuleList>

post

post(body: CreateAnsweringRuleRequest): Promise<AnsweringRuleInfo>

- Defined in paths/AnsweringRule.ts:27
Since 1.0.24 (Release 8.0)
Creates a custom answering rule for a particular caller ID.
Required Permissions
Permission Description
EditExtensions Viewing and updating my extension info (includes extension name, number, email and phone number)
Usage Plan Group
Medium

Parameters
- body: CreateAnsweringRuleRequest
Returns Promise<AnsweringRuleInfo>

put

put(body: UpdateAnsweringRuleRequest): Promise<AnsweringRuleInfo>

- Defined in paths/AnsweringRule.ts:40
Since 1.0.24 (Release 8.0)
Updates a custom answering rule for a particular caller ID.
Required Permissions
Permission Description
EditExtensions Viewing and updating my extension info (includes extension name, number, email and phone number)
Usage Plan Group
Medium

Parameters
- body: UpdateAnsweringRuleRequest
Returns Promise<AnsweringRuleInfo>

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