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

🔧 – bug fixes.

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

Account

Phone Numbers

Temporary Numbers
  • temporaryNumber attribute added.
Changed Methods
GET /account/{id}/phone-number
GET /account/{id}/phone-number/{numberId}

User Settings

Conferencing Premium Numbers
  • phoneNumbers.premium attribute added.
Changed Methods
GET /account/{accountId}/extension/{extensionId}/conferencing
PUT /account/{accountId}/extension/{extensionId}/conferencing
⭐️ Features
New Methods
⭐️ GET /account/{accountId}/extension/{extensionId}/features

Call Management

Rule Management

🔧 Call Queue Max Callers Limit
  • queue.maxCallers max value decreased to 25.
Changed Methods
PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
🔧 Call Queue Wrap-up Time Limit
  • queue.wrapUpTime max value increased to 300.
Changed Methods
PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
Music on Hold for Limited Extensions
  • HoldMusic greeting type supported for extensions of Limited type.
Changed Methods
GET /account/{accountId}/extension/{extensionId}/answering-rule
POST /account/{accountId}/extension/{extensionId}/answering-rule
GET /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}

Glip

⭐️ Tasks

New Methods
⭐️ GET /glip/chats/{chatId}/tasks
⭐️ POST /glip/chats/{chatId}/tasks
⭐️ GET /glip/tasks/{taskId}
⭐️ PUT /glip/tasks/{taskId}

Events & Notifications

Reply with Text Reason

  • parties.state.reason attribute added to notification payload.
Changed Notification Payloads
/restapi/v1.0/account/{accountId}/telephony/sessions
/restapi/v1.0/account/{accountId}/extension/{extensionId}/telephony/sessions

Messaging

Fax

⭐️ Fax Cover Page Settings
New Methods
⭐️ GET /account/{accountId}/extension/{extensionId}/fax-cover-page
⭐️ PUT /account/{accountId}/extension/{extensionId}/fax-cover-page
⚠️ New Error Codes
  • WrongNumber and AllLinesInUse values supported for records[].to[].faxErrorCode attribute.
Changed Methods
GET /account/{accountId}/extension/{extensionId}/message-store
GET /account/{accountId}/extension/{extensionId}/message-sync

Message Store

🔧 Message Deletion
  • if the message is already deleted, HTTP 204 returned instead of HTTP 404.
Changed Methods
DELETE /account/{accountId}/extension/{extensionId}/message-store/{messageId}

⭐️ MMS (Dedicated Endpoint)

New Methods
⭐️ POST /account/{accountId}/extension/{extensionId}/mms

Provisioning

Automatic Location Updates

⭐️ Bulk Operations
New Methods
⭐️ 🔐 POST /account/{accountId}/emergency-address-auto-update/switches-bulk-create
⭐️ 🔐 POST /account/{accountId}/emergency-address-auto-update/switches-bulk-update
⭐️ 🔐 POST /account/{accountId}/emergency-address-auto-update/switches-bulk-validate
⭐️ 🔐 POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-create
⭐️ 🔐 POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-update
⭐️ 🔐 POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-validate
⭐️ Devices
New Methods
⭐️ 🔐 GET /account/{accountId}/emergency-address-auto-update/devices
⭐️ 🔐 POST /account/{accountId}/emergency-address-auto-update/devices/bulk-assign
⭐️ 🔐 Emergency Response Locations
New Methods
⭐️ 🔐 GET /account/{accountId}/emergency-locations
⭐️ 🔐 POST /account/{accountId}/emergency-locations
⭐️ 🔐 GET /account/{accountId}/emergency-locations/{locationId}
⭐️ 🔐 PUT /account/{accountId}/emergency-locations/{locationId}
⭐️ 🔐 DELETE /account/{accountId}/emergency-locations/{locationId}
🔐 Emergency Response Locations Applying
  • emergencyLocationId parameter supported.
Changed Methods
🔐 POST account/{accountId}/emergency-address-auto-update/networks
🔐 PUT account/{accountId}/emergency-address-auto-update/networks/{networkId}
🔐 GET account/{accountId}/emergency-address-auto-update/networks
🔐 GET account/{accountId}/emergency-address-auto-update/networks/{networkId}
🔐 POST account/{accountId}/emergency-address-auto-update/switches
🔐 PUT account/{accountId}/emergency-address-auto-update/switches/{switchId}
🔐 GET account/{accountId}/emergency-address-auto-update/switches
🔐 GET account/{accountId}/emergency-address-auto-update/switches/{switchId}
🔐 POST /account/{accountId}/emergency-address-auto-update/switches-bulk-create
🔐 POST /account/{accountId}/emergency-address-auto-update/switches-bulk-update
🔐 POST /account/{accountId}/emergency-address-auto-update/switches-bulk-validate
🔐 POST account/{accountId}/emergency-address-auto-update/wireless-points
🔐 PUT account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}
🔐 GET account/{accountId}/emergency-address-auto-update/wireless-points
🔐 GET account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}
🔐 POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-create
🔐 POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-update
🔐 POST /account/{accountId}/emergency-address-auto-update/wireless-points-bulk-validate
⭐️ Extensions
New Methods
⭐️ 🔐 GET /account/{accountId}/emergency-address-auto-update/users
⭐️ 🔐 POST /account/{accountId}/emergency-address-auto-update/users/bulk-assign
⭐️ IP Address Range Map
New Methods
⭐️ 🔐 GET account/{accountId}/emergency-address-auto-update/networks
⭐️ 🔐 POST account/{accountId}/emergency-address-auto-update/networks
⭐️ 🔐 GET account/{accountId}/emergency-address-auto-update/networks/{networkId}
⭐️ 🔐 PUT account/{accountId}/emergency-address-auto-update/networks/{networkId}
⭐️ 🔐 DELETE account/{accountId}/emergency-address-auto-update/networks/{networkId}
⭐️ Switch Map
New Methods
⭐️ 🔐 GET /account/{accountId}/emergency-address-auto-update/switches
⭐️ 🔐 POST /account/{accountId}/emergency-address-auto-update/switches
⭐️ 🔐 GET /account/{accountId}/emergency-address-auto-update/switches/{switchId}
⭐️ 🔐 PUT /account/{accountId}/emergency-address-auto-update/switches/{switchId}
⭐️ 🔐 DELETE /account/{accountId}/emergency-address-auto-update/switches/{switchId}
🔐 User Filtering by Entitlement
  • only users with appropriate Hard Phone / SoftPhone entitlements returned and can have automatic location updates on.
Changed Methods
🔐 GET account/{accountId}/emergency-address-auto-update/users
🔐 POST account/{accountId}/emergency-address-auto-update/users/bulk-assign
⭐️ Wireless Access Point Map
New Methods
⭐️ 🔐 GET account/{accountId}/emergency-address-auto-update/wireless-points
⭐️ 🔐 POST account/{accountId}/emergency-address-auto-update/wireless-points
⭐️ 🔐 GET account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}
⭐️ 🔐 PUT account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}
⭐️ 🔐 DELETE account/{accountId}/emergency-address-auto-update/wireless-points/{pointId}

Voice

Call Control

⭐️ Answering the Call
New Methods
⭐️ POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/answer
⭐️ Parked Call Pickup
New Methods
⭐️ POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/pickup
⚠️ Reply with Text Reason
  • parties.state.reason attribute added.
Changed Methods
GET /account/{accountId}/telephony/sessions/{telephonySessionId}
GET /account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}
⚠️ Supervise Attributes Renaming
  • agentExtensionNumber, agentExtensionId, supervisorDeviceId attributes added in replacement of extensionNumber and deviceId (for backward complatibility reasons old ones still supported but deprecated).
Changed Methods
POST /account/{accountId}/telephony/sessions/{sessionId}/supervise

Call Log

⚠️ Monitoring Action
  • Monitoring value supported for action attribute.
Changed Methods
GET /account/{accountId}/call-log
GET /account/{accountId}/call-log/{callRecordId}
GET /account/{accountId}/extension/{extensionId}/call-log
GET /account/{accountId}/extension/{extensionId}/call-log/{callRecordId}
GET /account/{accountId}/extension/{extensionId}/call-log-sync
  • Last updated:
  • Contributors