Sign in
latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB

8d602198ec97

Extensions

Create Extension

Creates an extension.

post/restapi/v1.0/account/{accountId}/extension

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

Request body

extensionNumberstring

Extension short number

passwordstring

Password for extension. If not specified, the password is auto-generated

partnerIdstring

Additional extension identifier, created by partner application and applied on client side

ivrPinstring

IVR PIN

setupWizardState'NotStarted' | 'Incomplete' | 'Completed'

Initial configuration wizard state

status'Enabled' | 'Disabled' | 'NotActivated' | 'Unassigned' | 'Frozen'

Extension current state

type'User' | 'VirtualUser' | 'DigitalUser' | 'FlexibleUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'ParkLocation' | 'Limited'

Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology

hiddenboolean

Hides extension from showing in company directory. Supported for extensions of 'User' type only. For unassigned extensions the value is set to true by default. For assigned extensions the value is set to false by default

Response

Created extension information

idinteger

Internal identifier of an extension

uristring uri

Canonical URI of an extension

extensionNumberstring

Extension number

namestring

Extension name. For user extension types the value is a combination of the specified first name and last name

partnerIdstring

For Partner Applications Internal identifier of an extension created by partner. The RingCentral supports the mapping of accounts and stores the corresponding account ID/extension ID for each partner ID of a client application. In request URIs partner IDs are accepted instead of regular RingCentral native IDs as path parameters using pid=XXX clause. Though in response URIs contain the corresponding account IDs and extension IDs. In all request and response bodies these values are reflected via partnerId attributes of account and extension

setupWizardState'NotStarted' | 'Incomplete' | 'Completed'

Initial configuration wizard state

status'Enabled' | 'Disabled' | 'Frozen' | 'NotActivated' | 'Unassigned'

Extension current state. If 'Unassigned' is specified, then extensions without extensionNumber are returned. If not specified, then all extensions are returned

type'User' | 'VirtualUser' | 'DigitalUser' | 'FlexibleUser' | 'Department' | 'Announcement' | 'Voicemail' | 'SharedLinesGroup' | 'PagingOnly' | 'ParkLocation' | 'Limited'

Extension type. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology

hiddenboolean

Hides an extension from showing in company directory. Supported for extensions of 'User' type only