🔐 – advanced – API available by request, if you want to use it please welcome to Support page.

⚠️ – please pay attention to this change as it may potentially break compatibility with your app.

⭐️ – new API methods inroduced.

🔧 – bug fixes.

Basepath for all URLs: https://platform.ringcentral.com/restapi/v1.0.

Account

Company: Account Limitations

  • new limits response attribute added.
Changed Methods
GET /account/{accountId}

⚠️ Service Features: Shared Lines

  • new SharedLines value supported for serviceFeatures[].featureName response attribute.
Changed Methods
GET /account/{accountId}
GET /account/{accountId}/service-info
GET /account/{accountId}/extension/{extensionId}

Address Book

Internal Contacts: Extension Phone Number Labels

  • label attribute supported for any phone number.
Changed Methods
PUT /account/{accountId}/phone-number/{numberId}

Call Handling

⚠️ 🔧 Rule Management: Custom Answering Rules Creation Limitation for Specific Extension Types

  • new error code AWR-191 introduced: "Custom rules not supported for the extension type [extensionType]" (Announcement, Voicemail, SharedLinesGroup, PagingOnly, Limited).
Changed Methods
POST /account/{accountId}/extension/{extensionId}/answering-rule
  • new error code AWR-192 inroduced: "After hours rules not supported for the extension type [extensionType]" (Announcement, Voicemail, SharedLinesGroup, PagingOnly, Limited).
Changed Methods
PUT /account/{accountId}/extension/{extensionId}/business-hours
  • new error code AWR-193 introduced: "Answering rules not supported for the extension type [ParkLocation]".
Changed Methods
POST /account/{accountId}/extension/{extensionId}/answering-rule
GET /account/{accountId}/extension/{extensionId}/answering-rule
GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
DELETE /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
PUT /account/{accountId}/extension/{extensionId}/business-hours

Call History

Call Fail Reason

  • new records[].reason and records[].legs[].reason response attributes added.
Changed Methods
GET /account/{accountId}/active-calls
GET /account/{accountId}/call-log
GET /account/{accountId}/extension/{extensionId}/active-calls
GET /account/{accountId}/extension/{extensionId}/call-log
GET /account/{accountId}/extension/{extensionId}/call-log-sync

Deleted Call Log Records in ISync

  • new showDeleted query parameter supported;
  • new records[].deleted response attribute added.
Changed Methods
GET /account/{accountId}/extension/{extensionId}/call-log-sync

Events & Notifications

🔧 Subscription Renewal

  • expiresIn is not changed to default value on subscription renewal
Changed Methods
POST /account/{accountId}/subscription/{subscriptionId}/renew

Localization

Region Names Translation

  • translated values returned for country.name, state.name, countryName and stateName attributes according to current user language setting or Accept-Language header value.
Changed Methods
Regional Settings:
GET /dictionary/country
GET /dictionary/country/{countryId}
GET /dictionary/state
GET /dictionary/state/{stateId}
Company Settings:
GET /account/{accountId}
GET /account/{accountId}/business-address
🔐 PUT /account/{accountId}/business-address
User Settings:
GET /account/{accountId}/extension/{extensionId}/conferencing
PUT /account/{accountId}/extension/{extensionId}/conferencing
Meetings:
GET /account/{accountId}/extension/{extensionId}/meeting/service-info
Account Provisioning/Extensions:
🔐 POST /account/{accountId}/extension
GET /account/{accountId}/extension/{extensionId}
PUT /account/{accountId}/extension/{extensionId}
Account Provisioning/Devices:
GET /account/{accountId}/device/{deviceId}
🔐 PUT /account/{accountId}/device/{deviceId}
GET /account/{accountId}/extension/{extensionId}/device
Account Provisioning/Phone Parsing:
POST /number-parser/parse

Message History

Bulk Message Operations Using JSON

  • application/vnd.ringcentral.multipart+json (JSON) request/response formats supported for bulk operations
Changed Methods
GET /account/{accountId}/extension/{extensionId}/message-store/{messageIds}
PUT /account/{accountId}/extension/{extensionId}/message-store/{messageIds}
DELETE /account/{accountId}/extension/{extensionId}/message-store/{messageIds}

🔧 Fax & Voicemail Sender/Recipient Locations

  • to[].location and from.location attribute added to push notification payload
Changed Notification Payloads
/restapi/v1.0/account/{accountId}/extension/{extensionId}/fax?direction=Inbound
/restapi/v1.0/account/{accountId}/extension/{extensionId}/voicemail

🔧 Voicemail Transcription Metadata

  • attachments now contains transcription attachment metadata (type: AudioTranscription)
Changed Notification Payloads
/restapi/v1.0/account/{accountId}/extension/{extensionId}/voicemail

Provisioning

Call Monitoring Groups Management

  • removing the members by specifying the extension with empty permission set supported.
Changed Methods
POST /restapi/v1.0/account/{accountId}/call-monitoring-groups/{groupId}/bulk-assign

Devices: Emergency Address Sync Status

  • new syncEmergencyAddress query parameter supported;
  • new emergencyServiceAddress.syncStatus response attribute added.
Changed Methods
GET /account/{accountId}/device/{deviceId}

Outbound Call Prefix

  • new outboundCallPrefix response attribute added.
Changed Methods
GET /account/{accountId}

⚠️ Paging Only Groups Provisioning

  • app permission required changed to EditAccounts;
  • user permission required changed to Groups.
Changed Methods
🔐 POST /restapi/v1.0/account/{accountId}/paging-only-groups/{pagingOnlyGroupId}/bulk-assign

Shared Lines on Personal Devices: Caller ID

  • Shared Line Group direct number is allowed to be set as Caller ID for user who has personal device added as a part of the SLG.
Changed Methods
GET /account/{accountId}/extension/{extensionId}/caller-id
PUT /account/{accountId}/extension/{extensionId}/caller-id
POST /account/{accountId}/extension/{extensionId}/ring-out
  • Shared Line Group direct numbers returned for user extension if the user has personal device added as a part of the SLG.
Changed Methods
GET /account/{accountId}/extension/{extensionId}/phone-number

SMS

⚠️ 🔧 Incorrect Error Code when Sending International SMS from a Toll Free Number

  • new error code MSG-403 introduced: "International SMS is not allowed from Toll Free phone number".
Changed Methods
POST /account/{accountId}/extension/{extensionId}/sms

Telephony/Voice

Call Control

⭐️ Call Out
New Methods
🔐 POST /account/{accountId}/telephony/sessions/call-out
⭐️ Supervise Call
New Methods
🔐 POST /account/{accountId}/telephony/sessions/{sessionId}/supervise

Presence: Sequence ID in Change Event

  • sequence attribute added to notification payload.
Changed Notification Payloads
/restapi/v1.0/account/{accountId}/extension/{extensionId}/presence