Class Account

Hierarchy

UrlSection
- Account

Index

Constructors

constructor

Constructors

constructor

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

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

Methods

activeCalls

activeCalls(id?: string): ActiveCalls

- Defined in paths/Account.ts:47
Parameters
- Optional id: string
Returns ActiveCalls

answeringRule

answeringRule(id?: string): AnsweringRule

- Defined in paths/Account.ts:79
Internal identifier of an answering rule. The value can be standard digital ID or specific ID - either business-hours-rule or after-hours-rule

Parameters
- Optional id: string
Returns AnsweringRule

bot

bot(id?: string): Bot

- Defined in paths/Account.ts:61
Parameters
- Optional id: string
Returns Bot

businessAddress

businessAddress(id?: string): BusinessAddress

- Defined in paths/Account.ts:91
Parameters
- Optional id: string
Returns BusinessAddress

businessHours

businessHours(id?: string): BusinessHours

- Defined in paths/Account.ts:69
Parameters
- Optional id: string
Returns BusinessHours

callLog

callLog(id?: string): CallLog

- Defined in paths/Account.ts:39
Internal identifier of a call log record

Parameters
- Optional id: string
Returns CallLog

callLogSync

callLogSync(id?: string): CallLogSync

- Defined in paths/Account.ts:43
Parameters
- Optional id: string
Returns CallLogSync

department

department(id?: string): Department

- Defined in paths/Account.ts:115
Internal identifier of a Department extension (same as extensionId but only the ID of a department extension is valid)

Parameters
- Optional id: string
Returns Department

device

device(id?: string): Device

- Defined in paths/Account.ts:103
Parameters
- Optional id: string
Returns Device

directory

directory(id?: string): Directory

- Defined in paths/Account.ts:57
Parameters
- Optional id: string
Returns Directory

extension

extension(id?: string): Extension

- Defined in paths/Account.ts:33
Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session

Parameters
- Optional id: string
Returns Extension

get

get(): Promise<GetAccountInfoResponse>

- Defined in paths/Account.ts:130
Since 1.0.0
Returns basic information about a particular RingCentral customer account.
Required Permissions
Permission Description
ReadAccounts Viewing user account info (including name, business name, address and phone number/account number)
Usage Plan Group
Light

Returns Promise<GetAccountInfoResponse>

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

greeting

greeting(id?: string): Greeting

- Defined in paths/Account.ts:73
Parameters
- Optional id: string
Returns Greeting

ivrMenus

ivrMenus(id?: string): IvrMenus

- Defined in paths/Account.ts:83
Parameters
- Optional id: string
Returns IvrMenus

ivrPrompts

ivrPrompts(id?: string): IvrPrompts

- Defined in paths/Account.ts:87
Parameters
- Optional id: string
Returns IvrPrompts

licenses

licenses(id?: string): Licenses

- Defined in paths/Account.ts:109
Internal identifier of a license

Parameters
- Optional id: string
Returns Licenses

pagingOnlyGroups

pagingOnlyGroups(id?: string): PagingOnlyGroups

- Defined in paths/Account.ts:119
Parameters
- Optional id: string
Returns PagingOnlyGroups

parkLocations

parkLocations(id?: string): ParkLocations

- Defined in paths/Account.ts:123
Parameters
- Optional id: string
Returns ParkLocations

phoneNumber

phoneNumber(id?: string): PhoneNumber

- Defined in paths/Account.ts:99
Parameters
- Optional id: string
Returns PhoneNumber

presence

presence(id?: string): Presence

- Defined in paths/Account.ts:65
Parameters
- Optional id: string
Returns Presence

recording

recording(id?: string): Recording

- Defined in paths/Account.ts:53
Internal identifier of a recording (returned in Call Log)

Parameters
- Optional id: string
Returns Recording

serviceInfo

serviceInfo(id?: string): ServiceInfo

- Defined in paths/Account.ts:95
Parameters
- Optional id: string
Returns ServiceInfo

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