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

Address Book

Internal Contacts: Change Event

New Notification Filters
⭐️ /restapi/v1.0/account/{accountId}/directory/entries

Authentication

🔧 Token Revocation

  • error code CMN-101 returned for empty token.
Changed Methods
POST /oauth/revoke

Call Handling

🔧 Greetings: Call Recording

  • languageId supported for multipart/form-data request content type.
Changed Methods
POST /account/{accountId}/greeting

Rule Management

Call Queue Transfer to Extension
  • new queue.holdTimeExpirationAction attribute supported.
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}
🔧 Call Queue Voicemail
  • voicemail.recipient.id is processed properly for call queue answering rules.
Changed Methods
PUT /account/{accountId}/extension/{extensionId}/answering-rule/{ruleId}
Detailed List View
  • view and enabledOnly query parameters supported.
Changed Methods
GET /account/{accountId}/extension/{extensionId}/answering-rule

Call History

Caller/Callee Extension ID

  • from.extensionId and to.extensionId response attributes added.
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

Fax

🔧 Attachment Rendering

  • error code MSG-368 is returned: "Fax message processing is in progress" when fax rendering is not yet finished for the attachment.
Changed Methods
GET /account/{accountId}/extension/{extensionId}/message-store/{messageId}/content/{attachmentId}

Message History

Message Store Event Type and Direction Specific Filters

New Notification Filters
⭐️ /restapi/v1.0/account/{accountId}/extension/{extensionId}/message-store?type={type}&direction={direction}

Provisioning

Emergency Address Auto Update

⚠️ HELD Support
  • HELD value supported for model.features attribute.
Changed Methods
GET /account/{accountId}/device/{deviceId}
GET /account/{accountId}/extension/{extensionId}/device
Last Location Report Time
  • new lastLocationReportTime response attribute added.
Changed Methods
GET account/{accountId}/device/{deviceId}

Team Messaging aka Glip

⚠️ Notes

⭐️ Chat Notes
New Methods
⭐️ GET /glip/chats/{chatId}/notes
⭐️ POST /glip/chats/{chatId}/notes
⛔️ Global User Notes
Removed Methods
⛔️ GET /glip/notes
⛔️ POST /glip/notes
⚠️ Note Actions
  • ⚠️ response HTTP codes for actions changed to 204 No Content.
Changed Methods
POST /glip/notes/{noteId}/publish
POST /glip/notes/{noteId}/lock
POST /glip/notes/{noteId}/unlock
⚠️ Single Note Operations
  • new attribute chatIds added;
  • ⚠️ attribute creatorId replaced with creator.id;
  • ⚠️ attribute lockedBy replaced with lockedBy.id.
Changed Methods
GET /glip/notes/{noteId}
PATCH /glip/notes/{noteId}
  • ⚠️PUT update method replaced with PATCH;
  • releaseLock query parameter not supported anymore;
Removed Methods
⛔️ PUT /glip/notes/{noteId}
New Methods
⭐️ PATCH /glip/notes/{noteId}
  • 🔧 note deletion now doesn't remove the post(s) where it is attached.
Changed Methods
DELETE /glip/notes/{noteId}

⭐️ Tasks

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

Telephony/Voice

Call Control

Call Forwarding/Transfer to Extension
  • new extensionNumber attribute supported.
Changed Methods
POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/transfer
POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/forward
Reply
New Methods
⭐️ POST /account/{accountId}/telephony/sessions/{sessionId}/parties/{partyId}/reply

SIP Provisioning: Survivable Voice Gateway

  • new sipInfoPstn response attribute added.
Changed Methods
POST /client-info/sip-provision