{ "opencollection": "1.0.0", "info": { "name": "RingCentral API", "version": "1.0.58-20240529-47eda8bd" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://platform.ringcentral.com/restapi/oauth/authorize", "accessTokenUrl": "https://platform.ringcentral.com/restapi/oauth/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Webinar Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "List Webinar Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/notifications/v1/subscriptions" }, "docs": "Returns a list of webinar subscriptions created by the user for the current authorized client application." }, { "info": { "name": "Create Webinar Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/webinar/notifications/v1/subscriptions", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new webinar subscription for the current authorized user / client application." }, { "info": { "name": "Get Webinar Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/notifications/v1/subscriptions/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "12345678", "type": "path", "description": "Internal identifier of a subscription" } ] }, "docs": "Returns the webinar subscription by ID" }, { "info": { "name": "Update Webinar Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/webinar/notifications/v1/subscriptions/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "12345678", "type": "path", "description": "Internal identifier of a subscription" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the existing subscription. The client application can extend/narrow\nthe list of events for which it receives notifications within this subscription.\nIf event filters are specified, calling this method modifies them for the\nexisting subscription. The method also allows setting the subscription expiration time.\nIf other than `events` and `expiresIn` parameters are passed in the request they will be ignored.\nIf the request body is empty then the specified subscription will be just renewed w" }, { "info": { "name": "Cancel Webinar Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/webinar/notifications/v1/subscriptions/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "12345678", "type": "path", "description": "Internal identifier of a subscription" } ] }, "docs": "Cancels the existing webinar subscription." }, { "info": { "name": "Renew Webinar Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/webinar/notifications/v1/subscriptions/:subscriptionId/renew", "params": [ { "name": "subscriptionId", "value": "12345678", "type": "path", "description": "Internal identifier of a subscription" } ] }, "docs": "Renews the existing webinar subscription." } ] }, { "info": { "name": "Historical Webinars", "type": "folder" }, "items": [ { "info": { "name": "Get Historical Webinar", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." } ] }, "docs": "Returns a historical webinar information by ID (host interface)" }, { "info": { "name": "Get Historical Webinar Session", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId/sessions/:sessionId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." } ] }, "docs": "Returns a historical webinar Session by ID. Access allowed to participants with original role as Host or CoHost." }, { "info": { "name": "List Session Participants", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId/sessions/:sessionId/participants", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." }, { "name": "role", "value": "", "type": "query", "description": "The role of the invitee/participant." }, { "name": "originalRole", "value": "", "type": "query", "description": "The original role of the invitee/participant." }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" } ] }, "docs": "Returns the list of participants of a given Webinar Session (host interface).\n" }, { "info": { "name": "Get Participant Information", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId/sessions/:sessionId/participants/self", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." } ] }, "docs": "Returns the participant information specific to a webinar session. Accessible by any authenticated participant.\nFor a non-authenticated participant, API returns error.\n" }, { "info": { "name": "List Session Invitees", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId/sessions/:sessionId/invitees", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." }, { "name": "role", "value": "", "type": "query", "description": "The role of the invitee/participant." }, { "name": "originalRole", "value": "", "type": "query", "description": "The original role of the invitee/participant." }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" } ] }, "docs": "Returns the list of Invitees (co-hosts and panelists) of a given Webinar Session (host interface).\nAn implicit record created for a Webinar 'Host' is always returned.\n" }, { "info": { "name": "Get Session Invitee", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/webinars/:webinarId/sessions/:sessionId/invitees/:inviteeId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." }, { "name": "inviteeId", "value": "77777777", "type": "path", "description": "Identifier of the Session Invitee." } ] }, "docs": "Returns a historical session invitee information by ID (host interface)." }, { "info": { "name": "List Historical Webinar Sessions across Multiple Webinars / Hosts", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/company/sessions", "params": [ { "name": "hostUserId", "value": "77777777", "type": "query", "description": "Identifier of the user who hosts a webinar (if omitted, webinars hosted by all company users will be returned)" }, { "name": "status", "value": "Active,Finished", "type": "query", "description": "Filter to return only webinar sessions in certain status. Multiple values are supported." }, { "name": "endTimeFrom", "value": "", "type": "query", "description": "The beginning of the time window by 'endTime' ." }, { "name": "endTimeTo", "value": "", "type": "query", "description": "The end of the time window by 'endTime' ." }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" } ] }, "docs": "Returns the list of historical Webinar Sessions hosted by particular user(s) or all company users\nsorted by 'endTime' in the descending order. Depending on a session status 'endTime' can\nrepresent actual end time or scheduled end time.\nThe user must have \"WebinarSettings\" permission granted otherwise the API returns HTTP 403.\n" }, { "info": { "name": "List Historical Webinar Sessions across Multiple Webinars", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/sessions", "params": [ { "name": "nameFragment", "value": "All-hands", "type": "query", "description": "Filter to return only webinar sessions containing particular substring within their names" }, { "name": "status", "value": "Active,Finished", "type": "query", "description": "Filter to return only webinar sessions in certain status. Multiple values are supported." }, { "name": "endTimeFrom", "value": "", "type": "query", "description": "The beginning of the time window by 'endTime' ." }, { "name": "endTimeTo", "value": "", "type": "query", "description": "The end of the time window by 'endTime' ." }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" } ] }, "docs": "Returns the list of historical Webinar Sessions hosted by a current authorized user\nsorted by 'endTime' in the descending order. Depending on a session status 'endTime' can\nrepresent actual end time or scheduled end time.\n" } ] }, { "info": { "name": "Historical Recordings", "type": "folder" }, "items": [ { "info": { "name": "List Webinar Recordings (Admin)", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/company/recordings", "params": [ { "name": "nameFragment", "value": "All-hands", "type": "query", "description": "Filter to return only webinar recordings containing particular substring within their names" }, { "name": "creationTimeFrom", "value": "", "type": "query", "description": "The beginning of the time window by 'creationTime' ." }, { "name": "creationTimeTo", "value": "", "type": "query", "description": "The end of the time window by 'creationTime' ." }, { "name": "status", "value": "", "type": "query", "description": "The status of the recording." }, { "name": "hostUserId", "value": "77777777", "type": "query", "description": "Identifier of the user who hosts a webinar (if omitted, webinars hosted by all company users will be returned)" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" } ] }, "docs": "Returns the list of webinar recordings (Administrator's interface).\nThe user must have \"WebinarSettings\" permission granted otherwise the API returns HTTP 403.\n" }, { "info": { "name": "Get Webinar Recording (Admin)", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/company/recordings/:recordingId", "params": [ { "name": "recordingId", "value": "7637637682", "type": "path", "description": "Identifier of the Webinar recording." } ] }, "docs": "Returns the webinar recording by ID (Administrator's interface).\n\nThe user must have \"WebinarSettings\" permission granted otherwise the API returns HTTP 403.\n" }, { "info": { "name": "List Webinar Recordings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/recordings", "params": [ { "name": "creationTimeFrom", "value": "", "type": "query", "description": "The beginning of the time window by 'creationTime' ." }, { "name": "creationTimeTo", "value": "", "type": "query", "description": "The end of the time window by 'creationTime' ." }, { "name": "status", "value": "", "type": "query", "description": "The status of the recording." }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" } ] }, "docs": "Returns the list of webinar recordings for a given webinar host user\n" }, { "info": { "name": "Get Webinar Recording", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/recordings/:recordingId", "params": [ { "name": "recordingId", "value": "7637637682", "type": "path", "description": "Identifier of the Webinar recording." } ] }, "docs": "Returns the webinar recording by ID (Webinar host's interface).\nThis API also returns sharing link if sharing is enabled.\n" }, { "info": { "name": "Get Webinar Recording Download Resource", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/history/v1/recordings/:recordingId/download", "params": [ { "name": "recordingMediaType", "value": "", "type": "query", "description": "Download file media type.\n- Type 'Video' refers to a multiplexed audio and video file.\n- Type 'Audio' refers to an audio only file.\n- Unless specified by this query parameter, a video file is returned by default when a recording is downloaded.\n" }, { "name": "recordingId", "value": "7637637682", "type": "path", "description": "Identifier of the Webinar recording." } ] }, "docs": "Returns the webinar recording download link (both Webinar host's and admin interface).\n\nIf called by a webinar host, the API returns error (403) if recording downloading is prohibited by company settings.\nThe admin user who has \"WebinarSettings\" permission should be able to download recording regardless of current company settings.\n" } ] }, { "info": { "name": "Registration Management", "type": "folder" }, "items": [ { "info": { "name": "Get Registration Session Info", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId", "params": [ { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." } ] }, "docs": "Returns a registration Session information by ID.\n\nA caller must be an authorized user: either a host of the webinar or an IT Admin:\na user from host's account with \"WebinarSettings\" permission.\n" }, { "info": { "name": "Update Registration Session", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId", "params": [ { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Session by ID.\n\nThis is a PARTIAL update (PATCH), client may call it providing only attributes which are to be changed.\n\nA caller must be an authorized user: either a host of the webinar or an IT Admin:\na user from host's account with \"WebinarSettings\" permission.\n\nIf a session record with given ID doesn't exist on Registration Service side the API should return HTTP 404.\n" } ] }, { "info": { "name": "Registrants", "type": "folder" }, "items": [ { "info": { "name": "List Session Registrants", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId/registrants", "params": [ { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" }, { "name": "includeQuestionnaire", "value": "", "type": "query", "description": "Indicates if registrant's \"questionnaire\" should be returned" } ] }, "docs": "Returns the list of Registrants ordered by \"id\" ascending.\n\nA caller must be an authorized user: either a host of the webinar or an IT Admin:\na user from host's account with \"WebinarSettings\" permission.\n" }, { "info": { "name": "Create Registrant", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId/registrants", "params": [ { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Registrant for a given session.\n\nRegistration MUST be open for the session for this call to succeed (otherwise it should return HTTP 403).\n\nA caller must be an authorized user: either a host of the webinar or an IT Admin:\na user from host's account with \"WebinarSettings\" permission.\n" }, { "info": { "name": "Get Registrant", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId/registrants/:registrantId", "params": [ { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." }, { "name": "registrantId", "value": "77777777", "type": "path", "description": "Identifier of the Session Registrant" }, { "name": "includeQuestionnaire", "value": "", "type": "query", "description": "Indicates if registrant's \"questionnaire\" should be returned" } ] }, "docs": "Returns a Registrant by ID.\n\nA caller must be an authorized user: either a host of the webinar or an IT Admin:\na user from host's account with \"WebinarSettings\" permission.\n" }, { "info": { "name": "Delete Registrant", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/webinar/registration/v1/sessions/:sessionId/registrants/:registrantId", "params": [ { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." }, { "name": "registrantId", "value": "77777777", "type": "path", "description": "Identifier of the Session Registrant" } ] }, "docs": "Deletes a Registrant by ID.\n\nSession must not be in finished state (otherwise it should return HTTP 403).\n\nA caller must be an authorized user: either a host of the webinar or an IT Admin:\na user from host's account with \"WebinarSettings\" permission.\n" } ] }, { "info": { "name": "Webinars and Sessions", "type": "folder" }, "items": [ { "info": { "name": "List User's Webinars", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars", "params": [ { "name": "creationTimeFrom", "value": "", "type": "query", "description": "The beginning of the time window by 'creationTime' ." }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" } ] }, "docs": "Returns the list of Webinars hosted by a current authorized user sorted by 'scheduledStartTime' or 'creationTime' in the ascending order.\n" }, { "info": { "name": "Create Webinar", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new webinar.\n\nIf \"host\" parameter is NOT passed then the current authorized user will become a Host.\nIf \"host\" parameter is passed then the caller must be a company administrator and have \"WebinarSettings\" permission.\n\"host.linkedUser.accountId\" must be the same as authorized user's account ID.\n\nThe webinar settings which are not mandated at account level or are unlocked can be\nspecified. All other settings are defaulted according to account policy.\n" }, { "info": { "name": "Get Webinar", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." } ] }, "docs": "Returns a Webinar information by ID.\nSome webinar settings are returned basing on webinar-level overrides, other - from default settings defined at account level.\n" }, { "info": { "name": "Update Webinar", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Webinar. The payload may contain just changed fields of a Webinar resource (it is a partial update):\n- host cannot be changed, and host user information cannot be updated;\n- only the settings which are not mandated at account level or are unlocked can be\nchanged;\n- in order to reset a webinar password it should be passed as an empty string;\n- \"registrationStatus\" cannot be changed.\n" }, { "info": { "name": "Delete Webinar", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." } ] }, "docs": "Deletes a Webinar by ID. All child objects (Sessions, Invitees) will be also deleted.\nIt is disallowed to delete a Webinar which has at least one Session in 'Active' or 'Finished' state.\n" }, { "info": { "name": "Create Webinar Session", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Session for a given Webinar" }, { "info": { "name": "Get Webinar Session", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." } ] }, "docs": "Returns a Webinar Session by ID." }, { "info": { "name": "Update Webinar Session", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Webinar Session. The payload may contain certain attributes from the Session resource\n(it is a partial update). Changing the 'status' field usually invokes certain workflow actions.\nUpdating a Session in 'Active' or 'Finished' status is prohibited.\nSome status transitions (for example, to 'Active\" or 'Finished') may be prohibited.\n" }, { "info": { "name": "Delete Webinar Session", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." } ] }, "docs": "Deletes a Webinar Session. All child objects (Invitees) will be also deleted.\nIt is disallowed to delete a Session which is in 'Active' or 'Finished' state\n" }, { "info": { "name": "List Sessions across Multiple Webinars/Hosts", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/configuration/v1/company/sessions", "params": [ { "name": "status", "value": "Scheduled", "type": "query", "description": "Filter to return only webinar sessions in certain status. Multiple values are supported." }, { "name": "endTimeFrom", "value": "", "type": "query", "description": "The beginning of the time window by 'endTime' (it is calculated as scheduledStartTime+scheduledDuration)" }, { "name": "hostUserId", "value": "77777777", "type": "query", "description": "Identifier of the user who hosts a webinar (if omitted, webinars hosted by all company users will be returned)" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" } ] }, "docs": "Returns the list of Webinar Sessions hosted by all company users or particular user(s) sorted by\n'scheduledStartTime' or 'creationTime' (if 'scheduledStartTime' is not set) in the ascending ordered.\nThe user must have \"WebinarSettings\" permission granted otherwise the API returns HTTP 403.\n" }, { "info": { "name": "List Sessions across Multiple Webinars", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/configuration/v1/sessions", "params": [ { "name": "nameFragment", "value": "All-hands", "type": "query", "description": "Filter to return only webinar sessions containing particular substring within their names" }, { "name": "status", "value": "Scheduled", "type": "query", "description": "Filter to return only webinar sessions in certain status. Multiple values are supported." }, { "name": "endTimeFrom", "value": "", "type": "query", "description": "The beginning of the time window by 'endTime' (it is calculated as scheduledStartTime+scheduledDuration)" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" } ] }, "docs": "Returns the list of Webinar Sessions hosted by a current authorized user sorted by\n'scheduledStartTime' or 'creationTime' (if 'scheduledStartTime' is not set) in the ascending order\n" } ] }, { "info": { "name": "Invitees", "type": "folder" }, "items": [ { "info": { "name": "List Session Invitees", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId/invitees", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" } ] }, "docs": "Returns the list of Invitees (co-hosts and panelists in phase 1\nand also invited attendees in subsequent phases) of a given Webinar Session.\nAn implicit record created for a Webinar 'Host' is always returned.\n" }, { "info": { "name": "Bulk Add/Delete Session Invitees", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId/invitees", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds, updates and deletes Webinar Session invitees in bulk (co-hosts and panelists in phase 1\nand also invited attendees in subsequent phases).\nThe payload may contain multiple added, updated or deleted invitees.\nFor each added record 'role' and either 'firstName'/'lastName'/'email' (for non-authenticated users)\nor 'linkedUser.*' (for authenticated users) must be specified, but not both.\nFor updated invitees 'id' and 'role' must be specified, 'linkedUser' change is not supported.\nFor deleted in" }, { "info": { "name": "Get Session Invitee", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId/invitees/:inviteeId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." }, { "name": "inviteeId", "value": "77777777", "type": "path", "description": "Identifier of the Session Invitee." } ] }, "docs": "Returns a Session Invitee information by ID" }, { "info": { "name": "Update Session Invitee", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId/invitees/:inviteeId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." }, { "name": "inviteeId", "value": "77777777", "type": "path", "description": "Identifier of the Session Invitee." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Session Invitee. 'role' is required (it can be changed from 'Panelist' to 'CoHost' or vise versa).\nIt is disallowed to update 'linkedUser': it should be done by deleting then adding an invitee.\nFor non-authenticated users 'firstName'/'lastName'/'email' can be specified, but not both.\nImplicit record created for a Webinar 'Host' cannot be modified.\nAlso it is disallowed to change any other role to 'Host'.\n" }, { "info": { "name": "Delete Session Invitee", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/webinar/configuration/v1/webinars/:webinarId/sessions/:sessionId/invitees/:inviteeId", "params": [ { "name": "webinarId", "value": "98989898", "type": "path", "description": "Identifier of the Webinar." }, { "name": "sessionId", "value": "353535353", "type": "path", "description": "Identifier of the Session." }, { "name": "inviteeId", "value": "77777777", "type": "path", "description": "Identifier of the Session Invitee." } ] }, "docs": "Deletes a Session Invitee. Implicit record created for a Webinar 'Host' cannot be deleted.\nDeleting an invitee for a Session in 'Active' or 'Finished' status is prohibited (HTTP 403).\n" } ] }, { "info": { "name": "Call Recordings", "type": "folder" }, "items": [ { "info": { "name": "Get Call Recording Content", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/recording/:recordingId/content", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "recordingId", "value": "", "type": "path", "description": "Internal identifier of a call recording (returned in Call Log)" }, { "name": "contentDisposition", "value": "", "type": "query", "description": "Whether the content is expected to be displayed in the browser, or downloaded and saved locally" }, { "name": "contentDispositionFilename", "value": "", "type": "query", "description": "The default filename of the file to be downloaded" } ] }, "docs": "Returns media content of a call recording (`audio/mpeg` or `audio/wav`)\n\n**This API must be called via media API entry point, e.g. https://media.ringcentral.com**\n" }, { "info": { "name": "Delete Company Call Recordings", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-recordings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes company call recordings by their IDs. *Please note:* This method deletes the recording file itself,\nnot the record of it in the call log.\n" }, { "info": { "name": "Get Call Recording", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/recording/:recordingId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "recordingId", "value": "", "type": "path", "description": "Internal identifier of a call recording (returned in Call Log)" } ] }, "docs": "Returns call recordings by ID(s)." } ] }, { "info": { "name": "Greetings", "type": "folder" }, "items": [ { "info": { "name": "Get Account Greeting Media Content", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/greeting/:greetingId/content", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "greetingId", "value": "", "type": "path", "description": "Internal identifier of a greeting" }, { "name": "contentDisposition", "value": "", "type": "query", "description": "Whether the content is expected to be displayed in the browser, or downloaded and saved locally" }, { "name": "contentDispositionFilename", "value": "", "type": "query", "description": "The default filename of the file to be downloaded" } ] }, "docs": "Returns account-level greeting media contents.\n\n**This API must be called via media API entry point, e.g. https://media.ringcentral.com**\n" }, { "info": { "name": "Get Extension Greeting Media Content", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/greeting/:greetingId/content", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "greetingId", "value": "", "type": "path", "description": "Internal identifier of a greeting" }, { "name": "contentDisposition", "value": "", "type": "query", "description": "Whether the content is expected to be displayed in the browser, or downloaded and saved locally" }, { "name": "contentDispositionFilename", "value": "", "type": "query", "description": "The default filename of the file to be downloaded" } ] }, "docs": "Returns extension-level greeting media contents.\n\n**This API must be called via media API entry point, e.g. https://media.ringcentral.com**\n" }, { "info": { "name": "Create Company Greeting", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/greeting", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "multipart-form", "data": [ { "name": "type", "type": "text", "value": "" }, { "name": "answeringRuleId", "type": "text", "value": "" }, { "name": "languageId", "type": "text", "value": "" }, { "name": "binary", "type": "text", "value": "" } ] } }, "docs": "Creates a custom company greeting." }, { "info": { "name": "Create Custom User Greeting", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/greeting", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "apply", "value": "", "type": "query", "description": "Specifies whether to apply an answering rule or not. If set to\ntrue then `answeringRule` parameter is mandatory. If set to false, then\nthe answering rule is not applied even if specified\n" } ], "body": { "type": "multipart-form", "data": [ { "name": "type", "type": "text", "value": "" }, { "name": "answeringRuleId", "type": "text", "value": "" }, { "name": "binary", "type": "text", "value": "" } ] } }, "docs": "Creates custom greeting for an extension user." }, { "info": { "name": "Get Custom Greeting", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/greeting/:greetingId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "greetingId", "value": "", "type": "path", "description": "Internal identifier of a greeting" } ] }, "docs": "Returns a custom user greeting by ID." }, { "info": { "name": "List Standard Greetings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting", "params": [ { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "type", "value": "", "type": "query", "description": "Type of greeting, specifying the case when the greeting is played" }, { "name": "usageType", "value": "", "type": "query", "description": "Usage type of greeting, specifying if the greeting is applied for user extension or department (call queue) extension" } ] }, "docs": "Returns the list of predefined standard greetings. Custom greetings\nrecorded by user are not returned in response to this request. See Get Extension\nCustom Greetings.\n" }, { "info": { "name": "Get Standard Greeting", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/greeting/:greetingId", "params": [ { "name": "greetingId", "value": "", "type": "path", "description": "Internal identifier of a greeting" } ] }, "docs": "Returns a standard greeting by ID." } ] }, { "info": { "name": "User Settings", "type": "folder" }, "items": [ { "info": { "name": "Get Scaled Profile Image", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/profile-image/:scaleSize", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "scaleSize", "value": "", "type": "path", "description": "Dimensions of a profile image which will be returned in response.\n" }, { "name": "contentDisposition", "value": "", "type": "query", "description": "Whether the content is expected to be displayed in the browser, or downloaded and saved locally" }, { "name": "contentDispositionFilename", "value": "", "type": "query", "description": "The default filename of the file to be downloaded" } ] }, "docs": "Returns the scaled profile image of an extension.\n\n**This API must be called via media API entry point, e.g. https://media.ringcentral.com**\n" }, { "info": { "name": "Create Multiple User Extensions", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/batch-provisioning/users", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates multiple user extensions with BYOD (customer provided) devices.\nIf \"extensionNumber\" is not specified, the next available extension number will be assigned.\n" }, { "info": { "name": "Delete User Extensions", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/extensions", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes user extension(s) and either keeps or destroys the assets - numbers and devices.\nMultiple extensions can be deleted with a single API call.\n\n**Please note:** This API cannot be tested on Sandbox.\n" }, { "info": { "name": "Get Extension", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns basic information about a particular extension of an account.\n" }, { "info": { "name": "Update Extension", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the user settings." }, { "info": { "name": "Delete Extension", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "savePhoneLines", "value": "", "type": "query" }, { "name": "savePhoneNumbers", "value": "", "type": "query" } ] }, "docs": "Deletes extension(s) by ID(s). When an extension is being deleted\nthe default API behavior is as follows:\n\n- user's direct numbers are preserved by becoming additional company numbers;\n- user's digital lines (both device & associated phone number) are deleted.\n\nYou can change this behavior using the filters:\n\n- create unassigned extensions for each digital line of the deleted extension by\n setting the query parameter `savePhoneLines` to `true` in request path;\n- remove direct numbers of the del" }, { "info": { "name": "List Extension Grants", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/grant", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "extensionType", "value": "", "type": "query", "description": "Type of extension to be returned. Multiple values are supported.\nPlease note that legacy 'Department' extension type corresponds\nto 'Call Queue' extensions in modern RingCentral product terminology\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare allowed\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" } ] }, "docs": "Returns the list of extensions with information on grants\ngiven to the current extension regarding them. Currently the list of grants\ninclude: picking up a call, monitoring, calling or receiving a call on behalf\nof somebody, call delegation and calling paging groups.\n" }, { "info": { "name": "Get User Conferencing Settings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/conferencing", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "countryId", "value": "", "type": "query", "description": "Internal identifier of a country. If not specified, the response\nis returned for the brand country\n" } ] }, "docs": "Returns information on Free Conference Calling (FCC) feature\nfor a given extension.\n" }, { "info": { "name": "Update User Conferencing Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/conferencing", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the default conferencing number for the current extension.\nThe number can be selected from conferencing numbers of the current extension.\nUpdates the setting, allowing participants join the conference before host.\n" }, { "info": { "name": "Get User Profile Image", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/profile-image", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns a profile image of an extension.\n" }, { "info": { "name": "Upload User Profile Image", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/profile-image", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "multipart-form", "data": [ { "name": "image", "type": "text", "value": "" } ] } }, "docs": "Uploads the extension profile image.\n" }, { "info": { "name": "Update User Profile Image", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/profile-image", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "multipart-form", "data": [ { "name": "image", "type": "text", "value": "" } ] } }, "docs": "Updates the extension profile image.\n" }, { "info": { "name": "Delete User Profile Image", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/profile-image", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Deletes the user profile image.\n" }, { "info": { "name": "Get Extension Caller ID", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-id", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns information on an outbound caller ID of an extension.\n" }, { "info": { "name": "Update Extension Caller ID", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-id", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates outbound caller ID information of an extension.\n" }, { "info": { "name": "Get Notification Settings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/notification-settings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns notification settings for the current extension.\n\nKnowledge Article: [User Settings - Set Up Message Notifications](https://success.ringcentral.com/articles/RC_Knowledge_Article/9740)\n" }, { "info": { "name": "Update Notification Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/notification-settings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates notification settings for the current extension.\nKnowledge Article: [User Settings - Set Up Message Notifications](https://success.ringcentral.com/articles/RC_Knowledge_Article/9740)\n" } ] }, { "info": { "name": "Message Store", "type": "folder" }, "items": [ { "info": { "name": "Get Message Attachment Content", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store/:messageId/content/:attachmentId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "messageId", "value": "", "type": "path" }, { "name": "attachmentId", "value": "", "type": "path" }, { "name": "contentDisposition", "value": "", "type": "query", "description": "Whether the content is expected to be displayed in the browser, or downloaded and saved locally" }, { "name": "contentDispositionFilename", "value": "", "type": "query", "description": "The default filename of the file to be downloaded" } ] }, "docs": "Returns media content of a message attachment.\nThe content is typically an audio file (`audio/mpeg` or `audio/wav`) for voicemails,\nTIFF or PDF for faxes and image/audio/video for MMS.\n\n**This API must be called via media API entry point, e.g. https://media.ringcentral.com**\n" }, { "info": { "name": "Get Message Store Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-configuration", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns message store settings." }, { "info": { "name": "Update Message Store Configuration", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-configuration", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates message store settings." }, { "info": { "name": "Sync Messages", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-sync", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "conversationId", "value": "", "type": "query", "description": "Conversation identifier for the resulting messages. Meaningful\nfor SMS and Pager messages only.\n" }, { "name": "dateFrom", "value": "", "type": "query", "description": "The start date/time for resulting messages in ISO 8601 format\nincluding timezone, for example 2016-03-10T18:07:52.534Z. The default value\nis dateTo minus 24 hours\n" }, { "name": "dateTo", "value": "", "type": "query", "description": "The end date/time for resulting messages in ISO 8601 format including\ntimezone, for example 2016-03-10T18:07:52.534Z. The default value is current\ntime\n" }, { "name": "direction", "value": "", "type": "query", "description": "Direction for the resulting messages. If not specified, both\ninbound and outbound messages are returned. Multiple values are accepted\n" }, { "name": "distinctConversations", "value": "", "type": "query", "description": "If `true`, then the latest messages per every conversation ID\nare returned\n" }, { "name": "messageType", "value": "", "type": "query", "description": "Type for the resulting messages. If not specified, all types\nof messages are returned. Multiple values are accepted\n" }, { "name": "recordCount", "value": "", "type": "query", "description": "Limits the number of records to be returned (works in combination\nwith dateFrom and dateTo if specified)\n" }, { "name": "syncToken", "value": "", "type": "query", "description": "A `syncToken` value from the previous sync response (for `ISync` mode only, mandatory)" }, { "name": "syncType", "value": "", "type": "query", "description": "Type of message synchronization" }, { "name": "voicemailOwner", "value": "", "type": "query", "description": "This query parameter will filter voicemail messages based on its owner.\nThis parameter should be controlled by the 'SharedVoicemail' feature.\nIf the feature is disabled this filter shouldn't be applied.\n" } ] }, "docs": "Synchronizes messages." }, { "info": { "name": "List Messages", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "availability", "value": "", "type": "query", "description": "Specifies the availability status for resulting messages.\nMultiple values are accepted\n" }, { "name": "conversationId", "value": "", "type": "query", "description": "Specifies a conversation identifier for the resulting messages" }, { "name": "dateFrom", "value": "", "type": "query", "description": "Start date/time for resulting messages in ISO 8601 format\nincluding timezone, for example 2016-03-10T18:07:52.534Z. The default value\nis dateTo minus 24 hours\n" }, { "name": "dateTo", "value": "", "type": "query", "description": "End date/time for resulting messages in ISO 8601 format including\ntimezone, for example 2016-03-10T18:07:52.534Z. The default value is current\ntime\n" }, { "name": "direction", "value": "", "type": "query", "description": "Direction for resulting messages. If not specified, both\ninbound and outbound messages are returned. Multiple values are accepted\n" }, { "name": "distinctConversations", "value": "", "type": "query", "description": "If `true`, then the latest messages per every conversation ID\nare returned\n" }, { "name": "messageType", "value": "", "type": "query", "description": "Type of resulting messages. If not specified, all messages\nwithout message type filtering are returned. Multiple values are accepted\n" }, { "name": "readStatus", "value": "", "type": "query", "description": "Read status for resulting messages. Multiple values are\naccepted\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" }, { "name": "phoneNumber", "value": "", "type": "query", "description": "Phone number. If specified, messages are returned for this\nparticular phone number only\n" } ] }, "docs": "Returns a list of messages from an extension mailbox." }, { "info": { "name": "Delete Conversation", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "conversationId", "value": "", "type": "query" }, { "name": "dateTo", "value": "", "type": "query", "description": "Messages received earlier then the date specified will be deleted.\nThe default value is current date/time\n" }, { "name": "type", "value": "", "type": "query", "description": "Type of messages to be deleted" } ] }, "docs": "Deletes conversation(s) by conversation ID(s). Batch request is\nsupported, max number of IDs passed as query/path parameters is 50. Alternative\nsyntax is supported - user conversations can be deleted by passing multiple\nIDs in request body as an array of string, max number of conversation IDs\npassed in request body is 100. In this case asterisk is used in the path instead\nof IDs\n" }, { "info": { "name": "Get Message(s)", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store/:messageId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "messageId", "value": "", "type": "path", "description": "Internal identifier of a message (or multiple messages in case of bulk operation)" } ] }, "docs": "Returns an individual message record or multiple records by the given message ID(s).\nThe length of inbound messages is unlimited. Bulk syntax is supported.\n" }, { "info": { "name": "Update Message(s)", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store/:messageId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "messageId", "value": "", "type": "path", "description": "Internal identifier of a message (or multiple messages in case of bulk operation)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates message(s) by their ID(s). Currently, only the `readStatus`\ncan be updated using this method.\n\nBulk syntax is supported, max number of IDs passed as query/path\nparameters is 50. Alternative bulk syntax is also supported - user messages can be updated\nby passing multiple IDs in request body as an array of string, max number\nof IDs passed in the body is 1000. In this case asterisk is used in the\npath instead of IDs.\n" }, { "info": { "name": "Patch Message(s)", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store/:messageId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "messageId", "value": "", "type": "path", "description": "Internal identifier of a message (or multiple messages in case of bulk operation)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Patches message(s) by ID(s). Currently, only updating the `readStatus` and\nrestoring deleted messages are supported through this method.\n\nFor changing status of a message send `readStatus` set to either 'Read' or 'Unread' in request.\nIt is possible to restore a message and its attachments (if message status is 'Deleted') by sending\n`availability` attribute set to 'Alive' in request body. If a message is already in 'Purged' state\nthen its attachments cannot be restored and the message itself is a" }, { "info": { "name": "Delete Message", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store/:messageId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "messageId", "value": "", "type": "path", "description": "Internal identifier of a message (or multiple messages in case of bulk operation)" }, { "name": "purge", "value": "", "type": "query", "description": "If the value is `true`, then the message is purged immediately\nwith all the attachments\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes message(s) by the given message ID(s). The first call of\nthis method transfers the message to the 'Delete' status. The second call\ntransfers the deleted message to the 'Purged' status. If it is required to\nmake the message 'Purged' immediately (from the first call), then set the\nquery parameter purge to `true`.\n" } ] }, { "info": { "name": "IVR", "type": "folder" }, "items": [ { "info": { "name": "Get IVR Prompt Content", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/ivr-prompts/:promptId/content", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "promptId", "value": "", "type": "path", "description": "Internal identifier of an IVR prompt" }, { "name": "contentDisposition", "value": "", "type": "query", "description": "Whether the content is expected to be displayed in the browser, or downloaded and saved locally" }, { "name": "contentDispositionFilename", "value": "", "type": "query", "description": "The default filename of the file to be downloaded" } ] }, "docs": "Returns media content of an IVR prompt by ID." }, { "info": { "name": "List IVR Prompts", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/ivr-prompts", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns the list of IVR prompts." }, { "info": { "name": "Create IVR Prompts", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/ivr-prompts", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "multipart-form", "data": [ { "name": "attachment", "type": "text", "value": "" }, { "name": "name", "type": "text", "value": "" } ] } }, "docs": "Creates an IVR prompt." }, { "info": { "name": "Get IVR Prompt", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/ivr-prompts/:promptId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "promptId", "value": "", "type": "path", "description": "Internal identifier of an IVR prompt" } ] }, "docs": "Returns an IVR prompt by ID." }, { "info": { "name": "Update IVR Prompt", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/ivr-prompts/:promptId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "promptId", "value": "", "type": "path", "description": "Internal identifier of an IVR prompt" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an IVR prompt by ID" }, { "info": { "name": "Delete IVR Prompt", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/ivr-prompts/:promptId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "promptId", "value": "", "type": "path", "description": "Internal identifier of an IVR prompt" } ] }, "docs": "Deletes an IVR prompt by ID." }, { "info": { "name": "Get IVR Menu list", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/ivr-menus", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns a company IVR menus." }, { "info": { "name": "Create IVR Menu", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/ivr-menus", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a company IVR menu." }, { "info": { "name": "Get IVR Menu", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/ivr-menus/:ivrMenuId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "ivrMenuId", "value": "", "type": "path", "description": "Internal identifier of an IVR menu" } ] }, "docs": "Returns a company IVR menu by ID." }, { "info": { "name": "Update IVR Menu", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/ivr-menus/:ivrMenuId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "ivrMenuId", "value": "", "type": "path", "description": "Internal identifier of an IVR menu" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a company IVR menu by ID." } ] }, { "info": { "name": "Bridge Management", "type": "folder" }, "items": [ { "info": { "name": "Create Bridge", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/rcvideo/v2/account/:accountId/extension/:extensionId/bridges", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Account identifier" }, { "name": "extensionId", "value": "", "type": "path", "description": "Extension identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new bridge for the user specified by **accountId** and **extensionId** identifiers. The request body\nshould contain JSON object which describes properties of the new bridge.\nThe bridge can be created by a user himself, his delegate or any user who has the **Super Admin** privilege.\n" }, { "info": { "name": "Get User's Default Bridge", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/rcvideo/v2/account/:accountId/extension/:extensionId/bridges/default", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Account identifier" }, { "name": "extensionId", "value": "", "type": "path", "description": "Extension identifier" } ] }, "docs": "Returns a default bridge (PMI) for the user specified by **accountId**\nand **extensionId** identifiers.\n" }, { "info": { "name": "Search Bridge by PSTN PIN", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/rcvideo/v2/bridges/pin/pstn/:pin", "params": [ { "name": "pin", "value": "", "type": "path", "description": "Host or Participant PSTN PIN" }, { "name": "phoneNumber", "value": "", "type": "query", "description": "Phone number to find a phone group for PSTN PIN. If it is not specified, then the default phone group will be used.\n" }, { "name": "pw", "value": "", "type": "query", "description": "Bridge hash password" } ] }, "docs": "Finds a bridge by Host or Participant PSTN PIN." }, { "info": { "name": "Search Bridge by Web PIN", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/rcvideo/v2/bridges/pin/web/:pin", "params": [ { "name": "pin", "value": "", "type": "path", "description": "Bridge short identifier (Web PIN) or alias (personal meeting name)" }, { "name": "pw", "value": "", "type": "query", "description": "Bridge hash password" } ] }, "docs": "Finds a bridge by short identifier (Web PIN). Also it can be used to find a default bridge by the alias\n(personal meeting name).\n" }, { "info": { "name": "Get Bridge", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/rcvideo/v2/bridges/:bridgeId", "params": [ { "name": "bridgeId", "value": "", "type": "path", "description": "Bridge identifier" }, { "name": "pw", "value": "", "type": "query", "description": "Bridge hash password" } ] }, "docs": "Returns a bridge by **bridgeId** identifier." }, { "info": { "name": "Update Bridge", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/rcvideo/v2/bridges/:bridgeId", "params": [ { "name": "bridgeId", "value": "", "type": "path", "description": "Bridge identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a bridge by **bridgeId** identifier. The request body should contain JSON object with updating properties.\nUpdate can only be done by bridge owner, his delegate or any user who has the **Super Admin** privilege.\n" }, { "info": { "name": "Delete Bridge", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/rcvideo/v2/bridges/:bridgeId", "params": [ { "name": "bridgeId", "value": "", "type": "path", "description": "Bridge identifier" } ] }, "docs": "Deletes a bridge by **bridgeId** identifier.\nDeletion can only be done by bridge owner, his delegate or any user who has the **Super Admin** privilege.\n" } ] }, { "info": { "name": "Meeting Recordings", "type": "folder" }, "items": [ { "info": { "name": "List Account Recordings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/rcvideo/v1/account/:accountId/recordings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "Token to get the next page" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of records returned" } ] }, "docs": "Returns all account recordings.\nThis endpoint is used in Admin recording service, not regular web\n" }, { "info": { "name": "List User Recordings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/rcvideo/v1/account/:accountId/extension/:extensionId/recordings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "Token to get the next page" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of records returned" } ] }, "docs": "Returns all recordings available for specific extension.\nThis endpoint is used in admin recording service, not regular web\n" } ] }, { "info": { "name": "Delegation Management", "type": "folder" }, "items": [ { "info": { "name": "Get Delegators", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/rcvideo/v1/accounts/:accountId/extensions/:extensionId/delegators", "params": [ { "name": "accountId", "value": "", "type": "path" }, { "name": "extensionId", "value": "", "type": "path" } ] }, "docs": "Returns the list of users who can delegate bridge/meeting creation to the given user." } ] }, { "info": { "name": "Meetings History", "type": "folder" }, "items": [ { "info": { "name": "List Video Meetings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/rcvideo/v1/history/meetings", "params": [ { "name": "text", "value": "", "type": "query", "description": "Search text" }, { "name": "pageToken", "value": "", "type": "query", "description": "Token to get the next page" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of records returned" }, { "name": "type", "value": "", "type": "query", "description": "Specify what kind of meeting should be returned. Possible values: All, My, Deleted, Shared\nRequest type meaning in meeting search:\n`None` (not passed) - take meetings only where requested acc/ext is participant OR host OR deputy OR watcher.\n`ALL`- access rights of meeting is equal to Alive AND requested acc/ext is in watchers list OR host OR deputy\n`My`- access rights of meeting is equal to Alive AND requested acc/ext is host OR deputy\n`Shared` - access rights of meeting is equal to Alive AND requested acc/ext is in watcher list AND not HOST\n`Deleted` - access rights of meeting is equal to Delete and requested acc/ext is host OR deputy\n" }, { "name": "startTime", "value": "", "type": "query", "description": "Unix timestamp in milliseconds (inclusive) indicates the start time of meetings which should be included in response" }, { "name": "endTime", "value": "", "type": "query", "description": "Unix timestamp in milliseconds (inclusive) indicates the end time of meetings which should be included in response" } ] }, "docs": "Returns the list of user meetings." }, { "info": { "name": "Get Video Meeting", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/rcvideo/v1/history/meetings/:meetingId", "params": [ { "name": "meetingId", "value": "", "type": "path", "description": "Meeting id" } ] }, "docs": "Returns a user meeting by ID." } ] }, { "info": { "name": "API Info", "type": "folder" }, "items": [ { "info": { "name": "Get API Versions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi" }, "docs": "Returns current API version(s) and server info." }, { "info": { "name": "Get Version Info", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/:apiVersion", "params": [ { "name": "apiVersion", "value": "", "type": "path", "description": "API version to be requested, for example 'v1.0'" } ] }, "docs": "Returns current API version info by apiVersion." } ] }, { "info": { "name": "OAuth 2.0 / OpenID Connect", "type": "folder" }, "items": [ { "info": { "name": "OAuth 2.0 Token Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/oauth/token", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns access (and potentially refresh) tokens for making API requests.\n\nFor confidential client application types\nthis endpoint requires client authentication using one of the supported\nmethods (`client_secret_basic`, `client_secret_jwt` or `private_key_jwt`)\n\nFor non-confidential client application types\nthe client identifier must be provided via `client_id` request attribute.\n" }, { "info": { "name": "OAuth 2.0 Authorization Endpoint", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/oauth/authorize", "params": [ { "name": "client_id", "value": "", "type": "query", "description": "The registered identifier of a client application" }, { "name": "response_type", "value": "", "type": "query", "description": "Determines authorization flow type. The only supported value is `code` which corresponds to OAuth 2.0 \"Authorization Code Flow\"\n" }, { "name": "redirect_uri", "value": "", "type": "query", "description": "This is the URI where the Authorization Server redirects the User Agent to at the end of the authorization flow.\nThe value of this parameter must exactly match one of the URIs registered for this client application.\nThis parameter is required if there are more than one redirect URIs registered for the app.\n" }, { "name": "state", "value": "", "type": "query", "description": "An opaque value used by the client to maintain state between the request and callback.\nThe authorization server includes this value when redirecting the User Agent back\nto the client. The parameter SHOULD be used for preventing cross-site request forgery attacks.\n" }, { "name": "scope", "value": "", "type": "query", "description": "The list of space separated application permissions (OAuth scopes)" }, { "name": "display", "value": "", "type": "query", "description": "Specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User.\n" }, { "name": "prompt", "value": "", "type": "query", "description": "Space-delimited, case-sensitive list of ASCII string values that specifies whether the Authorization Server prompts the End-User for\nre-authentication and consent. The defined values are:\n\n- `login` - RingCentral native login form,\n- `sso` - Single Sign-On login form,\n- `consent` - form to show the requested scope and prompt user for consent.\n\nEither `login` or `sso` (or both) must be specified. The default\nvalue is `login sso`\n" }, { "name": "ui_locales", "value": "", "type": "query", "description": "End-User's preferred languages and scripts for the user interface, represented as a space-separated list of\n[RFC-5646](https://datatracker.ietf.org/doc/html/rfc5646) language tag values, ordered by preference.\n\nIf this parameter is provided, its value overrides 'Accept-Language' header value and 'localeId' parameter value (if any)\n" }, { "name": "localeId", "value": "", "type": "query", "description": "DEPRECATED: `ui_locales` parameter should be used instead" }, { "name": "code_challenge", "value": "", "type": "query", "description": "The code challenge value as defined by the PKCE specification -\n[RFC-7636 \"Proof Key for Code Exchange by OAuth Public Clients\"](https://datatracker.ietf.org/doc/html/rfc7636)\n" }, { "name": "code_challenge_method", "value": "", "type": "query", "description": "The code challenge method as defined by by the PKCE specification -\n[RFC-7636 \"Proof Key for Code Exchange by OAuth Public Clients\"](https://datatracker.ietf.org/doc/html/rfc7636)\n" }, { "name": "nonce", "value": "", "type": "query", "description": "String value used to associate a Client session with an ID Token, and to mitigate replay attacks. The value is passed through unmodified from the Authentication Request to the ID Token.\n" }, { "name": "ui_options", "value": "", "type": "query", "description": "Login form user interface options (space-separated). By default, the UI options that are registered for this client application will be used\n" }, { "name": "login_hint", "value": "", "type": "query", "description": "Hint to the Authorization Server about the login identifier the End-User might use to log in." }, { "name": "brand_id", "value": "", "type": "query", "description": "RingCentral Brand identifier. If it is not provided in the request,\nserver will try to determine brand from the client application profile.\n" } ] }, "docs": "Performs Authentication of the End-User by sending the User Agent to the Authorization Server's\nAuthorization Endpoint for Authentication and Authorization,\nusing request parameters defined by OAuth 2.0 [RFC-6749](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1)\nand additional parameters and parameter values defined by\n[OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint).\n\nThis is the version that uses HTTP `GET` method.\n" }, { "info": { "name": "OAuth 2.0 Authorization Endpoint (POST)", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/oauth/authorize", "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Performs Authentication of the End-User by sending the User Agent to the Authorization Server's\nAuthorization Endpoint for Authentication and Authorization,\nusing request parameters defined by OAuth 2.0 [RFC-6749](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1)\nand additional parameters and parameter values defined by\n[OpenID Connect Core 1.0](https://openid.net/specs/openid-connect-core-1_0.html#AuthorizationEndpoint).\n\nThis is the version that uses HTTP `POST` method.\n" }, { "info": { "name": "OAuth 2.0 Token Revocation Endpoint", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/oauth/revoke", "params": [ { "name": "token", "value": "", "type": "query", "description": "Access or refresh token to be revoked (along with the entire OAuth session)" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Revokes all active access/refresh tokens and invalidates the OAuth session basing on token provided.\nThe `token` parameter may be passed in query string or body and may represent access or refresh token.\n\nThis endpoint is defined by [RFC-7009 \"OAuth 2.0 Token Revocation\"](https://datatracker.ietf.org/doc/html/rfc7009)\n\nFor confidential client application types\nthis endpoint requires client authentication using one of the supported\nmethods (`client_secret_basic`, `client_secret_jwt` or `private_k" } ] }, { "info": { "name": "Company", "type": "folder" }, "items": [ { "info": { "name": "Get Account Info", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns basic information about particular RingCentral account" }, { "info": { "name": "Send/Resend Welcome Email", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/send-welcome-email", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Sends/resends welcome email to the system user of confirmed account" }, { "info": { "name": "Send/Resend Activation Email", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/send-activation-email", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Sends/resends activation email to the system user of unconfirmed account." }, { "info": { "name": "Get Account Info", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns basic information about a particular RingCentral customer account.\n" }, { "info": { "name": "Get Account Service Info", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/service-info", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns the information about service plan, available features\nand limitations for a particular RingCentral customer account.\n" }, { "info": { "name": "Get Account Business Address", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/business-address", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns business address of a company.\n" }, { "info": { "name": "Update Company Business Address", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/business-address", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the business address of a company that account is linked\nto.\n" }, { "info": { "name": "List Contracted Countries", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/brand/:brandId/contracted-country", "params": [ { "name": "brandId", "value": "", "type": "path" } ] }, "docs": "Returns the list of contracted countries for the given brand." }, { "info": { "name": "List Domestic Countries", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/brand/:brandId/contracted-country/:contractedCountryId", "params": [ { "name": "brandId", "value": "", "type": "path", "description": "Internal identifier of a brand" }, { "name": "contractedCountryId", "value": "", "type": "path", "description": "Internal identifier of a country" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" } ] }, "docs": "Returns the list of domestic countries for account contracted country and brand.\n" } ] }, { "info": { "name": "Devices", "type": "folder" }, "items": [ { "info": { "name": "Add Phone to Inventory", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/device-inventory", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds an existing phone (customer provided device - BYOD) as an unassigned device to the account inventory." }, { "info": { "name": "Delete Device from Inventory", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/device-inventory", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes an existing unassigned (without digital line or phone number) device or multiple devices\nfrom the account inventory. It is possible to delete up to 10 devices per request.\n" }, { "info": { "name": "Remove phone line", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/devices/:deviceId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "deviceId", "value": "65462346462", "type": "path", "description": "Internal identifier of a source device" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disassociates a phone line (DL & Device) from an extension:\n\n - if the value of `keepAssetsInInventory` is `true`,\nthe given device is moved to unassigned devices and the number is moved to the number inventory;\n - if the value of `keepAssetsInInventory` is `false`, the given device and number is removed from the account;\n - if the parameter `keepAssetsInInventory` is not set (empty body), default value `true` is set.\n" }, { "info": { "name": "Add BYOD Devices", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/devices/bulk-add", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds multiple BYOD (customer provided) devices to an account." }, { "info": { "name": "Swap Devices", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/extensions/:extensionId/devices/:deviceId/replace", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "deviceId", "value": "65462346462", "type": "path", "description": "Internal identifier of a source device that is currently assigned to the given extension" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces the user device with another device, which is assigned to an extension\nor is stored in the inventory of the same account.\nCurrently, the following device types can be swapped - `HardPhone` and `OtherPhone`.\n\nPlease note:\n\n - This method allows replacing a device itself, while a phone number,\n a digital Line and an emergency address associated with this device remain unchanged\n and will still work together in a chain with the replacement device.\n - If a target device is from the inve" }, { "info": { "name": "Get Device", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/device/:deviceId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "deviceId", "value": "", "type": "path", "description": "Internal identifier of a device" }, { "name": "syncEmergencyAddress", "value": "", "type": "query", "description": "Specifies if an emergency address should be synchronized or not" } ] }, "docs": "Returns account device(s) by their ID(s)." }, { "info": { "name": "Update Device", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/device/:deviceId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "deviceId", "value": "", "type": "path", "description": "Internal identifier of a device" }, { "name": "prestatement", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates account device(s) by their ID(s)." }, { "info": { "name": "Get Device SIP Info", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/device/:deviceId/sip-info", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "deviceId", "value": "", "type": "path", "description": "Internal identifier of a device" } ] }, "docs": "Returns device SIP information." }, { "info": { "name": "Update Device Emergency Info", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/device/:deviceId/emergency", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "deviceId", "value": "", "type": "path", "description": "Internal identifier of a device" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates account device emergency information." }, { "info": { "name": "List Extension Devices", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/device", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "linePooling", "value": "", "type": "query", "description": "Pooling type of device - Host - a device with standalone paid phone line which can be linked to a soft client instance - Guest - a device with a linked phone line - None - a device without a phone line or with specific line (free, BLA, etc.)" }, { "name": "feature", "value": "", "type": "query", "description": "Device feature or multiple features supported" }, { "name": "type", "value": "", "type": "query", "description": "Device type" }, { "name": "lineType", "value": "", "type": "query", "description": "Phone line type" } ] }, "docs": "Returns devices of an extension or multiple extensions by their ID(s). Batch request\nis supported.\n" } ] }, { "info": { "name": "Phone Numbers", "type": "folder" }, "items": [ { "info": { "name": "List Account Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/phone-numbers", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "type", "value": "", "type": "query", "description": "Types of phone numbers to be returned" }, { "name": "usageType", "value": "", "type": "query", "description": "Usage type(s) of phone numbers to be returned" }, { "name": "status", "value": "", "type": "query", "description": "Status of the phone number(s) to be returned" }, { "name": "tollType", "value": "", "type": "query", "description": "Toll type of phone numbers to return" }, { "name": "extensionStatus", "value": "", "type": "query", "description": "Statuses of extensions to return phone numbers for" }, { "name": "byocNumber", "value": "", "type": "query", "description": "The parameter reflects whether this number is BYOC or not" }, { "name": "phoneNumber", "value": "", "type": "query", "description": "Phone number in e.164 format to be searched for.\nParameter value can include wildcards (e.g. \"+165012345**\")\nor be an exact number \"+16501234500\" - single number is searched in that case.\nMake sure you escape the \"+\" in the URL as \"%2B\"\n" } ] }, "docs": "Returns the list of phone numbers assigned to RingCentral customer\naccount. Both company-level and extension-level numbers are returned.\nConferencing numbers, hot desk and ELIN numbers are not returned.\n" }, { "info": { "name": "Delete Numbers from Inventory", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/phone-numbers", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "This method can only delete numbers that meet one of the following requirements:\n - numbers that have `\"usageType\": \"Inventory\"`\n - `\"Forwarded\"` numbers\n - `\"Forwarded Company\"` numbers\n\nIn other words, this method will not delete numbers which are in use on the account - extension direct numbers,\nmain number, etc. It is possible to indicate phone numbers to be deleted using their IDs or exact string values\nin e.164 format. However, the same lookup method (by ID or by value) must be used for" }, { "info": { "name": "Assign Phone Number", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "phoneNumberId", "value": "1162820004", "type": "path", "description": "Internal identifier of a phone number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns or reassigns a phone number as a company or extension number.\n\nAssign scenarios supported:\n- from Inventory to a company number;\n- from Inventory to an extension number.\n\nReassign scenarios supported:\n- from an extension to another extension;\n- from an extension to a company number;\n- from a company number to an extension.\n" }, { "info": { "name": "Replace Phone Number", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId/replace", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "phoneNumberId", "value": "1162820004", "type": "path", "description": "Internal identifier of a phone number" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replaces (swaps) phone numbers from Inventory with the main, company, direct or company fax numbers.\nThis method is used to replace temporary numbers when the porting process is complete.\n" }, { "info": { "name": "Add Numbers to Inventory", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/phone-numbers/bulk-add", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds phone numbers to the account Inventory as unassigned. Currently, we support the following values: `Inventory`,\n`InventoryPartnerBusinessMobileNumber` and `PartnerBusinessMobileNumber`. Later we may support some other values like `ForwardedNumber`, etc.\n" }, { "info": { "name": "Get Add Numbers Task Results", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v2/accounts/:accountId/phone-numbers/bulk-add/:taskId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "taskId", "value": "", "type": "path", "description": "Identifier of a task returned by asynchronous bulk add operation" } ] }, "docs": "Returns the result of asynchronous operation which adds phone numbers to the account Inventory.\n" }, { "info": { "name": "Get Extension Phone Number List", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/phone-number", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "status", "value": "", "type": "query", "description": "Status of a phone number" }, { "name": "usageType", "value": "", "type": "query", "description": "Usage type of phone number" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare allowed. Default value is '1'\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items). If not specified, the value is '100' by default" } ] }, "docs": "Returns the list of phone numbers that are used by a particular extension,\ncan be filtered by the phone number type. The returned list contains all\nnumbers which are directly mapped to the given extension. Plus the features\nand company-level numbers that may be used when performing different operations\non behalf of this extension.\n" }, { "info": { "name": "List Company Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/phone-number", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" }, { "name": "usageType", "value": "", "type": "query", "description": "Usage type of phone number" }, { "name": "paymentType", "value": "", "type": "query", "description": "Payment Type of the number" }, { "name": "status", "value": "", "type": "query", "description": "Status of a phone number" } ] }, "docs": "Returns the list of phone numbers assigned to RingCentral customer\naccount. Both company-level and extension-level numbers are returned.\n" }, { "info": { "name": "Get Phone Number", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/phone-number/:phoneNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "phoneNumberId", "value": "", "type": "path", "description": "Internal identifier of a phone number" } ] }, "docs": "Returns phone number(s) belonging to a certain account or extension by phoneNumberId(s).\n[Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.\n" }, { "info": { "name": "Parse Phone Number(s)", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/number-parser/parse", "params": [ { "name": "homeCountry", "value": "", "type": "query", "description": "ISO 3166 alpha2 code of the home country to be used if it is impossible to determine country from the number itself.\nBy default, this parameter is preset to the current user's home country or brand country if the user is undefined\n" }, { "name": "nationalAsPriority", "value": "", "type": "query", "description": "The default value is `false`. If `true`, the numbers that are\ncloser to the home country are given higher priority\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns one or more parsed and/or formatted phone numbers that are passed as strings." } ] }, { "info": { "name": "Business Hours", "type": "folder" }, "items": [ { "info": { "name": "Get Company Business Hours", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/business-hours", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns the company business hours schedule. Business hours (and After hours - all the remaining time) schedules are commonly used for setting call handling rules - `business-hours-rule` and `after-hours-rule` correspondingly." }, { "info": { "name": "Update Company Business Hours", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/business-hours", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the company business hours schedule." }, { "info": { "name": "Get User Business Hours", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/business-hours", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns the user business hours schedule. Business hours (and After hours - all the remaining time) schedules are commonly used for setting call handling rules - `business-hours-rule` and `after-hours-rule` correspondingly. **Please note:** If the user business hours are set to 'Custom hours' then a particular schedule is returned; however if set to '24 hours/7 days a week' the schedule will be empty." }, { "info": { "name": "Update User Business Hours", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/business-hours", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the user business hours schedule." } ] }, { "info": { "name": "Custom Fields", "type": "folder" }, "items": [ { "info": { "name": "Get Custom Field List", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/custom-fields", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns the list of created custom fields." }, { "info": { "name": "Create Custom Field", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/custom-fields", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates custom field attached to the object." }, { "info": { "name": "Update Custom Field", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/custom-fields/:fieldId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "fieldId", "value": "", "type": "path", "description": "Custom field identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates custom field by ID specified in path." }, { "info": { "name": "Delete Custom Field", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/custom-fields/:fieldId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "fieldId", "value": "", "type": "path", "description": "Custom field identifier" } ] }, "docs": "Deletes custom field(s) by ID(s) with the corresponding values." } ] }, { "info": { "name": "Call Recording Settings", "type": "folder" }, "items": [ { "info": { "name": "Get Call Recording Settings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-recording", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns call recording settings." }, { "info": { "name": "Update Call Recording Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-recording", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates current call recording settings." }, { "info": { "name": "Get Call Recording Custom Greeting List", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-recording/custom-greetings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "type", "value": "", "type": "query" } ] }, "docs": "Returns call recording custom greetings." }, { "info": { "name": "Delete Call Recording Custom Greeting List", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-recording/custom-greetings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Deletes call recording custom greetings." }, { "info": { "name": "Delete Call Recording Custom Greeting", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-recording/custom-greetings/:greetingId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "greetingId", "value": "", "type": "path", "description": "Internal identifier of a greeting" } ] }, "docs": "Deletes call recording custom greeting(s)." }, { "info": { "name": "Update Call Recording Extension List", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-recording/bulk-assign", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates or updates the list of extensions to be recorded." }, { "info": { "name": "Get Call Recording Extension List", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-recording/extensions", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns the list of extensions to be recorded." } ] }, { "info": { "name": "Call Control", "type": "folder" }, "items": [ { "info": { "name": "Make CallOut", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/call-out", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new outbound call out session. Currently this method is supported for Softphone/Hardphone only, since device IDs for WebRTC/Mobile apps cannot be obtained." }, { "info": { "name": "Start Conference Call Session", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/conference", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Initiates a conference call session." }, { "info": { "name": "Get Call Session Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "timestamp", "value": "", "type": "query", "description": "The date and time of a call session latest change" }, { "name": "timeout", "value": "", "type": "query", "description": "The time frame of awaiting for a status change before sending\nthe resulting one in response\n" } ] }, "docs": "Returns the status of a call session by ID." }, { "info": { "name": "Drop Call Session", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" } ] }, "docs": "Drops a call session." }, { "info": { "name": "Bring-In Call Party", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/bring-in", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new party to the call session by bringing in an established\nSIP call connection. The maximum number of parties to bring in is 10; only\n1 call party can be added per request. Currently, the method is supported for\nsessions of the `Conference` origin only.\n" }, { "info": { "name": "Get Call Party Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ] }, "docs": "Returns a call party status by ID." }, { "info": { "name": "Update Call Party", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a call party by ID. There is a known limitation for Mute scenario - mute via REST API doesn't work with mute placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app you need to unmute both endpoints to bring the media back." }, { "info": { "name": "Delete Call Party", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ] }, "docs": "Deletes a party from a call session by ID. A party can be deleted only if supervised or parked. It is possible to delete only one conference participant per request." }, { "info": { "name": "Un-hold Call Party", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/unhold", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ] }, "docs": "Brings a party back into a call and stops to play Hold Music. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to un-hold both endpoints to remove Hold Music and bring media back." }, { "info": { "name": "Call Park", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/park", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ] }, "docs": "Parks a call to a virtual location from where it can further be retrieved by any user from any phone of the system. The call session and call party identifiers should be specified in path. Currently, the users can park only their own incoming calls. Up to 50 calls can be parked simultaneously. Park location starts with asterisk (*) and ranges 801-899." }, { "info": { "name": "Call Flip on Party", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/flip", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Performs call flip procedure by holding opposite party and calling to the specified target" }, { "info": { "name": "Reply with Text", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reply", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replies with text/pattern without picking up a call." }, { "info": { "name": "Bridge Call Party", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/bridge", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows the user to connect multiple call session participants over a conference call bridge.\nThe current active call session ID and party ID of the user within this session should be specified\nin path; the bridged call session ID and party ID of the user within that session should be specified\nin request body. Thus, the user connects participants of two sessions into the one conference call\nusing his/her own party IDs from both sessions.\"\n" }, { "info": { "name": "Ignore Call in Queue", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/ignore", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Ignores a call to a call queue agent in `Setup` or `Proceeding` state." }, { "info": { "name": "Supervise Call Party", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/supervise", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows to monitor a call party in 'Listen' mode. Input parameters\nare extension number of a monitored user and internal identifier of a supervisor's\ndevice. Call session and party identifiers should be specified in path. Please\nnote that for this method dual channel audio flow is supported, which means\nthat you need to make one more request for monitoring the second participant\nof a call. And as a result of each monitoring request the client receives\nSIP invite with the following header `p-rc-ap" }, { "info": { "name": "Reject Call Party", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reject", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ] }, "docs": "Rejects an inbound call in a \"Setup\" or \"Proceeding\" state" }, { "info": { "name": "Create Recording", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ] }, "docs": "Starts a new call recording for the party" }, { "info": { "name": "Pause/Resume Recording", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings/:recordingId", "params": [ { "name": "brandId", "value": "", "type": "query", "description": "Identifies a brand of a logged-in user or a brand of a sign-up session" }, { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" }, { "name": "recordingId", "value": "", "type": "path", "description": "Internal identifier of a recording" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pause/resume recording" }, { "info": { "name": "Answer Call Party", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/answer", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Answers a call on a certain device by passing the corresponding device ID in request body. Supported for call forwarding, call transfer, call flip and call queues." }, { "info": { "name": "Transfer Call Party", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/transfer", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Transfers an answered call to the specified call party. Applicable for a call session in \"Answered\" or \"Hold\" state." }, { "info": { "name": "Hold Call Party", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/hold", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Puts the party to stand-alone mode and starts to play Hold Music according to configuration & state to peers. There is a known limitation for Hold API - hold via REST API doesn't work with hold placed via RingCentral apps or HardPhone. It means that if you muted participant via Call Control API and RingCentral Desktop app, then you need to un-hold both endpoints to remove Hold Music and bring media back." }, { "info": { "name": "Pickup Call", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/pickup", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Picks up a call parked to the specified park location." }, { "info": { "name": "Forward Call Party", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/forward", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" }, { "name": "partyId", "value": "", "type": "path", "description": "Internal identifier of a call party" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Forwards a non-answered incoming call to the specified call party. Applicable for a call session in \"Setup\" or \"Proceeding\" state." }, { "info": { "name": "Supervise Call Session", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/supervise", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "telephonySessionId", "value": "", "type": "path", "description": "Internal identifier of a call session" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows monitoring a call session in 'Listen' mode. Input parameters should contain internal identifiers of a monitored user and a supervisor's device. Call session should be specified in path. Please note that this method supports single channel audio flow, which means that audio of both call participants is mixed and delivered to the supervisor in single audio channel. Currently this method is supported for Softphone/Hardphone only, since device IDs for WebRTC/Mobile apps cannot be obtained." } ] }, { "info": { "name": "SMS Templates", "type": "folder" }, "items": [ { "info": { "name": "List Company Message Templates", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-templates", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteIds", "value": "", "type": "query", "description": "Site ID(s) to filter company message templates, associated with particular sites\nBy default the value is all - templates with all sites will be returned\n" } ] }, "docs": "Returns a list of company text message templates." }, { "info": { "name": "Create Company Message Template", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-templates", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new text message template on a company level. Maximum number of company templates is 50." }, { "info": { "name": "Get Company Message Template", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ] }, "docs": "Returns a company text message template by ID." }, { "info": { "name": "Update Company Message Template", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a company text message template." }, { "info": { "name": "Delete Company Message Template", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ] }, "docs": "Deletes a company text message template." }, { "info": { "name": "List User Message Templates", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store-templates", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "siteIds", "value": "", "type": "query", "description": "Site ID(s) to filter user message templates, associated with particular sites.\nBy default the value is all - templates with all sites will be returned\n" }, { "name": "scope", "value": "", "type": "query", "description": "Message templates scope. By default the value is all - both Personal and Company templates will be returned" } ] }, "docs": "Returns a list of user's personal text message templates." }, { "info": { "name": "Create User Message Template", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store-templates", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a user personal text message template. \nMaximum number of personal templates is 25 per user. \nMax length of the `body` property is 1000 symbols (2-byte UTF-16 encoded).\n" }, { "info": { "name": "Get User Message Template", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ] }, "docs": "Returns a user personal text message template by ID." }, { "info": { "name": "Update User Message Template", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user personal text message template." }, { "info": { "name": "Delete User Message Template", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/message-store-templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a text message template" } ] }, "docs": "Deletes a user personal text message template." } ] }, { "info": { "name": "Call Log", "type": "folder" }, "items": [ { "info": { "name": "List Company Call Records", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-log", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionNumber", "value": "101", "type": "query", "description": "Short extension number of a user. If specified, returns call log for this particular extension only.\nCannot be combined with `phoneNumber` filter\n" }, { "name": "phoneNumber", "value": "12053320032", "type": "query", "description": "Phone number of a caller/callee in e.164 format without a '+' sign. If specified, all incoming/outgoing calls\nfrom/to this phone number are returned.\n" }, { "name": "direction", "value": "", "type": "query", "description": "The direction of call records to be included in the result. If omitted, both\ninbound and outbound calls are returned. Multiple values are supported\n" }, { "name": "type", "value": "", "type": "query", "description": "The type of call records to be included in the result.\nIf omitted, all call types are returned. Multiple values are supported\n" }, { "name": "view", "value": "", "type": "query", "description": "Defines the level of details for returned call records\n" }, { "name": "withRecording", "value": "", "type": "query", "description": "Deprecated, replaced with `recordingType` filter, still supported for compatibility reasons.\nIndicates if only recorded calls should be returned.\n\nIf both `withRecording` and `recordingType` parameters are specified, then `withRecording` is ignored\n" }, { "name": "recordingType", "value": "", "type": "query", "description": "Indicates that call records with recordings of particular type should be returned.\nIf omitted, then calls with and without recordings are returned\n" }, { "name": "dateFrom", "value": "", "type": "query", "description": "The beginning of the time range to return call records in ISO 8601 format including timezone,\nfor example 2016-03-10T18:07:52.534Z. The default value is `dateTo` minus 24 hours\n" }, { "name": "dateTo", "value": "", "type": "query", "description": "The end of the time range to return call records in ISO 8601 format including timezone,\nfor example 2016-03-10T18:07:52.534Z. The default value is current time\n" }, { "name": "sessionId", "value": "", "type": "query", "description": "Internal identifier of a call session" }, { "name": "telephonySessionId", "value": "", "type": "query", "description": "Internal identifier of a telephony session" }, { "name": "page", "value": "", "type": "query", "description": "Indicates the page number to retrieve. Only positive number values are accepted" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates the page size (number of items)" } ] }, "docs": "Returns call log records filtered by parameters specified." }, { "info": { "name": "Get Company Call Record(s)", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-log/:callRecordId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "callRecordId", "value": "", "type": "path", "description": "Internal identifier of a call log record. Multiple values are supported" }, { "name": "view", "value": "", "type": "query", "description": "Defines the level of details for returned call records\n" } ] }, "docs": "Returns individual call log record(s) by ID. Batch syntax is supported." }, { "info": { "name": "Sync Company Call Log", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-log-sync", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "syncType", "value": "", "type": "query", "description": "Type of call log synchronization request" }, { "name": "syncToken", "value": "", "type": "query", "description": "Value of syncToken property of last sync request response. Mandatory parameter for 'ISync' sync type" }, { "name": "dateFrom", "value": "", "type": "query", "description": "The start datetime for resulting records in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z. The default value is the current moment" }, { "name": "recordCount", "value": "", "type": "query", "description": "For `FSync` mode this parameter is mandatory, it limits the number of records to be returned in response.\n\nFor `ISync` mode this parameter specifies the number of records to extend the sync frame with to the past\n(the maximum number of records is 250)\n" }, { "name": "statusGroup", "value": "", "type": "query", "description": "Type of calls to be returned" }, { "name": "view", "value": "", "type": "query", "description": "Defines the level of details for returned call records\n" }, { "name": "showDeleted", "value": "", "type": "query", "description": "Supported for `ISync` mode. Indicates that deleted call records should be returned" }, { "name": "withRecording", "value": "", "type": "query", "description": "Deprecated, replaced with `recordingType` filter, still supported for compatibility reasons.\nIndicates if only recorded calls should be returned.\n\nIf both `withRecording` and `recordingType` parameters are specified, then `withRecording` is ignored\n" }, { "name": "recordingType", "value": "", "type": "query", "description": "Indicates that call records with recordings of particular type should be returned.\nIf omitted, then calls with and without recordings are returned\n" } ] }, "docs": "Synchronizes company call log records." }, { "info": { "name": "List Company Active Calls", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/active-calls", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "direction", "value": "", "type": "query", "description": "The direction of call records to be included in the result. If omitted, both\ninbound and outbound calls are returned. Multiple values are supported\n" }, { "name": "view", "value": "", "type": "query", "description": "Defines the level of details for returned call records\n" }, { "name": "type", "value": "", "type": "query", "description": "The type of call records to be included in the result.\nIf omitted, all call types are returned. Multiple values are supported\n" }, { "name": "transport", "value": "", "type": "query", "description": "The type of call transport. Multiple values are supported. By default, this filter is disabled\n" }, { "name": "conferenceType", "value": "", "type": "query", "description": "Conference call type: RCC or RC Meetings. If not specified, no conference call filter applied\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates the page number to retrieve. Only positive number values are accepted" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates the page size (number of items)" } ] }, "docs": "Returns records of all calls that are in progress, ordered by start time in descending order." }, { "info": { "name": "List User Call Records", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/call-log", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "extensionNumber", "value": "101", "type": "query", "description": "Short extension number of a user. If specified, returns call log for this particular extension only.\nCannot be combined with `phoneNumber` filter\n" }, { "name": "phoneNumber", "value": "12053320032", "type": "query", "description": "Phone number of a caller/callee in e.164 format without a '+' sign. If specified, all incoming/outgoing calls\nfrom/to this phone number are returned.\n" }, { "name": "showBlocked", "value": "", "type": "query", "description": "Indicates then calls from/to blocked numbers are returned" }, { "name": "direction", "value": "", "type": "query", "description": "The direction of call records to be included in the result. If omitted, both\ninbound and outbound calls are returned. Multiple values are supported\n" }, { "name": "sessionId", "value": "", "type": "query", "description": "Internal identifier of a call session" }, { "name": "type", "value": "", "type": "query", "description": "The type of call records to be included in the result.\nIf omitted, all call types are returned. Multiple values are supported\n" }, { "name": "transport", "value": "", "type": "query", "description": "The type of call transport. Multiple values are supported. By default, this filter is disabled\n" }, { "name": "view", "value": "", "type": "query", "description": "Defines the level of details for returned call records\n" }, { "name": "withRecording", "value": "", "type": "query", "description": "Deprecated, replaced with `recordingType` filter, still supported for compatibility reasons.\nIndicates if only recorded calls should be returned.\n\nIf both `withRecording` and `recordingType` parameters are specified, then `withRecording` is ignored\n" }, { "name": "recordingType", "value": "", "type": "query", "description": "Indicates that call records with recordings of particular type should be returned.\nIf omitted, then calls with and without recordings are returned\n" }, { "name": "dateTo", "value": "", "type": "query", "description": "The end of the time range to return call records in ISO 8601 format including timezone,\nfor example 2016-03-10T18:07:52.534Z. The default value is current time\n" }, { "name": "dateFrom", "value": "", "type": "query", "description": "The beginning of the time range to return call records in ISO 8601 format including timezone,\nfor example 2016-03-10T18:07:52.534Z. The default value is `dateTo` minus 24 hours\n" }, { "name": "telephonySessionId", "value": "", "type": "query", "description": "Internal identifier of a telephony session" }, { "name": "page", "value": "", "type": "query", "description": "Indicates the page number to retrieve. Only positive number values are allowed" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates the page size (number of items). The default value is 100.\nThe maximum value for `Simple` view is 1000, for `Detailed` view - 250\n" }, { "name": "showDeleted", "value": "", "type": "query", "description": "Indicates that deleted calls records should be returned" } ] }, "docs": "Returns call log records filtered by parameters specified." }, { "info": { "name": "Delete User Call Records", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/call-log", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "dateTo", "value": "", "type": "query", "description": "The time boundary to delete all older records in ISO 8601 format including\ntimezone, for example *2016-03-10T18:07:52.534Z*. The default value is current time\n" } ] }, "docs": "Deletes filtered call log records." }, { "info": { "name": "Get User Call Record(s)", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/call-log/:callRecordId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "callRecordId", "value": "", "type": "path", "description": "Internal identifier of a call log record. Multiple values are supported" }, { "name": "view", "value": "", "type": "query", "description": "Defines the level of details for returned call records\n" } ] }, "docs": "Returns call log records by ID." }, { "info": { "name": "Sync User Call Log", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/call-log-sync", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "syncType", "value": "", "type": "query", "description": "Type of call log synchronization request" }, { "name": "syncToken", "value": "", "type": "query", "description": "A `syncToken` value from the previous sync response (for `ISync` mode only, mandatory)" }, { "name": "dateFrom", "value": "", "type": "query", "description": "The start datetime for resulting records in ISO 8601 format including\ntimezone, for example 2016-03-10T18:07:52.534Z. The default value is the\ncurrent moment\n" }, { "name": "recordCount", "value": "", "type": "query", "description": "For `FSync` mode this parameter is mandatory, it limits the number of records to be returned in response.\n\nFor `ISync` mode this parameter specifies the number of records to extend the sync frame with to the past\n(the maximum number of records is 250)\n" }, { "name": "statusGroup", "value": "", "type": "query", "description": "Type of calls to be returned" }, { "name": "view", "value": "", "type": "query", "description": "Defines the level of details for returned call records\n" }, { "name": "showDeleted", "value": "", "type": "query", "description": "Supported for `ISync` mode. Indicates that deleted call records should be returned" }, { "name": "withRecording", "value": "", "type": "query", "description": "Deprecated, replaced with `recordingType` filter, still supported for compatibility reasons.\nIndicates if only recorded calls should be returned.\n\nIf both `withRecording` and `recordingType` parameters are specified, then `withRecording` is ignored\n" }, { "name": "recordingType", "value": "", "type": "query", "description": "Indicates that call records with recordings of particular type should be returned.\nIf omitted, then calls with and without recordings are returned\n" } ] }, "docs": "Synchronizes the user call log records." }, { "info": { "name": "List User Active Calls", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/active-calls", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "direction", "value": "", "type": "query", "description": "The direction of call records to be included in the result. If omitted, both\ninbound and outbound calls are returned. Multiple values are supported\n" }, { "name": "view", "value": "", "type": "query", "description": "Defines the level of details for returned call records\n" }, { "name": "type", "value": "", "type": "query", "description": "The type of call records to be included in the result.\nIf omitted, all call types are returned. Multiple values are supported\n" }, { "name": "transport", "value": "", "type": "query", "description": "The type of call transport. Multiple values are supported. By default, this filter is disabled\n" }, { "name": "conferenceType", "value": "", "type": "query", "description": "Conference call type: RCC or RC Meetings. If not specified, no conference call filter applied\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates the page number to retrieve. Only positive number values are allowed" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates the page size (number of items)" } ] }, "docs": "Returns records of all extension calls that are in progress, ordered\nby start time in descending order.\n" } ] }, { "info": { "name": "Extensions", "type": "folder" }, "items": [ { "info": { "name": "Update Multiple Extensions", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension-bulk-update", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates multiple extensions at once. Maximum 500 extensions can be updated per request.\n" }, { "info": { "name": "Get Extension Update Task Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension-bulk-update/tasks/:taskId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "taskId", "value": "", "type": "path", "description": "Internal identifier of a task\n" } ] }, "docs": "Returns a status of a task to update multiple extensions.\n" }, { "info": { "name": "List User Templates", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/templates", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "type", "value": "", "type": "query", "description": "Type of template" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare allowed. Default value is '1'\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items). If not specified, the value is '100' by default" } ] }, "docs": "Returns the list of user templates for the current account.\n" }, { "info": { "name": "Get User Template", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/templates/:templateId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "templateId", "value": "", "type": "path", "description": "Internal identifier of a template" } ] }, "docs": "Returns the user template by ID.\n" }, { "info": { "name": "List Extensions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionNumber", "value": "", "type": "query", "description": "Extension short number to filter records" }, { "name": "email", "value": "alice.smith@example.com&email=bob.johnson@example.com", "type": "query", "description": "Extension email address. Multiple values are accepted\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare allowed\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" }, { "name": "status", "value": "", "type": "query", "description": "Extension current state. Multiple values are supported. If 'Unassigned'\nis specified, then extensions without `extensionNumber` attribute are returned.\nIf not specified, then all extensions are returned\n" }, { "name": "type", "value": "", "type": "query", "description": "Extension type. Multiple values are supported. Please note\nthat legacy 'Department' extension type corresponds to 'Call Queue'\nextensions in modern RingCentral product terminology\n" } ] }, "docs": "Returns the list of extensions created for a particular account.\nAll types of extensions are included in this list.\n" }, { "info": { "name": "Create Extension", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an extension.\n" } ] }, { "info": { "name": "High Volume SMS", "type": "folder" }, "items": [ { "info": { "name": "List A2P SMS Statuses", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/a2p-sms/statuses", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "batchId", "value": "55577", "type": "query", "description": "Internal identifier of a message batch to filter the response" }, { "name": "direction", "value": "Inbound", "type": "query", "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n" }, { "name": "dateFrom", "value": "2020-11-09T16:07:52.597Z", "type": "query", "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours" }, { "name": "dateTo", "value": "2020-11-25T16:07:52.597Z", "type": "query", "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time" }, { "name": "phoneNumber", "value": "15551234455,15551235577", "type": "query", "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15" } ] }, "docs": "Retrieves a set of message counts by message status and error codes filtered by dates, batchId and message direction." }, { "info": { "name": "List A2P SMS Messages", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/a2p-sms/messages", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "batchId", "value": "55577", "type": "query", "description": "Internal identifier of a message batch to filter the response" }, { "name": "direction", "value": "Inbound", "type": "query", "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n" }, { "name": "dateFrom", "value": "2020-11-09T16:07:52.597Z", "type": "query", "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours" }, { "name": "dateTo", "value": "2020-11-25T16:07:52.597Z", "type": "query", "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time" }, { "name": "view", "value": "", "type": "query", "description": "Indicates if the response has to be detailed, includes text in the response if detailed" }, { "name": "phoneNumber", "value": "15551234455,15551235577", "type": "query", "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15" }, { "name": "pageToken", "value": "pgt1", "type": "query", "description": "The page token of the page to be retrieved." }, { "name": "perPage", "value": "1", "type": "query", "description": "The number of messages to be returned per request" } ] }, "docs": "Returns the list of outbound/inbound A2P messages sent from/to A2P phone numbers of the current account. The list can be filtered by message batch ID and/or phone number." }, { "info": { "name": "Get A2P SMS", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/a2p-sms/messages/:messageId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "messageId", "value": "1234", "type": "path", "description": "Internal identifier of a message to be retrieved" } ] }, "docs": "Returns the details of an A2P SMS message by ID." }, { "info": { "name": "List Opted Out Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/a2p-sms/opt-outs", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "from", "value": "15551234455", "type": "query", "description": "The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages.\nThe asterisk value \"*\" means any number in `from` field\n" }, { "name": "to", "value": "15551237755", "type": "query", "description": "The receiver's phone number (`to` field) in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages\n" }, { "name": "status", "value": "optout", "type": "query", "description": "The status (opted out, opted in, or both) to be used as the filter" }, { "name": "pageToken", "value": "pgt1", "type": "query", "description": "The page token of the page to be retrieved" }, { "name": "perPage", "value": "5", "type": "query", "description": "The number of records to be returned for the page" } ] }, "docs": "Returns the list of numbers opted out from the account. The list\ncan be filtered by `to`/`from` phone number query parameters. Specifying `text/csv`\nin the `Accept` header lets download the data in the CSV format.\n" }, { "info": { "name": "Add Opt-In/Out Numbers", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/a2p-sms/opt-outs/bulk-assign", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds multiple opt-outs and/or opt-ins for the specified sender number and a set of recipient numbers.\n" }, { "info": { "name": "List A2P SMS Batches", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/a2p-sms/batches", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "dateFrom", "value": "2020-11-09T16:07:52.597Z", "type": "query", "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours" }, { "name": "dateTo", "value": "2020-11-25T16:07:52.597Z", "type": "query", "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time" }, { "name": "from", "value": "15551234455", "type": "query", "description": "Phone number in E.164 format from which the messages are going to be sent" }, { "name": "status", "value": "Queued,Processing", "type": "query", "description": "A list of batch statuses to filter the results" }, { "name": "pageToken", "value": "pgt1", "type": "query", "description": "The page token of the page to be retrieved" }, { "name": "perPage", "value": "1", "type": "query", "description": "The number of records to be returned per page" } ] }, "docs": "Returns the list of A2P batches sent from the current account.\nThe list can be filtered by message batch ID and/or from phone number.\n" }, { "info": { "name": "Send A2P SMS", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/a2p-sms/batches", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Allows to send high volume of A2P (Application-to-Person) SMS messages\n(in message batches). Only phone number with the `A2PSmsSender` feature can\nbe used as a sender.\n" }, { "info": { "name": "Get A2P SMS Batch", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/a2p-sms/batches/:batchId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "batchId", "value": "55577", "type": "path", "description": "Internal identifier of a message batch to be retrieved" } ] }, "docs": "Returns information on a message batch." } ] }, { "info": { "name": "Call Handling Rules", "type": "folder" }, "items": [ { "info": { "name": "List Company Call Handling Rules", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/answering-rule", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" } ] }, "docs": "Returns a list of company call handling rules." }, { "info": { "name": "Create Company Call Handling Rule", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/answering-rule", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates call handling rule on account level." }, { "info": { "name": "Get Company Call Handling Rule", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/answering-rule/:ruleId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "ruleId", "value": "", "type": "path", "description": "Internal identifier of a call handling rule" } ] }, "docs": "Returns a company call handling rule by ID." }, { "info": { "name": "Update Company Call Handling Rule", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/answering-rule/:ruleId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "ruleId", "value": "", "type": "path", "description": "Internal identifier of a call handling rule" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a company call handling rule." }, { "info": { "name": "Delete Company Call Handling Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/answering-rule/:ruleId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "ruleId", "value": "", "type": "path", "description": "Internal identifier of a call handling rule" } ] }, "docs": "Deletes a company custom call handling rule by a particular ID." }, { "info": { "name": "Get Forward All Company Calls", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/forward-all-calls", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns information about *Forward All Company Calls* feature setting." }, { "info": { "name": "Update Forward All Company Calls", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/forward-all-calls", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates *Forward All Company Calls* feature setting." }, { "info": { "name": "List Call Handling Rules", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/answering-rule", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "type", "value": "", "type": "query", "description": "Filters custom call handling rules of the extension" }, { "name": "view", "value": "", "type": "query" }, { "name": "enabledOnly", "value": "", "type": "query", "description": "If true, then only active call handling rules are returned" }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" } ] }, "docs": "Returns call handling rules of an extension." }, { "info": { "name": "Create Call Handling Rule", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/answering-rule", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a custom call handling rule for a particular caller ID." }, { "info": { "name": "Get Call Handling Rule", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/answering-rule/:ruleId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "ruleId", "value": "", "type": "path", "description": "Internal identifier of a call handling rule" }, { "name": "showInactiveNumbers", "value": "", "type": "query", "description": "Indicates whether inactive numbers should be returned or not" } ] }, "docs": "Returns a call handling rule by ID." }, { "info": { "name": "Update Call Handling Rule", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/answering-rule/:ruleId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "ruleId", "value": "", "type": "path", "description": "Internal identifier of a call handling rule" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a custom call handling rule for a particular caller ID." }, { "info": { "name": "Delete Call Handling Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/answering-rule/:ruleId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "ruleId", "value": "", "type": "path", "description": "Internal identifier of a call handling rule" } ] }, "docs": "Deletes a custom call handling rule by a particular ID." } ] }, { "info": { "name": "External Contacts", "type": "folder" }, "items": [ { "info": { "name": "Upload Multiple User Contacts", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/address-book-bulk-upload", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Uploads multiple contacts for multiple extensions at once.\nMaximum 500 extensions can be uploaded per request. Max amount\nof contacts that can be uploaded per extension is 10,000.\nEach contact uploaded for a certain extension is not visible\nto other extensions.\n" }, { "info": { "name": "Get Contacts Upload Task", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/address-book-bulk-upload/tasks/:taskId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "taskId", "value": "", "type": "path", "description": "Internal identifier of a task" } ] }, "docs": "Returns the status of a task on adding multiple contacts to multiple extensions.\n" }, { "info": { "name": "List Favorite Contacts", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/favorite", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns the list of favorite contacts of the current extension.\nFavorite contacts include both company contacts (extensions) and personal\ncontacts (address book records).\n" }, { "info": { "name": "Update Favorite Contact List", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/favorite", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the list of favorite contacts of the current extension.\nFavorite contacts include both company contacts (extensions) and personal\ncontacts (address book records).**Please note**: Currently personal address\nbook size is limited to 10 000 contacts.\n" }, { "info": { "name": "List Contacts", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/address-book/contact", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "startsWith", "value": "", "type": "query", "description": "If specified, only contacts which 'First name' or 'Last name' start\nwith the mentioned substring will be returned. Case-insensitive\n" }, { "name": "sortBy", "value": "", "type": "query", "description": "Sorts results by the specified property" }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "phoneNumber", "value": "", "type": "query", "description": "Phone number in e.164 format" } ] }, "docs": "Returns the user personal contacts.\n" }, { "info": { "name": "Create User Contact", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/address-book/contact", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "dialingPlan", "value": "", "type": "query", "description": "Country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2)\nformat. The default value is home country of the current extension\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates the user personal contact.\n" }, { "info": { "name": "Get User Contact(s)", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/address-book/contact/:contactId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "contactId", "value": "", "type": "path", "description": "The list of contact identifiers (comma-separated)" } ] }, "docs": "Returns the user personal contact(s). \n[Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.\n" }, { "info": { "name": "Update User Contact(s)", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/address-book/contact/:contactId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "contactId", "value": "", "type": "path", "description": "The list of contact identifiers (comma-separated)" }, { "name": "dialingPlan", "value": "", "type": "query", "description": "Country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. \nThe default value is home country of the current extension\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the user personal contact(s) (full resource update). \n[Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.\n" }, { "info": { "name": "Update Contact Attributes", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/address-book/contact/:contactId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "contactId", "value": "", "type": "path", "description": "Internal identifier of a contact record in the RingCentral database\n" }, { "name": "dialingPlan", "value": "", "type": "query", "description": "Country code value complying with the [ISO 3166-1 alpha-2](https://ru.wikipedia.org/wiki/ISO_3166-1_alpha-2)\nformat. The default value is home country of the current extension\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates particular values of a personal contact attributes specified in request (partial resource update). Omitted attributes will remain unchanged.\nIf any attribute is passed in request body with the null value, then this attribute value will be removed.\n" }, { "info": { "name": "Delete User Contact(s)", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/address-book/contact/:contactId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "contactId", "value": "", "type": "path", "description": "The list of contact identifiers (comma-separated)" } ] }, "docs": "Deletes the user personal contact(s). \n[Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.\n" }, { "info": { "name": "Address Book Synchronization", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/address-book-sync", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "syncType", "value": "", "type": "query", "description": "Type of synchronization" }, { "name": "syncToken", "value": "", "type": "query", "description": "Value of syncToken property of the last sync request response\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of records per page to be returned. Max number of\nrecords is 250, which is also the default.\nFor 'FSync' - if the number of records exceeds the parameter value\n(either specified or default), all of the pages can be retrieved\nin several requests. For 'ISync' - if the number of records exceeds\npage size, then the number of incoming changes to this\nnumber is limited\n" }, { "name": "pageId", "value": "", "type": "query", "description": "Internal identifier of a page. It can be obtained from the 'nextPageId'\nparameter passed in response body\n" } ] }, "docs": "Synchronizes user contacts.\n" } ] }, { "info": { "name": "Call Queues", "type": "folder" }, "items": [ { "info": { "name": "List Call Queues", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-queues", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values are accepted" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" }, { "name": "memberExtensionId", "value": "", "type": "query", "description": "Internal identifier of an extension that is a member of every group within the result" } ] }, "docs": "Returns a call queue list." }, { "info": { "name": "Get Call Queue", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-queues/:groupId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "Returns basic information on a call queue group extension." }, { "info": { "name": "Update Call Queue", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-queues/:groupId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a call queue group" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates information on a call queue group extension.\n" }, { "info": { "name": "Assign Multiple Call Queue Members", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-queues/:groupId/bulk-assign", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a call queue group" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns multiple call queue members to call queue group.\n" }, { "info": { "name": "List Call Queue Members", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-queues/:groupId/members", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a call queue group" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare allowed\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" } ] }, "docs": "Returns a list of call queue group members.\n" }, { "info": { "name": "Get Department Member List", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/department/:departmentId/members", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "departmentId", "value": "", "type": "path", "description": "Internal identifier of a Department extension (same as extensionId\nbut only the ID of a department extension is valid). Please note that\nlegacy 'Department' extension type corresponds to 'Call Queue' extensions\nin modern RingCentral product terminology\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" } ] }, "docs": "Viewing user account information (including name, business name, address\nand phone number/account number). Please note, that this method is\ndeprecated and legacy 'Department' entity corresponds to 'Call Queue'\nin modern RingCentral product terminology. In order to retrieve call\nqueue members please use the following method\n`GET/restapi/v1.0/account/{accountId}/call-queues/{groupId}/members`.\n" }, { "info": { "name": "Assign Multiple Department Members", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/department/bulk-assign", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds and/or removes multiple call queue members. Please note,\nthat this method is deprecated and legacy 'Department' entity\ncorresponds to 'Call Queue' in modern RingCentral product terminology.\nIn order to assign multiple call queue members please use the following\nmethod `POST/restapi/v1.0/account/{accountId}/call-queues/{groupId}/bulk-assign`.\n" }, { "info": { "name": "Update User Call Queues", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/call-queues", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a list of call queues where the user is an agent. This\nis a full update request, which means that if any call queue where the user is\nan agent is not mentioned in request, then the user is automatically removed\nfrom this queue.\n" }, { "info": { "name": "Get Call Queue Overflow Settings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:callQueueId/overflow-settings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "callQueueId", "value": "", "type": "path", "description": "Internal identifier of a call queue" } ] }, "docs": "Returns overflow settings for a call queue specified in path." }, { "info": { "name": "Update Call Queue Overflow Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:callQueueId/overflow-settings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "callQueueId", "value": "", "type": "path", "description": "Internal identifier of a call queue" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates overflow settings for a call queue specified in path." } ] }, { "info": { "name": "Presence", "type": "folder" }, "items": [ { "info": { "name": "Get Call Queue Presence", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-queues/:groupId/presence", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a call queue extension" } ] }, "docs": "Returns presence status of the call queue members." }, { "info": { "name": "Update Call Queue Presence", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-queues/:groupId/presence", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a call queue extension" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates presence status of the call queue members in the specified queue." }, { "info": { "name": "Get User Presence Status List", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/presence", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "detailedTelephonyState", "value": "", "type": "query", "description": "Whether to return detailed telephony state" }, { "name": "sipData", "value": "", "type": "query", "description": "Whether to return SIP data" }, { "name": "page", "value": "", "type": "query", "description": "Page number for account presence information" }, { "name": "perPage", "value": "", "type": "query", "description": "Number for account presence information items per page" } ] }, "docs": "Returns presence status of all extensions of an account. Please note: The presenceStatus is returned as Offline (the parameters telephonyStatus, message, userStatus and dndStatus are not returned at all) for the following extension types: Department, Announcement Only, Voicemail (Take Messages Only), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension." }, { "info": { "name": "Get Agent’s Call Queue Presence", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/call-queue-presence", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "editableMemberStatus", "value": "", "type": "query", "description": "Filtering by the flag 'Allow members to change their Queue Status'. If 'true' only queues where user can change his availability status are returned" } ] }, "docs": "Returns a list of agent's call queues with the agent presence status (per queue)." }, { "info": { "name": "Update Call Queue Presence", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/call-queue-presence", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates availability of the agent for the call queues." }, { "info": { "name": "Get User Presence Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/presence", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "detailedTelephonyState", "value": "", "type": "query", "description": "Specifies whether to return a detailed telephony state or not" }, { "name": "sipData", "value": "", "type": "query", "description": "Specifies whether to return SIP data or not" } ] }, "docs": "Returns the presence status of an extension or several extensions by their ID(s). The `presenceStatus` is returned as Offline \n(the parameters `telephonyStatus`, `message`, `userStatus` and `dndStatus` are not returned at all) for the following extension types: \nDepartment/Announcement Only/Take Messages Only (Voicemail)/Fax User/Paging Only Group/Shared Lines Group/IVR Menu/Application Extension/Park Location.\nIf the user requests his/her own presence status, the response contains actual presen" }, { "info": { "name": "Update User Presence Status", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/presence", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates user-defined extension presence status, status message and DnD status by extension ID. Supported for regular User extensions only. The extension types listed do not support presence status: Department, Announcement Only, Take Messages Only (Voicemail), Fax User, Paging Only Group, Shared Lines Group, IVR Menu, Application Extension." }, { "info": { "name": "Get Unified Presence", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/unified-presence", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session" }, { "name": "extensionId", "value": "", "type": "path", "description": "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session" } ] }, "docs": "Returns the unified presence status of the requested user(s). The set of parameters returned by this method differs whether you return the requester's presence or any other user presence." }, { "info": { "name": "Update Unified Presence", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/unified-presence", "params": [ { "name": "accountId", "value": "", "type": "path", "description": "Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session" }, { "name": "extensionId", "value": "", "type": "path", "description": "Internal identifier of an extension or tilde (~) to indicate the extension assigned to the account logged-in within the current session" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the unified presence for the current user specified in path." } ] }, { "info": { "name": "Automatic Location Updates", "type": "folder" }, "items": [ { "info": { "name": "List Emergency Locations", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-locations", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "query", "description": "Internal identifier of a site for filtering. To indicate company main\nsite `main-site` value should be specified. Supported only if multi-site feature\nis enabled for the account. Multiple values are supported.\n" }, { "name": "searchString", "value": "", "type": "query", "description": "Filters entries containing the specified substring in 'address'\nand 'name' fields. The character range is 0-64; not case-sensitive.\nIf empty then the filter is ignored\n" }, { "name": "addressStatus", "value": "", "type": "query" }, { "name": "usageStatus", "value": "", "type": "query" }, { "name": "domesticCountryId", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query", "description": "Comma-separated list of fields to order results, prefixed by\nplus sign '+' (ascending order) or minus sign '-' (descending order)\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items). The values\nsupported: `Max` or numeric value. If not specified,\n100 records are returned per one page\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates the page number to retrieve. Only positive number values\nare supported\n" } ] }, "docs": "Returns emergency response locations for the current account." }, { "info": { "name": "Add Emergency Location", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-locations", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new emergency response location for a company." }, { "info": { "name": "Get Emergency Location", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-locations/:locationId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "locationId", "value": "", "type": "path", "description": "Internal identifier of an emergency response location" }, { "name": "syncEmergencyAddress", "value": "", "type": "query" } ] }, "docs": "Returns emergency response location by ID. Available for Admin users only." }, { "info": { "name": "Update Emergency Location", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-locations/:locationId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "locationId", "value": "", "type": "path", "description": "Internal identifier of an emergency response location" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified emergency response location." }, { "info": { "name": "Delete Emergency Location", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-locations/:locationId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "locationId", "value": "", "type": "path", "description": "Internal identifier of an emergency response location" }, { "name": "validateOnly", "value": "", "type": "query", "description": "Flag indicating that validation of emergency location(s) is required\nbefore deletion\n" }, { "name": "newLocationId", "value": "", "type": "query", "description": "Internal identifier of an emergency response location\nthat should be used instead of a deleted one.\n" } ] }, "docs": "Deletes the specified emergency response location." }, { "info": { "name": "List User Emergency Locations", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/emergency-locations", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "query", "description": "Internal identifier of a site for filtering. To indicate company main\nsite `main-site` value should be specified. Supported only if multi-site feature\nis enabled for the account. Multiple values are supported.\n" }, { "name": "searchString", "value": "", "type": "query", "description": "Filters entries by the specified substring (search by chassis\nID, switch name or address) The characters range is 0-64 (if\nempty the filter is ignored)\n" }, { "name": "domesticCountryId", "value": "", "type": "query" }, { "name": "orderBy", "value": "", "type": "query", "description": "Comma-separated list of fields to order results prefixed by '+'\nsign (ascending order) or '-' sign (descending order). The default\nsorting is by `name`\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items). The values supported:\n`Max` or numeric value. If not specified, 100 records are returned\nper one page\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive\nnumber values are supported\n" }, { "name": "visibility", "value": "", "type": "query" } ] }, "docs": "Returns a list of emergency response locations available for the particular extension." }, { "info": { "name": "Create User Emergency Location", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/emergency-locations", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a personal emergency response location for the current user." }, { "info": { "name": "Get User Emergency Location", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/emergency-locations/:locationId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "locationId", "value": "", "type": "path", "description": "Internal identifier of an emergency response location" } ] }, "docs": "Returns a personal emergency response location for the current user." }, { "info": { "name": "Update User Emergency Location", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/emergency-locations/:locationId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "locationId", "value": "", "type": "path", "description": "Internal identifier of an emergency response location" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a personal emergency response location by the current user or admin.\n" }, { "info": { "name": "Delete User Emergency Location", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/emergency-locations/:locationId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "locationId", "value": "", "type": "path", "description": "Internal identifier of an emergency response location" }, { "name": "validateOnly", "value": "", "type": "query", "description": "Flag indicating that only validation of Emergency Response Locations\nto be deleted is required\n" } ] }, "docs": "Deletes a personal emergency response location by ID by\nthe current user or admin. Multiple personal emergency response\nlocations can be deleted by single API call.\n" }, { "info": { "name": "Get Emergency Map Configuration Task", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/tasks/:taskId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "taskId", "value": "", "type": "path" } ] }, "docs": "Returns results of the task created within the frame of Automatic\nLocation Updates feature. Currently four task types are supported: 'Wireless\nPoints Bulk Create', 'Wireless Points Bulk Update', 'Switches Bulk Create',\n'Switches Bulk Update'.\n" }, { "info": { "name": "List Users", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/users", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "type", "value": "", "type": "query", "description": "Extension type. Multiple values are supported" }, { "name": "searchString", "value": "", "type": "query", "description": "Filters entries containing the specified substring in user name,\nextension or department. The characters range is 0-64; not case-sensitive.\nIf empty then the filter is ignored\n" }, { "name": "department", "value": "", "type": "query", "description": "Department name to filter the users. The value range is 0-64;\nnot case-sensitive. If not specified then the parameter is ignored. Multiple\nvalues are supported\n" }, { "name": "siteId", "value": "", "type": "query", "description": "Internal identifier of a site for filtering. To indicate company main\nsite `main-site` value should be specified. Supported only if multi-site feature\nis enabled for the account. Multiple values are supported.\n" }, { "name": "featureEnabled", "value": "", "type": "query", "description": "Filters entries by their status of Automatic Location Updates\nfeature\n" }, { "name": "orderBy", "value": "", "type": "query", "description": "Comma-separated list of fields to order results prefixed by\nplus sign '+' (ascending order) or minus sign '-' (descending order).\nSupported values: 'name', 'modelName', 'siteName', 'featureEnabled'.\nThe default sorting is by `name`\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items). The values supported:\n`Max` or numeric value. If not specified, 100 records are returned per one\npage\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare supported\n" } ] }, "docs": "Returns a list of users with their status of Automatic Location\nUpdates feature.\n" }, { "info": { "name": "Enable Automatic Location Updates for Users", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/users/bulk-assign", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables or disables Automatic Location Updates feature for multiple\naccount users.\n" }, { "info": { "name": "Create Multiple Wireless Points", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/wireless-points-bulk-create", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates multiple wireless points in a corporate map. The maximum\nnumber of wireless points per request is 10 000; limitation for account is\n70 000.\n" }, { "info": { "name": "Get Network Map", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/networks", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "query", "description": "Internal identifier of a site for filtering. To indicate company main\nsite `main-site` value should be specified. Supported only if multi-site feature\nis enabled for the account. Multiple values are supported.\n" }, { "name": "searchString", "value": "", "type": "query", "description": "Filters entries by the specified substring (search by chassis\nID, switch name or address) The characters range is 0-64 (if empty the filter\nis ignored)\n" }, { "name": "orderBy", "value": "", "type": "query", "description": "Comma-separated list of fields to order results prefixed by '+'\nsign (ascending order) or '-' sign (descending order). The default\nsorting is by `name`\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items). The values supported:\n`Max` or numeric value. If not specified, 100 records are returned per one\npage'\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare supported\n" } ] }, "docs": "Returns a corporate network map with emergency addresses assigned\nto the current account.\n" }, { "info": { "name": "Create Network", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/networks", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new network in a corporate ethernet map for assignment\nof emergency addresses to network access points.\n" }, { "info": { "name": "Get Network", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/networks/:networkId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "networkId", "value": "", "type": "path", "description": "Internal identifier of a network" } ] }, "docs": "Returns the specified network with emergency addresses assigned\nto the current account.\n" }, { "info": { "name": "Update Network", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/networks/:networkId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "networkId", "value": "", "type": "path", "description": "Internal identifier of a network" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a network in a corporate ethernet map for assignment of emergency\naddresses to network access points.\n" }, { "info": { "name": "Delete Network", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/networks/:networkId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "networkId", "value": "", "type": "path", "description": "Internal identifier of a network" } ] }, "docs": "Deletes network(s) in a corporate ethernet map for Automatic Location\nUpdates feature.\n" }, { "info": { "name": "Validate Multiple Switches", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/switches-bulk-validate", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates switches before creation or update. The maximum number\nof switches per request is 10 000.\n" }, { "info": { "name": "List Account Switches", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/switches", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "query", "description": "Internal identifier of a site for filtering. To indicate company main\nsite `main-site` value should be specified. Supported only if multi-site feature\nis enabled for the account. Multiple values are supported.\n" }, { "name": "searchString", "value": "", "type": "query", "description": "Filters entries by the specified substring (search by chassis\nID, switch name or address) The characters range is 0-64 (if empty the filter\nis ignored)\n" }, { "name": "orderBy", "value": "", "type": "query", "description": "Comma-separated list of fields to order results prefixed by '+'\nsign (ascending order) or '-' sign (descending order). The default\nsorting is by `name`\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items). The values supported:\n`Max` or numeric value. If not specified, 100 records are returned per one\npage'\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare supported\n" } ] }, "docs": "Returns a corporate map of configured network switches with the assigned\nemergency addresses for the logged-in account.\n" }, { "info": { "name": "Create Switch", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/switches", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new switch in corporate map based on chassis ID and used\nfor Automatic Locations Update feature.\n" }, { "info": { "name": "Get Switch", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/switches/:switchId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "switchId", "value": "", "type": "path" } ] }, "docs": "Returns the specified switch with the assigned emergency address." }, { "info": { "name": "Update Switch", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/switches/:switchId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "switchId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates switch. Partial update is not supported, all switch parameters\nshould be specified. If null value is received or parameter is missing, its\nvalue is removed.\n" }, { "info": { "name": "Delete Switch", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/switches/:switchId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "switchId", "value": "", "type": "path" } ] }, "docs": "Deletes wireless switch(es) in a network configuration for Automatic\nLocation Updates feature.\n" }, { "info": { "name": "Validate Multiple Wireless Points", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/wireless-points-bulk-validate", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Validates wireless points before creation or update. The maximum\nnumber of wireless points per request is 10 000.\n" }, { "info": { "name": "List Wireless Points", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/wireless-points", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "query", "description": "Internal identifier of a site for filtering. To indicate company main\nsite `main-site` value should be specified. Supported only if multi-site feature\nis enabled for the account. Multiple values are supported.\n" }, { "name": "searchString", "value": "", "type": "query", "description": "Filters entries by the specified substring (search by chassis\nID, switch name or address) The characters range is 0-64 (if empty the filter\nis ignored)\n" }, { "name": "orderBy", "value": "", "type": "query", "description": "Comma-separated list of fields to order results prefixed by '+'\nsign (ascending order) or '-' sign (descending order).The default sorting\nis by `name`\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items). The values supported:\n`Max` or numeric value. If not specified, 100 records are returned per one\npage\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates the page number to retrieve. Only positive number values\nare supported\n" } ] }, "docs": "Returns account wireless points configured and used for Automatic\nLocation Updates feature.\n" }, { "info": { "name": "Create Wireless Point", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/wireless-points", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new wireless point in network configuration with the\nemergency address assigned.\n" }, { "info": { "name": "Get Wireless Point", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/wireless-points/:pointId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "pointId", "value": "", "type": "path", "description": "Internal identifier of a point" } ] }, "docs": "Returns the specified wireless access point of a corporate map\nwith the emergency address assigned.\n" }, { "info": { "name": "Update Wireless Point", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/wireless-points/:pointId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "pointId", "value": "", "type": "path", "description": "Internal identifier of a wireless point" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified wireless access point of a corporate map\nby ID.\n" }, { "info": { "name": "Delete Wireless Point", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/wireless-points/:pointId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "pointId", "value": "", "type": "path", "description": "Internal identifier of a wireless point" } ] }, "docs": "Deletes wireless point(s) of a corporate map by ID(s)." }, { "info": { "name": "List Devices", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/devices", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "query", "description": "Internal identifier of a site for filtering. To indicate company main\nsite `main-site` value should be specified. Supported only if multi-site feature\nis enabled for the account. Multiple values are supported.\n" }, { "name": "featureEnabled", "value": "", "type": "query", "description": "Filters entries by their status of Automatic Location Updates\nfeature\n" }, { "name": "modelId", "value": "", "type": "query", "description": "Internal identifier of a device model for filtering. Multiple\nvalues are supported\n" }, { "name": "compatibleOnly", "value": "", "type": "query", "description": "Filters devices which support HELD protocol" }, { "name": "searchString", "value": "", "type": "query", "description": "Filters entries which have device name or model name containing\nthe mentioned substring. The value should be split by spaces; the range\nis 0 - 64 characters, not case-sensitive. If empty the filter is ignored\n" }, { "name": "orderBy", "value": "", "type": "query", "description": "Comma-separated list of fields to order results prefixed by\nplus sign '+' (ascending order) or minus sign '-' (descending order).\nSupported values: 'name', 'modelName', 'siteName', 'featureEnabled'.\nThe default sorting is by `name`\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items). The values supported:\n`Max` or numeric value. If not specified, 100 records are returned per one\npage\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare supported\n" } ] }, "docs": "Returns a list of common devices with their status of Automatic\nLocation Updates feature.\n" }, { "info": { "name": "Enable Automatic Location Updates Feature", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/devices/bulk-assign", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enables or disables Automatic Location Updates feature for the\nspecified common phones.\n" }, { "info": { "name": "Create Multiple Switches", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/switches-bulk-create", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates multiple switches in corporate map. The maximum number\nof switches per request is 10 000; limitation for account is 10 000.\n" }, { "info": { "name": "Update Multiple Wireless Points", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/wireless-points-bulk-update", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates wireless points in corporate map. The maximum number of\nwireless points per request is 10 000; limitation for account is 70 000.\n" }, { "info": { "name": "Update Multiple Switches", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/emergency-address-auto-update/switches-bulk-update", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates multiple switches in corporate map. The maximum number\nof switches per request is 10 000; limitation for account is 10 000.\n" } ] }, { "info": { "name": "RCM Meetings (Legacy)", "type": "folder" }, "items": [ { "info": { "name": "Get Locked Meeting Settings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/meeting/locked-settings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns the information about user meeting settings that are locked on\naccount level and therefore cannot be changed by a user.\n" }, { "info": { "name": "Get Account-level Meeting Info", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/meeting/:meetingId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "meetingId", "value": "", "type": "path", "description": "Internal identifier of a RingCentral meeting" } ] }, "docs": "Returns a particular account-level meeting details by ID" }, { "info": { "name": "List Account Meeting Recordings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/meeting-recordings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "meetingId", "value": "", "type": "query", "description": "Internal identifier of a meeting. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can be specified" }, { "name": "meetingStartTimeFrom", "value": "", "type": "query", "description": "Recordings of meetings started after the time specified will\nbe returned. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can\nbe specified\n" }, { "name": "meetingStartTimeTo", "value": "", "type": "query", "description": "Recordings of meetings started before the time specified will\nbe returned. The default value is current time. Either `meetingId` or `meetingStartTime`/`meetingEndTime`\ncan be specified\n" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of items per page. The `max` value is supported to indicate the maximum size - 300" } ] }, "docs": "Returns the list of meeting recordings for the current account." }, { "info": { "name": "Upload User Meeting Profile Image", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting-configuration/profile-image", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "multipart-form", "data": [ { "name": "profilePic", "type": "text", "value": "" } ] } }, "docs": "Uploads profile picture for user meetings" }, { "info": { "name": "List Scheduled Meetings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns a list of user meetings scheduled for the future (meetings\nof 'Instant' type are not included).\n" }, { "info": { "name": "Create Meeting", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new meeting." }, { "info": { "name": "Get Meeting User Settings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting/user-settings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns user settings for meetings." }, { "info": { "name": "Get Meeting Info", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting/:meetingId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "meetingId", "value": "", "type": "path", "description": "Internal identifier of a RingCentral meeting" } ] }, "docs": "Returns a particular meeting details by ID" }, { "info": { "name": "Update Meeting", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting/:meetingId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "meetingId", "value": "", "type": "path", "description": "Internal identifier of a RingCentral meeting" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a particular meeting" }, { "info": { "name": "Update Meeting", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting/:meetingId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "meetingId", "value": "", "type": "path", "description": "Internal identifier of a RingCentral meeting" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modifies a particular meeting" }, { "info": { "name": "Delete Meeting", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting/:meetingId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "meetingId", "value": "", "type": "path", "description": "Internal identifier of a RingCentral meeting" }, { "name": "occurrenceId", "value": "", "type": "query", "description": "Internal identifier of a recurrent meeting occurrence" } ] }, "docs": "Deletes a scheduled meeting." }, { "info": { "name": "End Meeting", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting/:meetingId/end", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "meetingId", "value": "", "type": "path", "description": "Internal identifier of a RingCentral meeting" } ] }, "docs": "Ends a meeting which is in progress" }, { "info": { "name": "Get Meeting Invitation", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting/:meetingId/invitation", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "meetingId", "value": "", "type": "path", "description": "Internal identifier of a RingCentral meeting" } ] }, "docs": "Returns a Meeting Invitation by ID." }, { "info": { "name": "Get Meeting Service Info", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting/service-info", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns information on dial-in numbers for meetings, support and international dial-in numbers URIs and meeting account information." }, { "info": { "name": "Update Meeting Service Info", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting/service-info", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates personal meeting identifier." }, { "info": { "name": "Get Assisted Users", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meetings-configuration/assisted", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns assisted users information." }, { "info": { "name": "Get Assistants", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meetings-configuration/assistants", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns assistants information." }, { "info": { "name": "List User Meeting Recordings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/meeting-recordings", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "meetingId", "value": "", "type": "query", "description": "Internal identifier of a meeting. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can be specified" }, { "name": "meetingStartTimeFrom", "value": "", "type": "query", "description": "Recordings of meetings started after the time specified will be returned. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can be specified" }, { "name": "meetingStartTimeTo", "value": "", "type": "query", "description": "Recordings of meetings started before the time specified will be returned. The default value is current time. Either `meetingId` or `meetingStartTime`/`meetingEndTime` can be specified" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of items per page. The `max` value is supported to indicate the maximum size - 300" } ] }, "docs": "Returns the list of meetings recordings for the current user." } ] }, { "info": { "name": "Role Management", "type": "folder" }, "items": [ { "info": { "name": "List Company Assigned Roles", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/assigned-role", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "showHidden", "value": "", "type": "query", "description": "Specifies if hidden roles are shown or not" } ] }, "docs": "Returns a list of roles assigned to the current account." }, { "info": { "name": "List Company User Roles", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/user-role", "params": [ { "name": "custom", "value": "", "type": "query", "description": "Specifies whether to return custom roles or predefined roles only.\nIf not specified, all roles are returned\n" }, { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" } ] }, "docs": "Returns a list of account user roles." }, { "info": { "name": "Create Custom Role", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/user-role", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a custom user role." }, { "info": { "name": "Get Default User Role", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/user-role/default", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns the default user role of the current account." }, { "info": { "name": "Set Default User Role", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/user-role/default", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the account default user role." }, { "info": { "name": "Get User Role", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/user-role/:roleId", "params": [ { "name": "roleId", "value": "", "type": "path", "description": "Internal identifier of a role" }, { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "advancedPermissions", "value": "", "type": "query", "description": "Specifies whether to return advanced permissions capabilities within `permissionsCapabilities` resource.\nThe default value is false.\n" } ] }, "docs": "Returns a user role assigned to the current account." }, { "info": { "name": "Update User Role", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/user-role/:roleId", "params": [ { "name": "roleId", "value": "", "type": "path", "description": "Internal identifier of a role" }, { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user role assigned to the current account by ID." }, { "info": { "name": "Delete Custom Role", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/user-role/:roleId", "params": [ { "name": "roleId", "value": "", "type": "path", "description": "Internal identifier of a role" }, { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "validateOnly", "value": "", "type": "query", "description": "Specifies that role should be validated prior to deletion, whether\nit can be deleted or not\n" } ] }, "docs": "Deletes a custom user role by ID." }, { "info": { "name": "Assign Multiple User Roles", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/user-role/:roleId/bulk-assign", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "roleId", "value": "", "type": "path", "description": "Internal identifier of a role" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns multiple user roles." }, { "info": { "name": "List Assignable Roles", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/assignable-roles", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" } ] }, "docs": "Returns a list of roles which can be assigned to a given extension." }, { "info": { "name": "List User Assigned Roles", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/assigned-role", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "showHidden", "value": "", "type": "query", "description": "Specifies if hidden roles are shown or not" } ] }, "docs": "Returns a list of roles assigned to the current extension." }, { "info": { "name": "Update User Assigned Roles", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/assigned-role", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a list of roles assigned to the current user." }, { "info": { "name": "Assign Default Role", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/assigned-role/default", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Assigns the default role to the currently logged-in user extension." }, { "info": { "name": "List Standard User Roles", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/user-role", "params": [ { "name": "servicePlanId", "value": "", "type": "query", "description": "Internal identifier of a service plan." }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "advancedPermissions", "value": "", "type": "query", "description": "Specifies whether to return advanced permissions capabilities within `permissionsCapabilities` resource.\nThe default value is false.\n" } ] }, "docs": "Returns a list of standard user roles." }, { "info": { "name": "Get Standard User Role", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/user-role/:roleId", "params": [ { "name": "roleId", "value": "", "type": "path", "description": "Internal identifier of a role" } ] }, "docs": "Returns a standard user role by ID." } ] }, { "info": { "name": "Call Monitoring Groups", "type": "folder" }, "items": [ { "info": { "name": "List Call Monitoring Groups", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-monitoring-groups", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare allowed\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" }, { "name": "memberExtensionId", "value": "", "type": "query", "description": "Internal identifier of an extension that is a member of every\ngroup within the result\n" } ] }, "docs": "Returns a list of call monitoring groups filtered by an extension.\n" }, { "info": { "name": "Create Call Monitoring Group", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-monitoring-groups", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new call monitoring group.\n" }, { "info": { "name": "Update Call Monitoring Group", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-monitoring-groups/:groupId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a call monitoring group\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a call monitoring group name.\n" }, { "info": { "name": "Delete Call Monitoring Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-monitoring-groups/:groupId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a call monitoring group" } ] }, "docs": "Removes information about a call monitoring group specified in path.\n" }, { "info": { "name": "Update Call Monitoring Group List", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-monitoring-groups/:groupId/bulk-assign", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a call monitoring group\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a list of call monitoring groups.\n" }, { "info": { "name": "List Call Monitoring Group Members", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/call-monitoring-groups/:groupId/members", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a call monitoring group\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare allowed\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" } ] }, "docs": "Returns a list of members for a call monitoring group specified in path.\n" } ] }, { "info": { "name": "Audit Trail", "type": "folder" }, "items": [ { "info": { "name": "Search Audit Trail Data", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/audit-trail/search", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns the audit trail data with specific filters applied.\nAudit trail searching is limited to the last 10,000 records or last 180 days, whichever comes first.\n" } ] }, { "info": { "name": "Message Exports", "type": "folder" }, "items": [ { "info": { "name": "Create Message Store Report", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-report", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a task to collect all account messages within the specified\ntime interval. Maximum number of simultaneous tasks per account is 2.\n" }, { "info": { "name": "Get Message Store Report Task", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-report/:taskId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "taskId", "value": "400142200026-400142200026-bd162f24028442489385eb3f44c18354", "type": "path", "description": "Internal identifier of a task" } ] }, "docs": "Returns the current status of a task on report creation." }, { "info": { "name": "Get Message Store Report Archive", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/message-store-report/:taskId/archive", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "taskId", "value": "400142200026-400142200026-bd162f24028442489385eb3f44c18354", "type": "path", "description": "Internal identifier of a task" } ] }, "docs": "Returns the created report with message data not including attachments." } ] }, { "info": { "name": "Internal Contacts", "type": "folder" }, "items": [ { "info": { "name": "Get Company Directory Entries", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/directory/entries", "headers": [ { "name": "If-None-Match", "value": "" } ], "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "showFederated", "value": "", "type": "query", "description": "If `true` then contacts of all accounts in federation are returned. If `false` then only contacts of the current account are returned, and account section is eliminated in this case" }, { "name": "type", "value": "", "type": "query", "description": "Type of an extension. Please note that legacy 'Department' extension type corresponds to 'Call Queue' extensions in modern RingCentral product terminology" }, { "name": "typeGroup", "value": "", "type": "query", "description": "Type of extension group" }, { "name": "page", "value": "", "type": "query", "description": "Page number" }, { "name": "perPage", "value": "", "type": "query", "description": "Records count to be returned per one page. It can be either integer or string with the specific keyword values:\n- `all` - all records are returned in one page\n- `max` - maximum count of records that can be returned in one page\n" }, { "name": "siteId", "value": "", "type": "query", "description": "Internal identifier of the business site to which extensions belong" } ] }, "docs": "Returns contact information on corporate users of federated accounts. Please note: 1. `User`, `DigitalUser`, `VirtualUser` and `FaxUser` types are returned as `User` type. 2. `ApplicationExtension` type is not returned. 3. Only extensions in `Enabled`, `Disabled` and `NotActivated` state are returned." }, { "info": { "name": "Get Corporate Directory Entry", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/directory/entries/:entryId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "entryId", "value": "", "type": "path", "description": "Internal identifier of extension to read information for" } ] }, "docs": "Returns contact information on a particular corporate user of a federated account." }, { "info": { "name": "Search Company Directory Entries", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/directory/entries/search", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "accountId", "value": "", "type": "query", "description": "A list of Account IDs" }, { "name": "department", "value": "", "type": "query", "description": "A list of department names" }, { "name": "siteId", "value": "", "type": "query", "description": "A list of Site IDs" }, { "name": "extensionStatus", "value": "", "type": "query", "description": "Extension current state" }, { "name": "extensionType", "value": "", "type": "query", "description": "Extension types" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns contact information on corporate users of federated accounts according to the specified filtering and ordering." }, { "info": { "name": "Get Account Federation", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/directory/federation", "headers": [ { "name": "RCExtensionId", "value": "" } ], "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "types", "value": "", "type": "query", "description": "Filter by federation types. Default is Regular" } ] }, "docs": "Returns information on a federation and associated accounts." } ] }, { "info": { "name": "Paging Only Groups", "type": "folder" }, "items": [ { "info": { "name": "Get Paging Group Users", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/paging-only-groups/:pagingOnlyGroupId/users", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "pagingOnlyGroupId", "value": "", "type": "path", "description": "Internal identifier of a paging group\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" } ] }, "docs": "Returns a list of users allowed to page this group.\n" }, { "info": { "name": "Assign Paging Group Users and Devices", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/paging-only-groups/:pagingOnlyGroupId/bulk-assign", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "pagingOnlyGroupId", "value": "", "type": "path", "description": "Internal identifier of a paging group\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds and/or removes paging group users and devices.\n" }, { "info": { "name": "Get Paging Group Devices", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/paging-only-groups/:pagingOnlyGroupId/devices", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "pagingOnlyGroupId", "value": "", "type": "path", "description": "Internal identifier of a paging group\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)\n" } ] }, "docs": "Returns a list of paging devices assigned to this group.\n" } ] }, { "info": { "name": "Multi-Site", "type": "folder" }, "items": [ { "info": { "name": "List Sites", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/sites", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "docs": "Returns a list of sites for the specified account.\n" }, { "info": { "name": "Create Site", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/sites", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a site for the specified account.\n" }, { "info": { "name": "Get Site", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/sites/:siteId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "path", "description": "Internal identifier of a site. *Please note* that `siteId` cannot take the 'main-site' value" } ] }, "docs": "Returns a site by ID.\n" }, { "info": { "name": "Update Site", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/sites/:siteId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "path", "description": "Internal identifier of a site. *Please note* that `siteId` cannot take the 'main-site' value" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a site specified in path.\n" }, { "info": { "name": "Delete Site", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/sites/:siteId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "path", "description": "Internal identifier of a site. *Please note* that `siteId` cannot take the 'main-site' value" } ] }, "docs": "Deletes a site specified in path.\n" }, { "info": { "name": "Edit Sites", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/sites/:siteId/bulk-assign", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "path", "description": "Internal identifier of a site. *Please note* that `siteId` cannot take the 'main-site' value" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assigns multiple sites to an account specified in path.\n" }, { "info": { "name": "List Site Members", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/sites/:siteId/members", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "path", "description": "Internal identifier of a site. *Please note* that `siteId` cannot take the 'main-site' value" } ] }, "docs": "Returns members of a site specified in path.\n" }, { "info": { "name": "Get Site IVR Settings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/sites/:siteId/ivr", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "path", "description": "Internal identifier of a site. *Please note* that `siteId` cannot take the 'main-site' value" } ] }, "docs": "Returns IVR settings for a site specified in path.\n" }, { "info": { "name": "Update Site IVR Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/sites/:siteId/ivr", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "siteId", "value": "", "type": "path", "description": "Internal identifier of a site. *Please note* that `siteId` cannot take the 'main-site' value" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates IVR settings for a site specified in path.\n" } ] }, { "info": { "name": "Video Configuration", "type": "folder" }, "items": [ { "info": { "name": "Get User Video Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/video-configuration", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns information about video configuration settings of the current user.\n" } ] }, { "info": { "name": "Pager Messages", "type": "folder" }, "items": [ { "info": { "name": "Create Internal Text Message", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/company-pager", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and sends an internal text message (company pager message)." } ] }, { "info": { "name": "User Permissions", "type": "folder" }, "items": [ { "info": { "name": "Get Authorization Profile", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/authz-profile", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "targetExtensionId", "value": "", "type": "query" } ] }, "docs": "Returns a list of user permissions granted at authorization procedure.\nPlease note: Some permissions may be restricted by extension type.\n" }, { "info": { "name": "Check User Permission", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/authz-profile/check", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "permissionId", "value": "", "type": "query" }, { "name": "targetExtensionId", "value": "", "type": "query" } ] }, "docs": "Checks if a certain user permission is activated for a particular extension." }, { "info": { "name": "List Permissions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/permission", "params": [ { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "assignable", "value": "", "type": "query", "description": "Specifies whether to return only assignable permissions" }, { "name": "servicePlanId", "value": "", "type": "query", "description": "Internal identifier of a service plan" } ] }, "docs": "Returns a list of extension user permissions." }, { "info": { "name": "Get Permission", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/permission/:permissionId", "params": [ { "name": "permissionId", "value": "", "type": "path", "description": "Internal identifier of a user permission" } ] }, "docs": "Returns a user permission by ID." }, { "info": { "name": "List Permission Categories", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/permission-category", "params": [ { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "servicePlanId", "value": "", "type": "query", "description": "Internal identifier of a service plan" } ] }, "docs": "Returns a list of permission categories." }, { "info": { "name": "Get Permission Category", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/permission-category/:permissionCategoryId", "params": [ { "name": "permissionCategoryId", "value": "", "type": "path", "description": "Internal identifier of a category" } ] }, "docs": "Returns a permission category by ID." } ] }, { "info": { "name": "Call Forwarding", "type": "folder" }, "items": [ { "info": { "name": "List Forwarding Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/forwarding-number", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" } ] }, "docs": "Returns the list of extension phone numbers used for call forwarding\nand call flip. The returned list contains all the extension phone numbers\nused for call forwarding and call flip.\n" }, { "info": { "name": "Create Forwarding Number", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/forwarding-number", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a new forwarding number to the forwarding number list." }, { "info": { "name": "Delete Forwarding Numbers", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/forwarding-number", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes multiple forwarding numbers from the forwarding number list by IDs." }, { "info": { "name": "Get Forwarding Number", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/forwarding-number/:forwardingNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "forwardingNumberId", "value": "", "type": "path", "description": "Internal identifier of a forwarding number (returned in response in the 'id' field)" } ] }, "docs": "Returns a specific forwarding number." }, { "info": { "name": "Update Forwarding Number", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/forwarding-number/:forwardingNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "forwardingNumberId", "value": "", "type": "path", "description": "Internal identifier of a forwarding number (returned in response in the 'id' field)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the existing forwarding number from the forwarding number list." }, { "info": { "name": "Delete Forwarding Number", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/forwarding-number/:forwardingNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "forwardingNumberId", "value": "", "type": "path", "description": "Internal identifier of a forwarding number (returned in response in the 'id' field)" } ] }, "docs": "Deletes a forwarding number from the forwarding number list by its ID." } ] }, { "info": { "name": "Fax", "type": "folder" }, "items": [ { "info": { "name": "Create Fax Message", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/fax", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "multipart-form", "data": [ { "name": "attachment", "type": "text", "value": "" }, { "name": "faxResolution", "type": "text", "value": "" }, { "name": "to", "type": "text", "value": "" }, { "name": "sendTime", "type": "text", "value": "" }, { "name": "isoCode", "type": "text", "value": "" }, { "name": "coverIndex", "type": "text", "value": "" }, { "name": "coverPageText", "type": "text", "value": "" } ] } }, "docs": "Creates and sends/re-sends a fax message. Re-send can be implemented\nif sending has failed. Fax attachment size (both single and total) is\nlimited to 50Mb.\n" }, { "info": { "name": "List Fax Cover Pages", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/fax-cover-page", "params": [ { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" } ] }, "docs": "Returns fax cover pages available for the current extension." } ] }, { "info": { "name": "RingOut", "type": "folder" }, "items": [ { "info": { "name": "Make RingOut Call", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/ring-out", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Makes a 2-legged RingOut call." }, { "info": { "name": "Get RingOut Call Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/ring-out/:ringoutId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "ringoutId", "value": "", "type": "path", "description": "Internal identifier of a RingOut call" } ] }, "docs": "Returns a status of a 2-legged RingOut call." }, { "info": { "name": "Cancel RingOut Call", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/ring-out/:ringoutId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "ringoutId", "value": "", "type": "path", "description": "Internal identifier of a RingOut call" } ] }, "docs": "Cancels a 2-legged RingOut call." } ] }, { "info": { "name": "Site Administration", "type": "folder" }, "items": [ { "info": { "name": "List User Administered Sites", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/administered-sites", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns a list of sites administered by the current user." }, { "info": { "name": "Update User Administered Sites", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/administered-sites", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the sites administered by the current user.\nPlease note: Only IDs of records are used for update.\n" } ] }, { "info": { "name": "SMS", "type": "folder" }, "items": [ { "info": { "name": "Send SMS", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/sms", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates and sends a new text message or multiple messages. You can send SMS\nmessages simultaneously to different recipients up to 40 requests per minute;\nthis limitation is relevant for all client applications. Sending and receiving\nSMS is available for Toll-Free Numbers within the USA. You can send up to\n10 attachments in a single MMS message; the size of all attachments linked\nis limited up to 1500000 bytes.\n" }, { "info": { "name": "Send MMS", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/mms", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "multipart-form", "data": [] } }, "docs": "Creates and sends a new media message or multiple messages. Sending MMS\nmessages simultaneously to different recipients is limited up to 50\nrequests per minute; relevant for all client applications.\n" } ] }, { "info": { "name": "Features", "type": "folder" }, "items": [ { "info": { "name": "Get User Features", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/features", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "availableOnly", "value": "", "type": "query", "description": "Allows to filter features by availability for an extension\n" }, { "name": "featureId", "value": "", "type": "query", "description": "Internal identifier(s) of the feature(s)" } ] }, "docs": "Returns a list of supported features and the information on their\navailability for the current extension. Particular feature(s) can\nbe checked by providing `featureId` query parameter. Multiple values\nare supported in the format: `?featureId=Feature1&featureId=Feature2`.\nTo get only available features in order to decrease response size,\n`availableOnly=true` query param can be specified. If a feature\nis available for the current user, `\"available\": true` is returned in\nresponse for the record wit" } ] }, { "info": { "name": "Call Blocking", "type": "folder" }, "items": [ { "info": { "name": "Get Caller Blocking Settings", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "docs": "Returns the current caller blocking settings of a user." }, { "info": { "name": "Update Caller Blocking Settings", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the current caller blocking settings of a user." }, { "info": { "name": "List Blocked/Allowed Phone Numbers", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking/phone-numbers", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "page", "value": "1", "type": "query", "description": "The result set page number (1-indexed) to return" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" }, { "name": "status", "value": "", "type": "query" } ] }, "docs": "Returns the lists of blocked and allowed phone numbers." }, { "info": { "name": "Add Blocked/Allowed Number", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking/phone-numbers", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates either blocked or allowed phone number list with a new phone number." }, { "info": { "name": "Get Blocked/Allowed Number", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking/phone-numbers/:blockedNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "blockedNumberId", "value": "", "type": "path", "description": "Internal identifier of a blocked number entry" } ] }, "docs": "Returns blocked or allowed phone number(s) by their ID(s). \n[Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.\n" }, { "info": { "name": "Update Blocked/Allowed Number", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking/phone-numbers/:blockedNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "blockedNumberId", "value": "", "type": "path", "description": "Internal identifier of a blocked number entry" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates blocked or allowed phone number(s) by their ID(s). \n[Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.\n" }, { "info": { "name": "Delete Blocked/Allowed Number", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/account/:accountId/extension/:extensionId/caller-blocking/phone-numbers/:blockedNumberId", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "extensionId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" }, { "name": "blockedNumberId", "value": "", "type": "path", "description": "Internal identifier of a blocked number entry" } ] }, "docs": "Deletes blocked or allowed phone number(s) by their ID(s). Batch request is supported." } ] }, { "info": { "name": "Subscriptions", "type": "folder" }, "items": [ { "info": { "name": "List Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/subscription" }, "docs": "Returns a list of subscriptions created by the user for the current authorized client application.\n" }, { "info": { "name": "Create Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/subscription", "body": { "type": "json", "data": "{}" } }, "docs": "This API allows client applications to register a new subscription so that it\ncan be notified of events when they occur on the platform.\n\nA subscription relates to a set of events that a client application would like\nto be informed of and the delivery channel by which they will be notified of\nthose events. How subscriptions are established depends upon the notification\nchannel the client application would like to use to receive the event\nnotification. For example, to create a webhook a developer" }, { "info": { "name": "Get Subscription", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/subscription/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "12345678", "type": "path", "description": "Internal identifier of a subscription" } ] }, "docs": "Returns the existing subscription by ID." }, { "info": { "name": "Update Subscription", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/restapi/v1.0/subscription/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "12345678", "type": "path", "description": "Internal identifier of a subscription" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the existing subscription. The client application can extend or narrow\nthe list of events for which it receives notifications within the current subscription.\nIf event filters are specified, calling this method modifies them for the\nexisting subscription. The method also allows one to set an expiration time for the\nsubscription itself.\n\nIf parameters other than `events` and `expiresIn` are specified in the request they will be ignored.\nIf the request body is empty then the specified subs" }, { "info": { "name": "Cancel Subscription", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/restapi/v1.0/subscription/:subscriptionId", "params": [ { "name": "subscriptionId", "value": "12345678", "type": "path", "description": "Internal identifier of a subscription" } ] }, "docs": "Cancels the existing subscription." }, { "info": { "name": "Renew Subscription", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/subscription/:subscriptionId/renew", "params": [ { "name": "subscriptionId", "value": "12345678", "type": "path", "description": "Internal identifier of a subscription" } ] }, "docs": "Renews the existing subscription (this request comes with empty body).\n\nPlease note that `WebSocket` subscriptions are renewed automatically while websocket session is alive.\n" } ] }, { "info": { "name": "Regional Settings", "type": "folder" }, "items": [ { "info": { "name": "List States", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/state", "params": [ { "name": "allCountries", "value": "", "type": "query", "description": "If set to `true` then states of all countries are returned and\n`countryId` is ignored, even if specified. If the value is empty\nthen the parameter is ignored\n" }, { "name": "countryId", "value": "", "type": "query", "description": "Internal identifier of a country" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" }, { "name": "withPhoneNumbers", "value": "", "type": "query", "description": "If `true` the list of states with phone numbers available for\nbuying is returned\n" } ] }, "docs": "Returns all states of a certain country.\n" }, { "info": { "name": "Get State", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/state/:stateId", "params": [ { "name": "stateId", "value": "", "type": "path", "description": "Internal identifier of a state" } ] }, "docs": "Returns information on a specific state by ID.\n" }, { "info": { "name": "List Locations", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/location", "params": [ { "name": "orderBy", "value": "", "type": "query", "description": "Sorts results by the property specified" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)" }, { "name": "stateId", "value": "", "type": "query", "description": "Internal identifier of a state" }, { "name": "withNxx", "value": "", "type": "query", "description": "Specifies if `nxx` codes are returned" } ] }, "docs": "Returns all available locations for a certain state.\n" }, { "info": { "name": "List Languages", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/language" }, "docs": "Returns information about the supported languages.\n" }, { "info": { "name": "Get Language", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/language/:languageId", "params": [ { "name": "languageId", "value": "", "type": "path", "description": "Internal identifier of a language" } ] }, "docs": "Returns a language by ID.\n" }, { "info": { "name": "List Timezones", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone", "params": [ { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare allowed. Default value is '1'\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items). If not specified, the value is '100' by default" } ] }, "docs": "Returns all available timezones.\n" }, { "info": { "name": "Get Timezone", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/timezone/:timezoneId", "params": [ { "name": "timezoneId", "value": "", "type": "path", "description": "Internal identifier of a timezone" } ] }, "docs": "Returns information on a certain timezone.\n" }, { "info": { "name": "List Countries", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/country", "params": [ { "name": "loginAllowed", "value": "", "type": "query", "description": "Specifies whether the logging-in with the phone numbers of this country\nis enabled or not\n" }, { "name": "signupAllowed", "value": "", "type": "query", "description": "Indicates whether a signup/billing is allowed for a country. If\nnot specified all countries are returned (according to other\nspecified filters if any)\n" }, { "name": "numberSelling", "value": "", "type": "query", "description": "Specifies if RingCentral sells phone numbers of this country\n" }, { "name": "page", "value": "", "type": "query", "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n" }, { "name": "perPage", "value": "", "type": "query", "description": "Indicates a page size (number of items)\n" }, { "name": "freeSoftphoneLine", "value": "", "type": "query", "description": "Specifies if free phone line for softphone is available for a\ncountry or not\n" } ] }, "docs": "Returns all countries available for calling.\n" }, { "info": { "name": "Get Country", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/restapi/v1.0/dictionary/country/:countryId", "params": [ { "name": "countryId", "value": "", "type": "path", "description": "Internal identifier of a country" } ] }, "docs": "Returns information on a specific country.\n" } ] }, { "info": { "name": "Device SIP Registration", "type": "folder" }, "items": [ { "info": { "name": "Register Device", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/restapi/v1.0/client-info/sip-provision", "body": { "type": "json", "data": "{}" } }, "docs": "Creates SIP registration of a device/application (WebPhone, Mobile, Softphone).\n" } ] }, { "info": { "name": "Status", "type": "folder" }, "items": [ { "info": { "name": "Get Async Task Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/ai/status/v1/jobs/:jobId", "params": [ { "name": "jobId", "value": "", "type": "path", "description": "The job id to which status will be fetched" } ] }, "docs": "Returns async task status by Job ID" } ] }, { "info": { "name": "Text", "type": "folder" }, "items": [ { "info": { "name": "Conversational Summarization", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/ai/text/v1/async/summarize", "params": [ { "name": "webhook", "value": "", "type": "query", "description": "The webhook URI to which the job response will be returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns Conversational Summarization to the webhook URI for segmented transcript of audios\nwith start, end, speakerId, text(alphanumeric and punctuations).\n" }, { "info": { "name": "Smart Punctuation", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/ai/text/v1/async/punctuate", "params": [ { "name": "webhook", "value": "", "type": "query", "description": "The webhook URI to which the job response will be returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns Smart Punctuation to the provided webhook URI." } ] }, { "info": { "name": "Audio", "type": "folder" }, "items": [ { "info": { "name": "List Enrolled Speakers", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/ai/audio/v1/enrollments", "params": [ { "name": "partial", "value": "", "type": "query", "description": "Indicates if partially enrolled speakers should be returned" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of enrollments to be returned per page" }, { "name": "page", "value": "", "type": "query", "description": "Page number to be returned" } ] }, "docs": "Returns the List of Enrolled Speakers" }, { "info": { "name": "Create Speaker Enrollment", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/ai/audio/v1/enrollments", "body": { "type": "json", "data": "{}" } }, "docs": "Creates Enrollment for the provided Speaker." }, { "info": { "name": "Get Speaker Enrollment Status", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/ai/audio/v1/enrollments/:speakerId", "params": [ { "name": "speakerId", "value": "JohnDoe", "type": "path", "description": "Speaker identifier of enrolled speaker" } ] }, "docs": "Get The Status of Enrollment for the provided Speaker." }, { "info": { "name": "Update Speaker Enrollment", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/ai/audio/v1/enrollments/:speakerId", "params": [ { "name": "speakerId", "value": "JohnDoe", "type": "path", "description": "Speaker identifier of enrolled speaker" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add newer audio data to improve an existing speaker enrollment" }, { "info": { "name": "Delete Speaker Enrollment", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/ai/audio/v1/enrollments/:speakerId", "params": [ { "name": "speakerId", "value": "JohnDoe", "type": "path", "description": "Speaker identifier of enrolled speaker" } ] }, "docs": "Delete The Enrollment for the provided Speaker." }, { "info": { "name": "Speech to Text Conversion", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/ai/audio/v1/async/speech-to-text", "params": [ { "name": "webhook", "value": "", "type": "query", "description": "The webhook URI to which the job response will be returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns Speech to Text Conversion to the provided webhook URI." }, { "info": { "name": "Speaker Diarization", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/ai/audio/v1/async/speaker-diarize", "params": [ { "name": "webhook", "value": "", "type": "query", "description": "The webhook URI to which the job response will be returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Identifies who said what. Speaker diarization will identify the speaker for each segment\nso you can tell who spoke the sentence, paragraph, or phrase.\n" }, { "info": { "name": "Speaker Identification", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/ai/audio/v1/async/speaker-identify", "params": [ { "name": "webhook", "value": "", "type": "query", "description": "The webhook URI to which the job response will be returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns Speaker Identification to the provided webhook URI." } ] }, { "info": { "name": "Insights", "type": "folder" }, "items": [ { "info": { "name": "Interaction Analytics", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/ai/insights/v1/async/analyze-interaction", "params": [ { "name": "webhook", "value": "", "type": "query", "description": "The webhook URI to which the job response will be returned" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns multiple insights including summaries, emotion, key phrases, questions asked, and more in a single API call.\n" } ] }, { "info": { "name": "Contents", "type": "folder" }, "items": [ { "info": { "name": "List All Contents", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/cx/social-messaging/v1/contents", "params": [ { "name": "intervention", "value": "7f946431b6eebffafae642cc,re946431b6eebffafae642cc", "type": "query", "description": "Filter based on the specified intervention identifiers." }, { "name": "identity", "value": "7f946431b6eebffafae642cc,re946431b6eebffafae642cc", "type": "query", "description": "Filter based on the specified identity identifiers." }, { "name": "identityGroup", "value": "7f946431b6eebffafae642cc,re946431b6eebffafae642cc", "type": "query", "description": "Filter based on the specified identity group identifiers." }, { "name": "source", "value": "7f946431b6eebffafae642cc", "type": "query", "description": "Filter based on the specified channel identifiers." }, { "name": "thread", "value": "7f946431b6eebffafae642cc", "type": "query", "description": "Filter based on the specified thread identifiers." }, { "name": "text", "value": "", "type": "query", "description": "Filter based on the specified text(s). Provided multiple times, the values are ANDed." }, { "name": "status", "value": "", "type": "query", "description": "Filter for specified status." }, { "name": "orderBy", "value": "", "type": "query", "description": "Order results by specified field." }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" } ] }, "docs": "List contents by creation date. The default creation order is descending.\n\nThe account context of this request is determined by the RC Account Id associated with the access token provided\nin the Authorization header.\n\nThe query parameters provided shall be considered an AND operation to filter the list.\n\nA query parameter not specified or a query parameter provided with no value is treated as not required for\nfiltering the list.\n" }, { "info": { "name": "Create Content", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/cx/social-messaging/v1/contents", "body": { "type": "json", "data": "{}" } }, "docs": "Creates new content for use in discussions.\n\nThis request is used to reply to already-posted content or to initiate a discussion. If authorized, the\nauthenticated user will be used as the content author.\n\nContent will be created and pushed asynchronously to the channel. When the content is successfully pushed to\nthe channel, the Content.Exported event will be reported.\n\nThe account context of this request is determined by the RC Account Id associated with the access token provided\nin the Authori" }, { "info": { "name": "Get Content", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/cx/social-messaging/v1/contents/:contentId", "params": [ { "name": "contentId", "value": "", "type": "path" } ] }, "docs": "Retrieves the content from the given id.\n" } ] }, { "info": { "name": "Identities", "type": "folder" }, "items": [ { "info": { "name": "List All Identities", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/cx/social-messaging/v1/identities", "params": [ { "name": "sourceId", "value": "", "type": "query", "description": "Filter based on the specified sourceId." }, { "name": "identityGroupIds", "value": "", "type": "query", "description": "Filter based on the specified identityGroupIds (separated by commas)." }, { "name": "userId", "value": "", "type": "query", "description": "Filter based on the specified userId." }, { "name": "uuid", "value": "", "type": "query", "description": "Filter based on the specified uuid." }, { "name": "orderBy", "value": "", "type": "query", "description": "Order results by specified field." }, { "name": "pageToken", "value": "", "type": "query", "description": "The token indicating the particular page of the result set to be retrieved.\nIf omitted the first page will be returned.\n" }, { "name": "perPage", "value": "100", "type": "query", "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n" } ] }, "docs": "List identities by creation date. The default order is descending.\n\nThe account context of this request is determined by the RC Account Id associated with the access token provided\nin the Authorization header.\n\nThe query parameters provided shall be considered an AND operation to filter the list.\n\nA query parameter not specified or a query parameter provided with no value is treated as not required for\nfiltering the list.\n" }, { "info": { "name": "Get Identity", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/cx/social-messaging/v1/identities/:identityId", "params": [ { "name": "identityId", "value": "", "type": "path" } ] }, "docs": "Renders an identity from given id.\n" } ] }, { "info": { "name": "SCIM", "type": "folder" }, "items": [ { "info": { "name": "List Schemas", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/scim/v2/Schemas" }, "docs": "Returns the list of schemas" }, { "info": { "name": "Get Schema", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/scim/v2/Schemas/:uri", "params": [ { "name": "uri", "value": "", "type": "path", "description": "Schema URI" } ] }, "docs": "Returns SCIM schema" }, { "info": { "name": "Search/List Users", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/scim/v2/Users", "params": [ { "name": "filter", "value": "", "type": "query", "description": "Only support 'userName' or 'email' filter expressions for now" }, { "name": "startIndex", "value": "", "type": "query", "description": "Start index (1-based)" }, { "name": "count", "value": "", "type": "query", "description": "Page size" } ] }, "docs": "Returns the list of users satisfying search criteria" }, { "info": { "name": "Create User", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/scim/v2/Users", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user" }, { "info": { "name": "Search/List Users", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/scim/v2/Users/.search", "body": { "type": "json", "data": "{}" } }, "docs": "Returns the list of users satisfying search criteria" }, { "info": { "name": "Get User", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/scim/v2/Users/:scimUserId", "params": [ { "name": "scimUserId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Returns a user by ID" }, { "info": { "name": "Update/Replace User", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/scim/v2/Users/:scimUserId", "params": [ { "name": "scimUserId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user" }, { "info": { "name": "Update/Patch User", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/scim/v2/Users/:scimUserId", "params": [ { "name": "scimUserId", "value": "", "type": "path", "description": "User ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a user (partial update)" }, { "info": { "name": "Delete User", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/scim/v2/Users/:scimUserId", "params": [ { "name": "scimUserId", "value": "", "type": "path", "description": "User ID" } ] }, "docs": "Deletes a user" }, { "info": { "name": "Get Provider Config", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/scim/v2/ServiceProviderConfig" }, "docs": "Returns SCIM service provider configuration" }, { "info": { "name": "List Resource Types", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/scim/v2/ResourceTypes" }, "docs": "Returns the list of supported SCIM resource types" }, { "info": { "name": "Get Resource Type", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/scim/v2/ResourceTypes/:type", "params": [ { "name": "type", "value": "", "type": "path", "description": "Resource type" } ] }, "docs": "Returns resource type by ID" } ] }, { "info": { "name": "Business Analytics", "type": "folder" }, "items": [ { "info": { "name": "Calls Aggregation Data", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/analytics/calls/v1/accounts/:accountId/aggregation/fetch", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "page", "value": "", "type": "query", "description": "The current page number (positive numbers only)" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of records displayed on a page (positive numbers only, max value of 200)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns call aggregations filtered by parameters specified" }, { "info": { "name": "Calls Timeline Data", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/analytics/calls/v1/accounts/:accountId/timeline/fetch", "params": [ { "name": "accountId", "value": "~", "type": "path", "description": "Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "name": "interval", "value": "", "type": "query", "description": "Aggregation interval" }, { "name": "page", "value": "", "type": "query", "description": "The current page number (positive numbers only)" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of records displayed on a page (positive numbers only, max value of 20)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Returns time-value data aggregations filtered by parameters specified" } ] }, { "info": { "name": "Tasks", "type": "folder" }, "items": [ { "info": { "name": "Get Task", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/tasks/:taskId", "params": [ { "name": "taskId", "value": "", "type": "path", "description": "Task identifier or comma separated list of task IDs" } ] }, "docs": "Returns information about the specified task(s) by ID(s)." }, { "info": { "name": "Update Task", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/team-messaging/v1/tasks/:taskId", "params": [ { "name": "taskId", "value": "", "type": "path", "description": "Internal identifier of a task" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified task by ID." }, { "info": { "name": "Delete Task", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/team-messaging/v1/tasks/:taskId", "params": [ { "name": "taskId", "value": "", "type": "path", "description": "Internal identifier of a task" } ] }, "docs": "Deletes the specified task." }, { "info": { "name": "Complete Task", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/tasks/:taskId/complete", "params": [ { "name": "taskId", "value": "", "type": "path", "description": "Internal identifier of a task" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Completes a task in the specified chat." }, { "info": { "name": "List Chat Tasks", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/tasks", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat" }, { "name": "creationTimeTo", "value": "", "type": "query", "description": "The end datetime for resulting records in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\nformat including timezone, e.g. 2019-03-10T18:23:45Z\n" }, { "name": "creationTimeFrom", "value": "", "type": "query", "description": "The start datetime for resulting records in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\nformat including timezone, e.g. 2016-02-23T00:00:00\n" }, { "name": "creatorId", "value": "", "type": "query", "description": "Internal identifier of a task creator" }, { "name": "status", "value": "", "type": "query", "description": "Task execution status" }, { "name": "assignmentStatus", "value": "", "type": "query", "description": "Task assignment status" }, { "name": "assigneeId", "value": "", "type": "query", "description": "Internal identifier of a task assignee" }, { "name": "assigneeStatus", "value": "", "type": "query", "description": "Task execution status by assignee(-s) specified in assigneeId" }, { "name": "pageToken", "value": "", "type": "query", "description": "Token of the current page. If token is omitted then the first\npage should be returned\n" }, { "name": "recordCount", "value": "", "type": "query", "description": "Number of records to be returned per screen" } ] }, "docs": "Returns the list of tasks of the specified chat." }, { "info": { "name": "Create Task", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/tasks", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a task in the specified chat." } ] }, { "info": { "name": "Calendar Events", "type": "folder" }, "items": [ { "info": { "name": "List User Events", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/events", "params": [ { "name": "recordCount", "value": "", "type": "query", "description": "Number of groups to be fetched by one request. The maximum value is 250, by default - 30." }, { "name": "pageToken", "value": "", "type": "query", "description": "Token of a page to be returned" } ] }, "docs": "Returns all calendar events created by the current user." }, { "info": { "name": "Create Event", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/events", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new calendar event." }, { "info": { "name": "Get Event", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/events/:eventId", "params": [ { "name": "eventId", "value": "", "type": "path", "description": "Event id or comma separated list of event ids." } ] }, "docs": "Returns the specified calendar event(s) by ID(s)." }, { "info": { "name": "Update Event", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/team-messaging/v1/events/:eventId", "params": [ { "name": "eventId", "value": "", "type": "path", "description": "Internal identifier of an event" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified calendar event." }, { "info": { "name": "Delete Event", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/team-messaging/v1/events/:eventId", "params": [ { "name": "eventId", "value": "", "type": "path", "description": "Internal identifier of an event to be deleted" } ] }, "docs": "Deletes the specified calendar event." }, { "info": { "name": "List Group Events", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/groups/:groupId/events", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a group" } ] }, "docs": "Returns a list of calendar events available for the current user within the specified group. Users can only see their personal tasks and public tasks." }, { "info": { "name": "Create Event by Group ID", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/groups/:groupId/events", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a group" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new calendar event within the specified group." } ] }, { "info": { "name": "Chats", "type": "folder" }, "items": [ { "info": { "name": "List Recent Chats", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/recent/chats", "params": [ { "name": "type", "value": "", "type": "query", "description": "Type of chats to be fetched. By default, all chat types are returned" }, { "name": "recordCount", "value": "", "type": "query", "description": "Max number of chats to be fetched by one request (Not more than 250)." } ] }, "docs": "Returns recent chats where the user is a member. All records in response are sorted by the `lastModifiedTime` in descending order (the latest changed chat is displayed first on page)" }, { "info": { "name": "List Chats", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/chats", "params": [ { "name": "type", "value": "", "type": "query", "description": "Type of chats to be fetched. By default, all type of chats will be fetched" }, { "name": "recordCount", "value": "", "type": "query", "description": "Number of chats to be fetched by one request. The maximum value is 250, by default - 30." }, { "name": "pageToken", "value": "", "type": "query", "description": "Pagination token." } ] }, "docs": "Returns the list of chats where the user is a member and also public teams that can be joined.\n\nAll records in response are sorted by creation time of a chat in ascending order.\n\n**Chat types**\n\nThere are multiple types of chats, including:\n\n* **Personal** - each user is given a dedicated \"personal chat\" in which they are the only member.\n* **Direct** - a chat between two individuals.\n* **Group** - a chat between three or more named individuals. A \"group\" chat has no name.\n* **Team** - a chat re" }, { "info": { "name": "Get Chat", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat. If tilde (~) is specified, then `/me` (Personal) chat will be returned" } ] }, "docs": "Returns information about a chat by ID.\n\n**Note** 'Chat' is a general name for all types of threads including *Personal* (user's own me-chat), *Direct* (one on one chat), *Group* (chat of 3-15 participants without specific name), *Team* (chat of 2 and more participants, with a specific name), *Everyone* (company chat including all employees, with a specific name).\"\n" }, { "info": { "name": "Remove Chat from Favorites", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/unfavorite", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat to remove from favorite list." } ] }, "docs": "Removes the specified chat from the users's list of favorite chats." }, { "info": { "name": "Add Chat to Favorites", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/favorite", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat to add to favorite list." } ] }, "docs": "Adds the specified chat to the users's list of favorite chats." }, { "info": { "name": "List Favorite Chats", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/favorites", "params": [ { "name": "recordCount", "value": "", "type": "query", "description": "Max number of chats to be fetched by one request (Not more than 250)." } ] }, "docs": "Returns a list of the current user's favorite chats." } ] }, { "info": { "name": "Posts", "type": "folder" }, "items": [ { "info": { "name": "Upload File", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/files", "params": [ { "name": "groupId", "value": "", "type": "query", "description": "Internal identifier of a group to which the post with attachment will be added to" }, { "name": "name", "value": "", "type": "query", "description": "Name of a file attached" } ], "body": { "type": "multipart-form", "data": [ { "name": "body", "type": "text", "value": "" } ] } }, "docs": "Posts a file." }, { "info": { "name": "List Posts", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/posts", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat" }, { "name": "recordCount", "value": "", "type": "query", "description": "Max number of posts to be fetched by one request (not more than 250)" }, { "name": "pageToken", "value": "", "type": "query", "description": "Pagination token." } ] }, "docs": "Returns a list of posts from the specified chat." }, { "info": { "name": "Create Post", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/posts", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a post in the chat specified in path. Any mention can be added within the `text` attribute of the request body in .md format - `![:Type](id)`, where `type` is one of (Person, Team, File, Note, Task, Event, Link, Card) and `id` is a unique identifier of the mentioned object of the specified type. Attachments of the following types (File, Card, Event, Note) can also be added to a post by passing type and ID of attachment(s) in request body." }, { "info": { "name": "Get Post", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/posts/:postId", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat" }, { "name": "postId", "value": "", "type": "path", "description": "Internal identifier of a post" } ] }, "docs": "Returns information about the specified post." }, { "info": { "name": "Update Post", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/posts/:postId", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat" }, { "name": "postId", "value": "", "type": "path", "description": "Internal identifier of a post to be updated" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a specific post within a chat." }, { "info": { "name": "Delete Post", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/posts/:postId", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat" }, { "name": "postId", "value": "", "type": "path", "description": "Internal identifier of a post to be deleted" } ] }, "docs": "Deletes the specified post from the chat." } ] }, { "info": { "name": "Adaptive Cards", "type": "folder" }, "items": [ { "info": { "name": "Create Adaptive Card", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/adaptive-cards", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new adaptive card in the chat specified in path." }, { "info": { "name": "Get Adaptive Card", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/adaptive-cards/:cardId", "params": [ { "name": "cardId", "value": "", "type": "path", "description": "Internal identifier of an adaptive card, or comma separated list of adaptive cards IDs." } ] }, "docs": "Returns adaptive card(s) with given id(s)." }, { "info": { "name": "Update Adaptive Card", "type": "http" }, "http": { "method": "PUT", "url": "https://platform.ringcentral.com/team-messaging/v1/adaptive-cards/:cardId", "params": [ { "name": "cardId", "value": "", "type": "path", "description": "Internal identifier of an adaptive card" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an adaptive card." }, { "info": { "name": "Delete Adaptive Card", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/team-messaging/v1/adaptive-cards/:cardId", "params": [ { "name": "cardId", "value": "", "type": "path", "description": "Adaptive Card ID to be deleted." } ] }, "docs": "Deletes an adaptive card by ID." } ] }, { "info": { "name": "Notes", "type": "folder" }, "items": [ { "info": { "name": "List Notes", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/notes", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat to fetch notes from." }, { "name": "creationTimeTo", "value": "", "type": "query", "description": "The end datetime for resulting records in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\nformat including timezone, e.g. 2019-03-10T18:23:45. The default value is\nNow.\n" }, { "name": "creationTimeFrom", "value": "", "type": "query", "description": "The start datetime for resulting records in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)\nformat including timezone\n" }, { "name": "creatorId", "value": "", "type": "query", "description": "Internal identifier of the user that created the note. Multiple\nvalues are supported\n" }, { "name": "status", "value": "", "type": "query", "description": "Status of notes to be fetched; if not specified all notes are\nfetched by default.\n" }, { "name": "pageToken", "value": "", "type": "query", "description": "Pagination token" }, { "name": "recordCount", "value": "", "type": "query", "description": "Max number of notes to be fetched by one request; the value range is 1-250." } ] }, "docs": "Returns the list of chat notes." }, { "info": { "name": "Create Note", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/chats/:chatId/notes", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a chat to create a note in" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new note in the specified chat." }, { "info": { "name": "Get Note", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/notes/:noteId", "params": [ { "name": "noteId", "value": "", "type": "path", "description": "Internal identifier of a note to be fetched" } ] }, "docs": "Returns the specified note(s). It is possible to fetch up to 50 notes per request." }, { "info": { "name": "Update Note", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/team-messaging/v1/notes/:noteId", "params": [ { "name": "noteId", "value": "", "type": "path", "description": "Internal identifier of a note to be updated" }, { "name": "releaseLock", "value": "", "type": "query", "description": "If true then note lock (if any) will be released upon request" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits a note. Notes can be edited by any user if posted to a chat. the user belongs to." }, { "info": { "name": "Delete Note", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/team-messaging/v1/notes/:noteId", "params": [ { "name": "noteId", "value": "", "type": "path", "description": "Internal identifier of a note to be deleted" } ] }, "docs": "Deletes the specified note." }, { "info": { "name": "Lock Note", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/notes/:noteId/lock", "params": [ { "name": "noteId", "value": "", "type": "path", "description": "Internal identifier of a note to be locked" } ] }, "docs": "Locks a note providing the user with the unique write access for 5 hours." }, { "info": { "name": "Publish Note", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/notes/:noteId/publish", "params": [ { "name": "noteId", "value": "", "type": "path", "description": "Internal identifier of a note to be published" } ] }, "docs": "Publishes a note making it visible to other users." }, { "info": { "name": "Unlock Note", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/notes/:noteId/unlock", "params": [ { "name": "noteId", "value": "", "type": "path", "description": "Internal identifier of a note to be unlocked" } ] }, "docs": "Unlocks a note letting other users edit this note. Once the note is locked (by another user) it cannot be unlocked during 5 hours since the lock datetime." } ] }, { "info": { "name": "Incoming Webhooks", "type": "folder" }, "items": [ { "info": { "name": "List Webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/webhooks" }, "docs": "Returns the list of all webhooks associated with the current account." }, { "info": { "name": "Get Webhook", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "Internal identifier of a webhook or comma separated list of webhooks IDs" } ] }, "docs": "Returns webhooks(s) with the specified id(s)." }, { "info": { "name": "Delete Webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/team-messaging/v1/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "Internal identifier of a webhook" } ] }, "docs": "Deletes a webhook by ID." }, { "info": { "name": "Activate Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/webhooks/:webhookId/activate", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "Internal identifier of a webhook" } ] }, "docs": "Activates a webhook by ID." }, { "info": { "name": "Suspend Webhook", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/webhooks/:webhookId/suspend", "params": [ { "name": "webhookId", "value": "", "type": "path", "description": "Internal identifier of a webhook" } ] }, "docs": "Suspends a webhook by ID." }, { "info": { "name": "List Webhooks in Group", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/groups/:groupId/webhooks", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a group" } ] }, "docs": "Returns webhooks which are available for the current user by group ID." }, { "info": { "name": "Create Webhook in Group", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/groups/:groupId/webhooks", "params": [ { "name": "groupId", "value": "", "type": "path", "description": "Internal identifier of a group" } ] }, "docs": "Creates a new webhook." } ] }, { "info": { "name": "Profile", "type": "folder" }, "items": [ { "info": { "name": "Get Company Info", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/companies/:companyId", "params": [ { "name": "companyId", "value": "", "type": "path", "description": "Internal identifier of an RC account/Glip company, or tilde (~) to indicate a company the current user belongs to." } ] }, "docs": "Returns information about one or more companies by their IDs." }, { "info": { "name": "Get Person", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/persons/:personId", "params": [ { "name": "personId", "value": "", "type": "path", "description": "Internal identifier of a user to be returned, the maximum number of IDs is 30" } ] }, "docs": "Returns a user or multiple users by their ID(s). Batch request is supported." } ] }, { "info": { "name": "Conversations", "type": "folder" }, "items": [ { "info": { "name": "List Conversations", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/conversations", "params": [ { "name": "recordCount", "value": "", "type": "query", "description": "Number of conversations to be fetched by one request. The maximum value is 250, by default - 30" }, { "name": "pageToken", "value": "", "type": "query", "description": "Pagination token." } ] }, "docs": "Returns the list of conversations where the user is a member. All records in response are sorted by creation time of a conversation in ascending order. Conversation is a chat of the *Group* type." }, { "info": { "name": "Create/Open Conversation", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/conversations", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new conversation or opens the existing one. If the conversation already exists, then its ID will be returned in response. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description; it is a chat of 'Group' type. If you add a person to the existing conversation (group), it creates a whole new conversation." }, { "info": { "name": "Get Conversation", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/conversations/:chatId", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a conversation to be returned." } ] }, "docs": "Returns information about the specified conversation, including the list of conversation participants. A conversation is an adhoc discussion between a particular set of users, not featuring any specific name or description; it is a chat of 'Group' type. If you add a person to the existing conversation, it creates a whole new conversation." } ] }, { "info": { "name": "Compliance Exports", "type": "folder" }, "items": [ { "info": { "name": "List Data Export Tasks", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/data-export", "params": [ { "name": "status", "value": "", "type": "query", "description": "Status of the task(s) to be returned. Multiple values are supported" }, { "name": "page", "value": "", "type": "query", "description": "Page number to be retrieved; value range is > 0" }, { "name": "perPage", "value": "", "type": "query", "description": "Number of records to be returned per page; value range is 1 - 250" } ] }, "docs": "Returns the list of Glip data export tasks." }, { "info": { "name": "Create Data Export Task", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/data-export", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a task for Glip data export and returns a link at which the exported data will be available in future once the task is implemented. The exported data can be downloaded by calling Get Data Export Task method with the specified task ID. Simultaneously no more than 2 tasks per company can be created." }, { "info": { "name": "Get Data Export Task", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/data-export/:taskId", "params": [ { "name": "taskId", "value": "", "type": "path", "description": "Internal identifier of a task to be retrieved" } ] }, "docs": "Returns the links for downloading Glip data exported within the specified task. If the export task is still in progress, then only the task status will be returned. If the data is ready for downloading, then the list of URLs will be returned." } ] }, { "info": { "name": "Teams", "type": "folder" }, "items": [ { "info": { "name": "Get Everyone Chat", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/everyone" }, "docs": "Returns information about \"Everyone\" chat (a company level chat which includes all employees)." }, { "info": { "name": "Update Everyone Chat", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/team-messaging/v1/everyone", "body": { "type": "json", "data": "{}" } }, "docs": "Updates \"Everyone\" chat information." }, { "info": { "name": "List Teams", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/teams", "params": [ { "name": "recordCount", "value": "", "type": "query", "description": "Number of teams to be fetched by one request. The maximum value is 250, by default - 30" }, { "name": "pageToken", "value": "", "type": "query", "description": "Pagination token." } ] }, "docs": "Returns the list of teams where the user is a member (both archived and active) combined with a list of public teams that can be joined by the current user. All records in response are sorted by creation time of a chat in ascending order. A team is a chat between 2 and more (unlimited number) participants assigned with specific name." }, { "info": { "name": "Create Team", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/teams", "body": { "type": "json", "data": "{}" } }, "docs": "Creates a team, and adds a list of people to the team." }, { "info": { "name": "Get Team", "type": "http" }, "http": { "method": "GET", "url": "https://platform.ringcentral.com/team-messaging/v1/teams/:chatId", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a team to be returned." } ] }, "docs": "Returns information about the specified team." }, { "info": { "name": "Update Team", "type": "http" }, "http": { "method": "PATCH", "url": "https://platform.ringcentral.com/team-messaging/v1/teams/:chatId", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a team to be updated." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the name and description of the specified team." }, { "info": { "name": "Delete Team", "type": "http" }, "http": { "method": "DELETE", "url": "https://platform.ringcentral.com/team-messaging/v1/teams/:chatId", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a team." } ] }, "docs": "Deletes the specified team." }, { "info": { "name": "Remove Team Members", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/teams/:chatId/remove", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a team to remove members from." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes members from the specified team." }, { "info": { "name": "Join Team", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/teams/:chatId/join", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a team to be joined." } ] }, "docs": "Adds the current user to the specified team." }, { "info": { "name": "Archive Team", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/teams/:chatId/archive", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a team to be archived." } ] }, "docs": "Changes the status of the specified team to 'Archived'." }, { "info": { "name": "Unarchive Team", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/teams/:chatId/unarchive", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a team to be made active." } ] }, "docs": "Changes the status of the specified team to 'Active'." }, { "info": { "name": "Leave Team", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/teams/:chatId/leave", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a team to be left." } ] }, "docs": "Removes the current user from the specified team." }, { "info": { "name": "Add Team Members", "type": "http" }, "http": { "method": "POST", "url": "https://platform.ringcentral.com/team-messaging/v1/teams/:chatId/add", "params": [ { "name": "chatId", "value": "", "type": "path", "description": "Internal identifier of a team to add members to." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds members to the specified team." } ] } ], "bundled": true }