RingCentral Office API Reference Index

Returns current API version(s) and server info.

Returns current API version info by apiVersion.

Returns current PAS service status.

Returns the list of users with their status of Automatic Location Updates feature.

Enables or disables Automatic Location Updates feature for multiple account users.

Returns account wireless points configured and used for Automatic Location Updates feature.

Creates a new wireless point in network configuration with the emergency address assigned.

Returns the specified wireless access point of a corporate map with the emergency address assigned.

Updates the specified wireless access point of a corporate map by ID.

Deletes wireless point(s) of a corporate map by ID(s).

Returns corporate networks map with emergency addresses assigned to the current account.

Creates a new network in corporate ethernet map for assignment of emergency addresses to network access points.

Returns the specified network with emergency addresses assigned to the current account.

Updates network in corporate ethernet map for assignment of emergency addresses to network access points.

Deletes network(s) in corporate ethernet map for Automatic Location Updates feature.

Returns the list of common devices with their status of Automatic Location Updates feature.

Enables or disables Automatic Location Updates feature for the specified common phones.

Returns corporate map of configured network switches with the assigned emergency addresses for the logged-in account.

Creates a new switch in corporate map based on chassis ID and used for Automatic Locations Update feature.

Returns the specified switch with the assigned emergency address.

Updates switch. Partial update is not supported, all switch parameters should be specified. If null value is received or parameter is missing, its value is removed.

Deletes wireless switch(es) in network configuration for Automatic Location Updates feature.

Creates multiple switches in corporate map. The maximum number of switches per request is 10 000; limitation for account is 10 000.

Updates multiple switches in corporate map. The maximum number of switches per request is 10 000; limitation for account is 10 000.

Creates multiple wireless points in corporate map. The maximum number of wireless points per request is 10 000; limitation for account is 70 000.

Updates wireless points in corporate map. The maximum number of wireless points per request is 10 000; limitation for account is 70 000.

Validates wireless points before creation or update. The maximum number of wireless points per request is 10 000.

Validates switches before creation or update. The maximum number of switches per request is 10 000.

Returns results of the task created within the frame of Automatic Location Updates feature. Currently four task types are supported: 'Wireless Points Bulk Create', 'Wireless Points Bulk Update', 'Switches Bulk Create', 'Switches Bulk Update'

Returns emergency response locations of the current account.

Returns emergency response location by ID

Updates the specified emergency response location.

Returns the user hours when the call handling rules are applied. Please note: If user hours are set to 'Custom hours' then a particular schedule is returned; however if set to '24 hours/7 days a week' an empty schedule is returned.

Updates the extension user hours when answering rules are to be applied.

Returns company hours when answering rules are to be applied.

Updates company hours when answering rules are to be applied.

Returns all calendar events created by the current user.

Creates a new calendar event.

Returns the specified calendar event(s) by ID(s).

Updates the specified calendar event.

Deletes the specified calendar event.

Creates a new calendar event within the specified group.

Returns a list of calendar events available for the current user within the specified group. Users can only see their personal tasks and public tasks.

Returns the current caller blocking settings of a user.

Updates the current caller blocking settings of a user.

Returns the lists of blocked and allowed phone numbers.

Updates either blocked or allowed phone number list with a new phone number.

Returns blocked or allowed phone number(s) by their ID(s). Batch request is supported.

Deletes blocked or allowed phone number(s) by their ID(s). Batch request is supported.

Updates blocked or allowed phone number(s) by their ID(s). Batch request is supported.

Creates a new outbound call out session.

Returns the status of a call session by ID.

Drops a call session.

Puts the party to stand-alone mode and starts to play Hold Music according to configuration & state to peers. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back.

Brings a party back into a call and stops to play Hold Music. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to unhold both endpoints to remove Hold Music and bring media back.

Rejects an inbound call in a "Setup" or "Proceeding" state

Ignores a call to a call queue agent in Setup or Proceeding state.

Transfers a party by placing a new call to the specified target

Answers a call on a certain device using this device identifier. Currently it is possible to answer an incoming call via this method after the following actions: call forward, call transfer or call flip.

Picks up a call parked to the specified park location.

Distributes a non-answered call to the defined target. Applicable for "Setup" or "Proceeding" states

Replies with text/pattern without picking up a call.

Performs call flip procedure by holding opposite party and calling to the specified target

Parks a call to a virtual location from where it can further be retrieved by any user from any phone of the system. The call session and call party identifiers should be specified in path. Currently the users can park only their own incoming calls. Up to 50 calls can be parked simultaneously. Park location starts with asterisk (*) and ranges 801-899.

Returns a party status of a call session by ID.

Modify the party of a call session by ID. There is a known limitation for Mute scenario - mute via REST API doesn't work with mute placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and Ringcentral Desktop app you need to unmute both endpoints to bring media back.

Starts a new call recording for the party

Pause/resume recording

Allows to monitor a call session in 'Listen' mode. Input parameters should contain internal identifiers of a monitored user and a supervisor's device. Call session should be specified in path. Please note that this method supports single channel audio flow, which means that audio of both call participants is mixed and delivered to the supervisor in single audio channel.

Allows to monitor a call party in 'Listen' mode. Input parameters are extension number of a monitored user and internal identifier of a supervisor's device. Call session and party identifiers should be specified in path. Please note that for this method dual channel audio flow is supported, which means that you need to make one more request for monitoring the second participant of a call. And as a result of each monitoring request the client recieves SIP invite with the following header p-rc-api-monitoring-ids containing IDs of the monitored party and session. The flow is supported for calls with no more than 2 participants.

Returns the list of extension phone numbers used for call forwarding and call flip. The returned list contains all the extension phone numbers used for call forwarding and call flip.

Adds a new forwarding number to the forwarding number list.

Returns a specific forwarding number.

Updates the existing forwarding number from the forwarding number list.

Deletes a forwarding number from the forwarding number list by its ID.

Returns call log records filtered by parameters specified.

Deletes filtered call log records.

Synchronizes call log records

Returns call log records by ID.

Returns records of all extension calls that are in progress, ordered by start time in descending order.

Returns call log records filtered by parameters specified.

Synchronizes company call log records.

Returns individual call log record(s) by ID(s). Batch request is supported.

Returns records of all calls that are in progress, ordered by start time in descending order.

Creates a new call monitoring group.

Returns call monitoring groups that can be filtered by some extension.

Updates call monitoring group name by ID.

Remove infromation about the given call monitoring group.

Returns call monitoring group members.

Updates call monitoring groups.

Returns call queue group list.

Returns call queue group members.

Updates a call queue group.

Updates the list of call queues where the user is an agent. This is a full update request, which means that if any queue where the user is an agent is not mentioned in request, then the user is automatically removed from this queue.

Viewing user account info (including name, business name, address and phone number/account number)

Adds and/or removes multiple call queue members

Returns call recordings by ID(s).

Returns media content of a call recording.

Creates an IVR prompt.

Returns the list of IVR prompts.

Returns an IVR prompt by ID.

Deletes an IVR prompt by ID.

Updates an IVR prompt by ID

Returns media content of an IVR prompt by ID.

Creates a company IVR menu.

Returns a company IVR menu by ID.

Updates a company IVR menu by ID.

Returns the list of chats where the user is a member and also public teams that can be joined. All records in response are sorted by creation time of a chat in ascending order.

Returns information about a chat by ID.

Returns recent chats where the user is a member. All records in response are sorted by the lastModifiedTime in descending order (the latest changed chat is displayed first on page)

Returns a list of the current user's favorite chats.

Adds the specified chat to the users's list of favorites.

Removes the specified chat from the users's list of favorites.

Sets the specified chat status to 'Read' for the current user.

Sets the specified chat status to 'Unread' for the current user.

Returns the list of groups where the user is a member.

Creates a new private chat/team.

Returns information about a group or multiple groups by their ID(s). Batch request is supported.

Updates group members. Please note: Only groups of 'Team' type can be updated. Currently only one operation at a time (either adding or removal) is supported.

Returns basic information about a particular RingCentral customer account.

Returns business address of a company.

Updates the business address of a company that account is linked to. Batch request is supported.

Returns the information about service plan, available features and limitations for a particular RingCentral customer account.

Returns the list of conversations where the user is a member. All records in response are sorted by creation time of a chat in ascending order.

Creates a new conversation or opens the existing one. If the conversation already exists, then its ID will be returned in response. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description. If you add a person to the existing conversation, it creates a whole new conversation.

Returns information about the specified conversation, including the list of conversation participants. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description. If you add a person to the existing conversation, it creates a whole new conversation.

Creates custom field attached to the object.

Returns the list of created custom fields.

Updates custom field by ID specified in path.

Deletes custom field(s) by ID(s) with the corresponding values.

Returns account device(s) by their ID(s).

Updates account device(s) by their ID(s).

Returns devices of the extension(s) by their ID(s). Batch request is supported

Returns the list of extensions created for a particular account. All types of extensions are included in this list.

Creates an extension.

Returns the list of user templates for the current account.

Returns the user template by ID.

Returns user personal contacts.

Creates personal user contact.

Returns contact(s) by ID(s). Batch request is supported.

Updates personal contact information by contact ID(s). Batch request is supported

Deletes contact(s) by ID(s). Batch request is supported.

Synchronizes user contacts.

Returns the list of favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records).

Updates the list of favorite contacts of the current extension. Favorite contacts include both company contacts (extensions) and personal contacts (address book records).Please note: currently personal address book size is limited to 10 000 contacts.

Creates and sends/resends a fax message. Resend can be implemented if sending has failed. Fax attachment size (both single and total) is limited to 50Mb.

Returns fax cover pages available for the current extension.

Returns the list of supported features and information on their availability for the current extension. Specific feature(s) might be checked by providing featureId query param. Multiple values supported, format: ?featureId=Feature1&featureId=Feature2. To get only available features in order to decrease response size, availableOnly=true query param might be specified. In case the feature is available for the current user, "available": true is returned in the response for the record with corresponding feature id. Otherwise, additional attribute reason is returned with the appropriate code: * ServicePlanLimitation - the feature not included to the account service plan; * AccountLimitation - the feature is turned off for the account; * ExtensionTypeLimitation - the feature is not applicable for the extension type; * ExtensionLimitation - the feature is not available for the extension, e.g., additional license required; * InsufficientPermissions - required permission not granted to the current user (not the one, who is specified in the URL, but the one who's access token is used); * ConfigurationLimitation - the feature is turned off for the extension, e.g., by the account administrator.

Also, some feature may have some additional parameters, e.g., limits, which are returned in params attribute as a name-value collection:

{
  "id": "HUD",
  "available": true,
  "params": [
    {
      "name": "limitMax",
      "value": "100"
    }
  ]
}

Creates a task for Glip data export and returns a link at which the exported data will be available in future once the task is implemented. The exported data can be downloaded by calling Get Data Export Task method with the specified task ID. Simultaneously no more than 2 tasks per company can be created.

Returns the list of Glip data export tasks.

Returns the links for downloading Glip data exported within the specified task. If the export task is still in progress, then only the task status will be returned. If the data is ready for downloading, then the list of URLs will be returned.

Returns the specified dataset by ID. Each dataset is a ZIP archive the size of which is limited to 1 Gb.

Returns a user or multiple users by their ID(s). Batch request is supported.

Returns information about one or more companies by their IDs.

Returns information about user preferences.

Creates a new webhook

Returns webhooks which are available for the current user by group ID.

Returns a list of all webhooks associated with the current account.

Returns webhooks(s) with the specified id(s).

Deletes the webhook by ID.

Activates webhook by ID.

Suspends webhook by ID.

Returns contact information on corporate users of federated accounts according to the specified filtering and ordering.

Returns contact information on a particular corporate user of a federated account.

Returns contact information on corporate users of federated accounts. Please note: 1. User, DigitalUser, VirtualUser and FaxUser types are returned as User type. 2. ApplicationExtension type is not returned. 3. Only extensions in Enabled, Disabled and NotActivated state are returned.

Returns information on a federation and associated accounts.

Returns information on dial-in numbers for meetings, support and international dial-in numbers URIs and meeting account information.

Updates personal meeting identifier.

Returns assistants information.

Returns assisted users information.

Returns a list of meetings for a particular extension. The list of meetings does not include meetings of 'Instant' type.

Creates a new meeting.

Returns a particular meetings details by ID.

Modifies a particular meeting.