🔐 – 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.

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

New Resources

Method Resource Description
GET /account/{accountId}/call-recording [Beta] Retrieval of call recording settings
🔐 PUT /account/{accountId}/call-recording [Beta] Update of call recording settings
GET /account/{accountId}/call-recording/extensions [Beta] Retrieval of extensions list to be recorded
🔐 POST /account/{accountId}/call-recording/bulk-assign [Beta] Creation and update of extensions list to be recorded
GET /account/{accountId}/extension/{extensionId}/caller-blocking [Beta] Retrieval of user call blocking settings
PUT /account/{accountId}/extension/{extensionId}/caller-blocking [Beta] Update of user call blocking settings
GET /account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers [Beta] Retrieval of blocked/allowed phone numbers
POST /account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers [Beta] Update of blocked/allowed phone numbers
GET /account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{numberId} [Beta] Retrieval of a blocked/allowed phone number
PUT /account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{numberId} [Beta] Update of a blocked/allowed phone number
DELETE /account/{accountId}/extension/{extensionId}/caller-blocking/phone-number/{numberId} [Beta] Deletion of a blocked/allowed phone number
GET /account/{accountId}/extension/{extensionId}/email-to-fax [Beta]Retrieval of user settings for sending fax by email
PUT /account/{accountId}/extension/{extensionId}/email-to-fax [Beta] Update of user settings for sending fax by email
POST /account/{accountId}/extension/{extensionId}/greeting-recording-call [Beta] Making calls to record custom user greetings
GET /account/{accountId}/extension/{extensionId}/greeting-recording-call/{callId} [Beta] Retrieval of user greeting recording call
DELETE /account/{accountId}/extension/{extensionId}/greeting-recording-call/{callId} [Beta] Deletion of user greeting recording call
GET /account/{accountId}/extension/{extensionId}/incoming-call-info [Beta] Retrieval of incoming call information settings
GET /account/{accountId}/extension/{extensionId}/intercom [Beta] Retrieval of account intercom settings
PUT /account/{accountId}/extension/{extensionId}/intercom [Beta] Update of account intercom settings
GET /account/{accountId}/ivr [Beta] Retrieval of IVR mode information
🔐 PUT /account/{accountId}/ivr [Beta] Update of IVR mode information

New Methods

Method Resource Description
DELETE /account/{accountId}/call-log/{recordId}
DELETE /account/{accountId}/extension/{extensionId}/call-log/{recordId}

Request Changes

Method Resource Change Description
🔐 POST /account/{accountId}/extension/{extensionId}/greeting StartRecording, StopRecording and AutomaticRecording values supported for type attribute
PUT /account/{accountId}/extension/{extensionId}/notification-settings includeTranscription parameter added to voicemails object
POST /account/{accountId}/extension/{extensionId}/address-book/contact dialingPlan query parameter supported
PUT /account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} dialingPlan query parameter supported
GET /account/{accountId}/call-log recordingType query parameter supported
GET /account/{accountId}/extension/{extensionId}/call-log recordingType query parameter supported
🔐 GET /account/{accountId}/extension/{extensionId}/call-log-sync recordingType query parameter supported
POST /subscription /restapi/v1.0/account/{accountId}/telephony/sessions and /restapi/v1.0/account/{accountId}/extension/{extensionId}/telephony/sessions event filters supported verificationToken parameter added to deliveryMode object
All All application/xml is not supported anymore except for /phonedata.xml

Response Changes

Method Resource Change Description
🔐 GET /account/{accountId}/device features attribute added to model object
🔐 GET /account/{accountId}/device/{deviceId} features attribute added to model object
🔐 GET /account/{accountId}/extension/{extensionId}/device} features attribute added to model object
GET /account/{accountId}/directory/contacts hidden, phoneNumber.hidden attributes added; MobilePhone, ContactPhone values supported for phoneNumber.usageType attribute
GET /account/{accountId}/directory/contacts/{contactId} hidden, phoneNumber.hidden attributes added; MobilePhone, ContactPhone values supported for phoneNumber.usageType attribute
GET /account/{accountId}/extension/{extensionId}/forwarding-number type attribute added
GET /account/{accountId}/extension/{extensionId}/forwarding-number/{numberId} type attribute added
GET /account/{accountId}/extension/{extensionId}/notification-settings includeTranscription parameter added to voicemails object
GET /account/{accountId}/extension/{extensionId}/phone-number InternationalSmsSender value supported for features attribute
POST /client-info/sip-provision sipFlags.dscpEnabled, sipFlags.dscpSignaling, sipFlags.dscpVoice, sipFlags.dscpVideo attributes added
GET /dictionary/greeting BlockedCalls value supported for usageType attribute; BlockedCallersSpecific, BlockedCallersAll, BlockedNoCallerId, BlockedPayPhones values supported for type attribute
GET /dictionary/greeting/{greetingId} BlockedCalls value supported for usageType attribute; BlockedCallersSpecific, BlockedCallersAll, BlockedNoCallerId, BlockedPayPhones values supported for type attribute
GET /dictionary/user-role permissions[].siteCompatible attribute added
GET /dictionary/user-role/{roleId} permissions[].siteCompatible attribute added
POST /subscription disabledFilters attribute added
GET /subscription/{subscriptionId} blacklistedData attribute added; Blocked value supported for status attribute
Push Notifications contacts.hidden, contacts.phoneNumbers.usageType, contacts.phoneNumbers.hidden attributes added to /restapi/v1.0/account/{accountId}/directory/contacts event nofitication. totalActiveCalls attribute added to /restapi/v1.0/account/402379227004/extension/402379233004/presence event nofitication. ownerId attribute added

Business Logic Changes

Method Resource Change Description
🔐 PUT /account/{accountId}/device/{deviceId} Prestatement calculation logic is supported
GET /account/{accountId}/extension/{extensionId} InternationalSMS service feature supported
POST /account/{accountId}/extension/{extensionId}/address-book/contact New phone number validation rules introduced
PUT /account/{accountId}/extension/{extensionId}/address-book/contact/{contactId} New phone number validation rules introduced
🔐 GET /account/{accountId}/extension/{extensionId}/call-log-sync Special flag added to the token to indicate if syncDown was executed and returned no records on the previous sync request
GET /account/{accountId}/recording/{recordingId}/content when ReadCallRecording permission is checked for target call queue extension, it should be returned as granted if the current extension is a member of that queue
POST /oauth/token phoneNumber*extensionNumber format supported for username attribute
POST /subscription Up to 630720000 seconds supported for expiresIn parameter for WebHook transport type