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

Method Resource Description
POST /account/{accountId}/call-monitoring-groups Creation of a call monitoring group is supported
PUT /account/{accountId}/call-monitoring-groups/{groupId} Editing of a call monitoring group is supported
DELETE /account/{accountId}/call-monitoring-groups/{groupId} Deletion of a call monitoring group is supported
GET /account/{accountId}/directory/entries Retrieval of company users of a federated account is supported
POST /account/{accountId}/directory/entries/search Search of company users of a federated account is supported
POST /account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/bulk-update
GET /account/{accountId}/meeting-recordings
GET /account/{accountId}/extension/{extensionId}/meeting-recordings
🔐 GET /account/{accountId}/message-store-configuration
🔐 PUT /account/{accountId}/message-store-configuration

Now Public

Method Resource Description
🔐 GET /account/{accountId}/telephony/sessions/{sessionId} Returns the status of a call session by ID
🔐 DELETE /account/{accountId}/telephony/sessions/{sessionId} Drops a call session
🔐 GET /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId} Returns a party status of a call session by ID
🔐 PATCH /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId} Modify the party of a call session by ID
🔐 POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/flip Performs call flip procedure by holding opposite party and calling to the specified target
🔐 POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/forward Distributes a non-answered call to the defined target
🔐 POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/hold Puts the party to stand-alone mode and starts to play Hold Music
🔐 POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/recordings Starts new call recording in a party
🔐 PATCH /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/recordings/{recordingId} Pause/resume recording
🔐 POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/reject Rejects an inbound call in a "Setup" or "Proceeding" state
🔐 POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/transfer Transfers a party by placing a new call to the specified target
🔐 POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/unhold Brings a party back into a call and stops to play Hold Music

Syntax Changes

Method Resource Description
GET /account/{accountId}/device/{deviceId} useAsCommonPhone attribute is supported
🔐 PUT /account/{accountId}/device/{deviceId} inCompanyNet and site attributes are supported
GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId} VoicemailExtensionAnsweringRule and AnnouncementExtensionAnsweringRule values are supported for usageType
PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId} VoicemailExtensionAnsweringRule and AnnouncementExtensionAnsweringRule values are supported for usageType
PUT /dictionary/greeting VoicemailExtensionAnsweringRule and AnnouncementExtensionAnsweringRule values are supported for usageType
GET /account/{accountId}/extension/{extensionId}/caller-id extensionNameForOutboundCalls and extensionNumberForInternalCalls attributes are supported
PUT /account/{accountId}/extension/{extensionId}/caller-id extensionNameForOutboundCalls and extensionNumberForInternalCalls attributes are supported
GET /account/{accountId}/extension/{extensionId} EmergencyAddressAutoUpdate service feature added
GET /account/{accountId}/service-info EmergencyAddressAutoUpdate service feature added
POST /account/{accountId}/extension/{extensionId}/greeting multipart/form-data Content-Type is supported
🔐 POST /account/{accountId}/greeting multipart/form-data Content-Type is supported
POST /account/{accountId}/extension/{extensionId}/fax 26, 27, 28 values are supported for coverIndex parameter
GET /account/{accountId}/extension/{extensionId}/phone-number TollFreeSmsSender value is supported for records.features attribute
GET /account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId} contentDisposition query parameter supported
GET /account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId} contentDisposition query parameter supported
GET /account/{accountId}/phone-number/{phoneNumberId} MeetingsNumber value supported for usageType attribute
GET /account/{accountId}/service-info limits.cloudRecordingStorage attribute added
GET /dictionary/state allCountries query parameter is supported
All /subscription event filters /restapi/v1.0/account/{accountId}/extension/{extensionId}/fax?direction=Inbound and /restapi/v1.0/account/{accountId}/extension/{extensionId}/voicemail are supported

Logic Changes

Method Resource Change Description
GET /account/{accountId}/call-log Response URI used to contain extension ID, now only account ID is returned
GET /account/{accountId}/directory/entries label attribute is returned for any phone number where specified
GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId} voicemail attribute is not returned for extensions of Announcement type
PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId} Updating of call handling rules for Voicemail and Announcement extension types is supported
POST /account/{accountId}/extension/{extensionId}/sms Sending SMS from a toll-free number is supported
GET /account/{accountId}/phone-number label attribute is returned for any phone number where specified
GET /account/{accountId}/extension/{extensionId}/phone-number label attribute is returned for any phone number where specified