{ "info": { "_postman_id": "94f85b4f-6533-42ee-8896-89e1759cc8df", "name": "RingCentral Adaptive Cards Call Control API", "description": "RingCentral API specification\n\nContact Support:\n Name: RingCentral Developers Support", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "lastUpdatedBy": "35240", "uid": "35240-94f85b4f-6533-42ee-8896-89e1759cc8df" }, "item": [ { "name": "restapi", "item": [ { "name": "v1.0", "item": [ { "name": "account", "item": [ { "name": "{accountId}", "item": [ { "name": "telephony", "item": [ { "name": "call-out", "item": [ { "name": "Make CallOut", "id": "2b97324e-7f3b-44fe-ba0b-a68b960e8c96", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"deviceId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"extensionNumber\": \"\"\n },\n \"countryId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/call-out", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "call-out" ], "variable": [ { "id": "ed926f14-b4e2-4354-a365-763ba1f2e257", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "description": "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." }, "response": [ { "id": "e919939a-e844-4ee8-b702-5d5b25f24c62", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"deviceId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"extensionNumber\": \"\"\n },\n \"countryId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/call-out", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "call-out" ], "variable": [ { "key": "accountId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"session\": {\n \"id\": \"\",\n \"origin\": {\n \"type\": \"GreetingsRecording\"\n },\n \"voiceCallToken\": \"\",\n \"parties\": [\n {\n \"id\": \"\",\n \"status\": {\n \"code\": \"Tds\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"InternalError\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Host\",\n \"ringOutRole\": \"Initiator\",\n \"ringMeRole\": \"Target\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"status\": {\n \"code\": \"Parked\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"Rejected\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Host\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n }\n ],\n \"creationTime\": \"\"\n }\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-e919939a-e844-4ee8-b702-5d5b25f24c62" }, { "id": "30b730e7-e94e-4feb-99e9-a5c521bc2ce5", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"from\": {\n \"deviceId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"extensionNumber\": \"\"\n },\n \"countryId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/call-out", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "call-out" ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-30b730e7-e94e-4feb-99e9-a5c521bc2ce5" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-2b97324e-7f3b-44fe-ba0b-a68b960e8c96" } ], "id": "75acaac8-9ccd-496e-9925-7409061ed1a7", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-75acaac8-9ccd-496e-9925-7409061ed1a7" }, { "name": "conference", "item": [ { "name": "Start Conference Call Session", "id": "9f1f2c33-69ce-4856-845e-7de9b3a38db5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/conference", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "conference" ], "variable": [ { "id": "9445368c-175c-4453-8a8c-916b75eed4ee", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" } ] }, "description": "Initiates a conference call session." }, "response": [ { "id": "337af24e-be3f-4fc2-a00d-a6df01fdbd48", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/conference", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "conference" ], "variable": [ { "key": "accountId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"session\": {\n \"id\": \"\",\n \"origin\": {\n \"type\": \"GreetingsRecording\"\n },\n \"voiceCallToken\": \"\",\n \"parties\": [\n {\n \"id\": \"\",\n \"status\": {\n \"code\": \"Tds\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"InternalError\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Host\",\n \"ringOutRole\": \"Initiator\",\n \"ringMeRole\": \"Target\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"status\": {\n \"code\": \"Parked\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"Rejected\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Host\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n }\n ],\n \"creationTime\": \"\"\n }\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-337af24e-be3f-4fc2-a00d-a6df01fdbd48" }, { "id": "4f023679-2399-4100-bd6b-4481ab329225", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/conference", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "conference" ], "variable": [ { "key": "accountId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-4f023679-2399-4100-bd6b-4481ab329225" }, { "id": "1341d968-b528-4358-a681-f7cea0828fa2", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/conference", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "conference" ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-1341d968-b528-4358-a681-f7cea0828fa2" }, { "id": "2cc6f2ab-6336-4d0b-b497-1f8ab2c96345", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/conference", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "conference" ], "variable": [ { "key": "accountId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-2cc6f2ab-6336-4d0b-b497-1f8ab2c96345" }, { "id": "296c6288-0bd6-4e34-a84e-a620b72168db", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/conference", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "conference" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-296c6288-0bd6-4e34-a84e-a620b72168db" }, { "id": "ca39bd5e-29bf-42bf-8cf3-634a65985b63", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/conference", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "conference" ], "variable": [ { "key": "accountId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-ca39bd5e-29bf-42bf-8cf3-634a65985b63" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-9f1f2c33-69ce-4856-845e-7de9b3a38db5" } ], "id": "7b3646d4-7994-4702-9ff2-3869350823e2", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-7b3646d4-7994-4702-9ff2-3869350823e2" }, { "name": "sessions", "item": [ { "name": "{telephonySessionId}", "item": [ { "name": "parties", "item": [ { "name": "bring-in", "item": [ { "name": "Bring-In Call Party", "id": "7f44f725-914b-4323-b3ca-37530e273ff4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"sessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/bring-in", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", "bring-in" ], "variable": [ { "id": "f1f2ae89-f5d4-46b7-b341-fcfc6e05f45e", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "19b05d61-c742-42fd-bd20-9cd73b7cd4e9", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" } ] }, "description": "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" }, "response": [ { "id": "569ced4d-ea42-43b4-9374-14ffdf986f20", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"sessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/bring-in", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", "bring-in" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-569ced4d-ea42-43b4-9374-14ffdf986f20" }, { "id": "1e71f30e-26d5-4b3e-9fdb-4d00eb0872e9", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"sessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/bring-in", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", "bring-in" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-1e71f30e-26d5-4b3e-9fdb-4d00eb0872e9" }, { "id": "fa5f0adc-dffb-4146-9fc8-95de4ef52685", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"sessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/bring-in", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", "bring-in" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-fa5f0adc-dffb-4146-9fc8-95de4ef52685" }, { "id": "e18f41c1-bd73-43be-a413-1c06887eb488", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"sessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/bring-in", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", "bring-in" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-e18f41c1-bd73-43be-a413-1c06887eb488" }, { "id": "cff7311a-b4a2-4d6e-8648-f99c2a1c1f9a", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"sessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/bring-in", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", "bring-in" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-cff7311a-b4a2-4d6e-8648-f99c2a1c1f9a" }, { "id": "40cc6dbc-6896-4a67-8820-b79060f1b642", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"sessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/bring-in", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", "bring-in" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-40cc6dbc-6896-4a67-8820-b79060f1b642" }, { "id": "884132a7-736e-4b58-85d9-96a9bba4297e", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"sessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/bring-in", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", "bring-in" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-884132a7-736e-4b58-85d9-96a9bba4297e" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-7f44f725-914b-4323-b3ca-37530e273ff4" } ], "id": "21a4ae06-0f3d-4d38-915e-905ddea8e086", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-21a4ae06-0f3d-4d38-915e-905ddea8e086" }, { "name": "{partyId}", "item": [ { "name": "unhold", "item": [ { "name": "Un-hold Call Party", "id": "b928dbad-38a9-47ee-b76c-1f943a244145", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/unhold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "unhold" ], "variable": [ { "id": "d4a732d4-e603-4c1b-a537-9086589ffe56", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "e4ffafea-3acc-4e65-93de-89a0c795c06c", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "ff19c6c2-8665-4122-9580-48bc9822e698", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "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." }, "response": [ { "id": "ebabdb8e-85dd-4008-a886-54e84bb1a0b4", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/unhold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "unhold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-ebabdb8e-85dd-4008-a886-54e84bb1a0b4" }, { "id": "69f20474-308b-4bac-b29a-f2eb39811e98", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/unhold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "unhold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-69f20474-308b-4bac-b29a-f2eb39811e98" }, { "id": "3978c34c-7c4f-4c80-a180-5408ceee96ba", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/unhold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "unhold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-3978c34c-7c4f-4c80-a180-5408ceee96ba" }, { "id": "1303fa27-f7f7-40d5-8d8a-5f11598aaca2", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/unhold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "unhold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-1303fa27-f7f7-40d5-8d8a-5f11598aaca2" }, { "id": "1a953405-f51d-4536-8a79-9a9ba120ff56", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/unhold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "unhold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-1a953405-f51d-4536-8a79-9a9ba120ff56" }, { "id": "6694ed99-8c63-4878-8cf2-0d7db65418cf", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/unhold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "unhold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-6694ed99-8c63-4878-8cf2-0d7db65418cf" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-b928dbad-38a9-47ee-b76c-1f943a244145" } ], "id": "79e43159-1f78-40c4-acb5-9b4c07905083", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-79e43159-1f78-40c4-acb5-9b4c07905083" }, { "name": "park", "item": [ { "name": "Call Park", "id": "097bfc8d-74f8-468e-9491-abf48442ecce", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/park", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "park" ], "variable": [ { "id": "674f532e-d64c-47be-ab69-fe6c91f2d8f2", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "915ab6bc-71d3-4f7d-a954-bea0eebcbf7d", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "0038c4bb-e9a2-4f63-9741-c1936ec8e564", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "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." }, "response": [ { "id": "5d75d11b-ab58-4403-a943-d7a3c6aef1fc", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/park", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "park" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-5d75d11b-ab58-4403-a943-d7a3c6aef1fc" }, { "id": "2691d33f-4444-46ae-a66c-03f8088e6dbd", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/park", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "park" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-2691d33f-4444-46ae-a66c-03f8088e6dbd" }, { "id": "47935345-9a9a-44d9-a22c-f4549ad2a62f", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/park", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "park" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-47935345-9a9a-44d9-a22c-f4549ad2a62f" }, { "id": "1b453ba3-ad9a-4193-bf42-87c54b69c078", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/park", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "park" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-1b453ba3-ad9a-4193-bf42-87c54b69c078" }, { "id": "ad0c67da-ca80-4352-952a-3161e15bd8ec", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/park", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "park" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-ad0c67da-ca80-4352-952a-3161e15bd8ec" }, { "id": "62a12fbe-cdd7-45ee-8c01-a65455f01b24", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/park", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "park" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-62a12fbe-cdd7-45ee-8c01-a65455f01b24" }, { "id": "0e4ec525-9604-4c50-98a9-bca7d2fefa2e", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/park", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "park" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-0e4ec525-9604-4c50-98a9-bca7d2fefa2e" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-097bfc8d-74f8-468e-9491-abf48442ecce" } ], "id": "8ffde76c-3db2-42b4-b90d-e78ad8a4be36", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-8ffde76c-3db2-42b4-b90d-e78ad8a4be36" }, { "name": "flip", "item": [ { "name": "Call Flip on Party", "id": "4d76d6ab-7fef-48ba-8095-db100bf4d39d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"callFlipId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/flip", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "flip" ], "variable": [ { "id": "5d79c787-e277-4837-92ac-db57ead5d79f", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "d5ac4aff-1ce2-48f0-842f-cef3e2401c1b", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "9fc02dfd-e6e3-4622-8558-36077fbae30b", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "Performs call flip procedure by holding opposite party and calling to the specified target" }, "response": [ { "id": "0dd6d9c7-7987-4bb5-b957-b42b00d643bd", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"callFlipId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/flip", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "flip" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-0dd6d9c7-7987-4bb5-b957-b42b00d643bd" }, { "id": "f1673bd8-9888-4a89-8ba5-ed38e9a17b02", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"callFlipId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/flip", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "flip" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-f1673bd8-9888-4a89-8ba5-ed38e9a17b02" }, { "id": "07998afa-8168-494c-b54f-ee6703c379f8", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"callFlipId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/flip", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "flip" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-07998afa-8168-494c-b54f-ee6703c379f8" }, { "id": "58aaaf2d-d2bc-48ef-92e5-a56d296470a1", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"callFlipId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/flip", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "flip" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-58aaaf2d-d2bc-48ef-92e5-a56d296470a1" }, { "id": "70120c96-a07b-4710-b4f3-df7232e4d121", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"callFlipId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/flip", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "flip" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-70120c96-a07b-4710-b4f3-df7232e4d121" }, { "id": "22e7b599-5314-4578-a933-3aad3cfcba9b", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"callFlipId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/flip", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "flip" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-22e7b599-5314-4578-a933-3aad3cfcba9b" }, { "id": "61708557-89fc-4cb4-aa6b-da9fa2c98a69", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"callFlipId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/flip", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "flip" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-61708557-89fc-4cb4-aa6b-da9fa2c98a69" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-4d76d6ab-7fef-48ba-8095-db100bf4d39d" } ], "id": "ee722e9a-de2b-4e06-a48e-683890dc89a0", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-ee722e9a-de2b-4e06-a48e-683890dc89a0" }, { "name": "reply", "item": [ { "name": "Reply with Text", "id": "501cb617-b9f2-4098-abae-e4d701809802", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"replyWithText\": \"\",\n \"replyWithPattern\": {\n \"pattern\": \"CallMeBackLater\",\n \"time\": \"\",\n \"timeUnit\": \"Minute\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reply", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reply" ], "variable": [ { "id": "28e3ef72-5536-4fc3-be60-f948d1ea7035", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "3e4bcc3e-24bb-4cbc-b7d7-f0c8dae0c6b1", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "da34e5ea-3478-448f-a6d6-e18d8f7005db", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "Replies with text/pattern without picking up a call." }, "response": [ { "id": "02aa242f-9199-40ab-ba51-7837add0b9a0", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyWithText\": \"\",\n \"replyWithPattern\": {\n \"pattern\": \"CallMeBackLater\",\n \"time\": \"\",\n \"timeUnit\": \"Minute\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reply", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reply" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"Supervising\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\"\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-02aa242f-9199-40ab-ba51-7837add0b9a0" }, { "id": "602fcd70-c9a2-4bdb-94f3-d6388d35142f", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyWithText\": \"\",\n \"replyWithPattern\": {\n \"pattern\": \"CallMeBackLater\",\n \"time\": \"\",\n \"timeUnit\": \"Minute\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reply", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reply" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-602fcd70-c9a2-4bdb-94f3-d6388d35142f" }, { "id": "4c66042b-dc35-4aff-b9bc-647e74694944", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyWithText\": \"\",\n \"replyWithPattern\": {\n \"pattern\": \"CallMeBackLater\",\n \"time\": \"\",\n \"timeUnit\": \"Minute\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reply", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reply" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-4c66042b-dc35-4aff-b9bc-647e74694944" }, { "id": "d07f5e18-6c8e-4a9c-b6d2-e70a50528fe9", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyWithText\": \"\",\n \"replyWithPattern\": {\n \"pattern\": \"CallMeBackLater\",\n \"time\": \"\",\n \"timeUnit\": \"Minute\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reply", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reply" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-d07f5e18-6c8e-4a9c-b6d2-e70a50528fe9" }, { "id": "ce6b3dcd-ae78-40a5-bd8d-5baf8fd8f252", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyWithText\": \"\",\n \"replyWithPattern\": {\n \"pattern\": \"CallMeBackLater\",\n \"time\": \"\",\n \"timeUnit\": \"Minute\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reply", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reply" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-ce6b3dcd-ae78-40a5-bd8d-5baf8fd8f252" }, { "id": "4ebf6fa2-c6c7-494b-bed6-adc6e81dd04b", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyWithText\": \"\",\n \"replyWithPattern\": {\n \"pattern\": \"CallMeBackLater\",\n \"time\": \"\",\n \"timeUnit\": \"Minute\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reply", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reply" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-4ebf6fa2-c6c7-494b-bed6-adc6e81dd04b" }, { "id": "632d3fc3-9035-44e1-8edb-8335deb541aa", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"replyWithText\": \"\",\n \"replyWithPattern\": {\n \"pattern\": \"CallMeBackLater\",\n \"time\": \"\",\n \"timeUnit\": \"Minute\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reply", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reply" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-632d3fc3-9035-44e1-8edb-8335deb541aa" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-501cb617-b9f2-4098-abae-e4d701809802" } ], "id": "3105f895-1b4d-4fc4-87b3-86fbd575aaf7", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-3105f895-1b4d-4fc4-87b3-86fbd575aaf7" }, { "name": "bridge", "item": [ { "name": "Bridge Call Party", "id": "864a9c8b-c66d-45fd-b79e-96619ecd719a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"telephonySessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/bridge", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "bridge" ], "variable": [ { "id": "785395f7-912a-4190-9da3-8cdcbba6bf44", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "73f2a59e-f53a-4968-8992-0ec5b80ed78b", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "3425350b-f802-4735-b7f2-fc9338d1e44d", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "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" }, "response": [ { "id": "f74c4fc3-de78-494d-b278-30036597902d", "name": "Bridged Call Info", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"telephonySessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/bridge", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "bridge" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-f74c4fc3-de78-494d-b278-30036597902d" }, { "id": "e43e7708-7c53-461e-a56b-aaf572994e53", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"telephonySessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/bridge", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "bridge" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-e43e7708-7c53-461e-a56b-aaf572994e53" }, { "id": "51303168-4558-444a-bd16-eec11e61ef09", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"telephonySessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/bridge", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "bridge" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-51303168-4558-444a-bd16-eec11e61ef09" }, { "id": "55555ada-62af-433b-8e54-bb79aea5f51d", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"telephonySessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/bridge", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "bridge" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-55555ada-62af-433b-8e54-bb79aea5f51d" }, { "id": "c85e29f7-3bc9-4629-82ab-a8419dc5b883", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"telephonySessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/bridge", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "bridge" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-c85e29f7-3bc9-4629-82ab-a8419dc5b883" }, { "id": "241864e3-5f61-492b-bb88-8f2b58bc93d0", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"telephonySessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/bridge", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "bridge" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-241864e3-5f61-492b-bb88-8f2b58bc93d0" }, { "id": "07ed35b5-616d-4292-bbaa-29f702d5fa2e", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"partyId\": \"\",\n \"telephonySessionId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/bridge", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "bridge" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-07ed35b5-616d-4292-bbaa-29f702d5fa2e" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-864a9c8b-c66d-45fd-b79e-96619ecd719a" } ], "id": "60c7b6b2-184f-4e2a-b44b-38f22ee9ad11", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-60c7b6b2-184f-4e2a-b44b-38f22ee9ad11" }, { "name": "ignore", "item": [ { "name": "Ignore Call in Queue", "id": "47d007d0-f439-4522-8209-77f0ccb903f7", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/ignore", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "ignore" ], "variable": [ { "id": "109e122f-f027-4b52-ab8c-f9daae5f007f", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "edefe170-eb54-49d1-9bc0-ce18eee4f598", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "677c3cf0-62e2-45a1-a1d8-54ef2d8409e0", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "Ignores a call to a call queue agent in `Setup` or `Proceeding` state." }, "response": [ { "id": "c26fa4d0-dabe-440a-b51b-f057e51a06ac", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/ignore", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "ignore" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-c26fa4d0-dabe-440a-b51b-f057e51a06ac" }, { "id": "00095fb0-b832-4be2-9417-3d9189dd9ebf", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/ignore", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "ignore" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-00095fb0-b832-4be2-9417-3d9189dd9ebf" }, { "id": "1ca093b8-88d7-4712-8e41-94b30f928dbb", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/ignore", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "ignore" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-1ca093b8-88d7-4712-8e41-94b30f928dbb" }, { "id": "2603c533-dc04-481f-99e0-1bb863fbc1c3", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/ignore", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "ignore" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-2603c533-dc04-481f-99e0-1bb863fbc1c3" }, { "id": "b4a3f978-1ef3-44c0-ad83-47510dd00667", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/ignore", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "ignore" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-b4a3f978-1ef3-44c0-ad83-47510dd00667" }, { "id": "33a6f815-7e96-4121-ac76-f6f73c3291fa", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/ignore", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "ignore" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-33a6f815-7e96-4121-ac76-f6f73c3291fa" }, { "id": "34ec9cf4-4742-40f8-968e-8533155e3fd1", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/ignore", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "ignore" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-34ec9cf4-4742-40f8-968e-8533155e3fd1" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-47d007d0-f439-4522-8209-77f0ccb903f7" } ], "id": "c0d0f194-cc15-4025-bc03-36a9b23005b4", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-c0d0f194-cc15-4025-bc03-36a9b23005b4" }, { "name": "supervise", "item": [ { "name": "Supervise Call Party", "id": "90a3affa-7e4d-4729-aa79-6d35986cc688", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"agentExtensionId\": \"\",\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendRecv\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "supervise" ], "variable": [ { "id": "9ae89db8-0394-4ce6-8708-99727ba21fa0", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "7f077db2-b56e-4cf3-8213-d258ecb2a898", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "539e3ce6-b852-45a0-b2f4-08e6fc4ceeaf", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "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-api-monitoring-ids` containing\nIDs of the monitored party and session. The flow is supported for calls with\nno more than 2 participants. Currently, this method is supported for Softphone/Hardphone devices\nonly, since device IDs for WebRTC/Mobile apps cannot be obtained.\n" }, "response": [ { "id": "071f168f-6943-4226-9599-9052554998f2", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"agentExtensionId\": \"\",\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendRecv\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"id\": \"\",\n \"accountId\": \"\",\n \"extensionId\": \"\",\n \"muted\": \"\",\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"standAlone\": \"\",\n \"status\": {\n \"code\": \"Setup\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"Pickup\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-071f168f-6943-4226-9599-9052554998f2" }, { "id": "dce050f9-f6ec-4459-89b8-72a94803bac5", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"agentExtensionId\": \"\",\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendRecv\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-dce050f9-f6ec-4459-89b8-72a94803bac5" }, { "id": "177840ec-0b65-4d6b-8d70-52a94d238adf", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"agentExtensionId\": \"\",\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendRecv\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-177840ec-0b65-4d6b-8d70-52a94d238adf" }, { "id": "a01d7587-77ce-4934-b4b7-8a6500ca6849", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"agentExtensionId\": \"\",\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendRecv\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-a01d7587-77ce-4934-b4b7-8a6500ca6849" }, { "id": "a88228f7-c566-4d97-b66b-e8a4d6818f8f", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"agentExtensionId\": \"\",\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendRecv\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-a88228f7-c566-4d97-b66b-e8a4d6818f8f" }, { "id": "c92a9e65-e997-40ca-8551-ae79be86f997", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"agentExtensionId\": \"\",\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendRecv\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-c92a9e65-e997-40ca-8551-ae79be86f997" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-90a3affa-7e4d-4729-aa79-6d35986cc688" } ], "id": "bf74db69-b781-4d8b-92f6-84e1bb3bc2c9", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-bf74db69-b781-4d8b-92f6-84e1bb3bc2c9" }, { "name": "reject", "item": [ { "name": "Reject Call Party", "id": "304582a9-b69d-4900-8129-f4b7e0d8975a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reject", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reject" ], "variable": [ { "id": "321b4293-e9c4-47b5-8702-b7d09515f34c", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "6a73c117-51c4-41b4-bab9-06f37e203799", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "196fd8db-7cb2-428e-806e-6d27a33b00a6", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "Rejects an inbound call in a \"Setup\" or \"Proceeding\" state" }, "response": [ { "id": "67b19f22-56c8-41e4-afc0-96b0cbc4d6df", "name": "No Content", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reject", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reject" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-67b19f22-56c8-41e4-afc0-96b0cbc4d6df" }, { "id": "1acdfc72-a70d-480f-9e82-f70d111a1983", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reject", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reject" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-1acdfc72-a70d-480f-9e82-f70d111a1983" }, { "id": "241d5ff2-47e6-4ff0-ba76-d9dcd58171cf", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reject", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reject" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-241d5ff2-47e6-4ff0-ba76-d9dcd58171cf" }, { "id": "2151d3cb-0510-412d-b25e-86764b01786f", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reject", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reject" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-2151d3cb-0510-412d-b25e-86764b01786f" }, { "id": "36064e38-8b60-4ec6-8b49-e9c7533e50e6", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reject", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reject" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-36064e38-8b60-4ec6-8b49-e9c7533e50e6" }, { "id": "9bc8b245-d7c4-4d99-907b-73b363c1d7ff", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reject", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reject" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-9bc8b245-d7c4-4d99-907b-73b363c1d7ff" }, { "id": "462f43a7-f4e2-43bf-bb01-deb1483120e7", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/reject", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "reject" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-462f43a7-f4e2-43bf-bb01-deb1483120e7" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-304582a9-b69d-4900-8129-f4b7e0d8975a" } ], "id": "79209128-1ac7-4304-8b60-e80b9f9da11f", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-79209128-1ac7-4304-8b60-e80b9f9da11f" }, { "name": "recordings", "item": [ { "name": "{recordingId}", "item": [ { "name": "Pause/Resume Recording", "id": "e76ecb2e-5165-4059-87aa-5e9fcbb80c99", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings/:recordingId?brandId=~", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings", ":recordingId" ], "query": [ { "description": "(Required) Identifies a brand of a logged-in user or a brand of a sign-up session", "key": "brandId", "value": "~" } ], "variable": [ { "id": "5910cc59-b7a3-455c-a02a-2eada9475d6f", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "6fde92f3-51b7-46c8-9ef7-317b62abbf99", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "92584fd7-b191-4acf-8d88-982d07d86a29", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" }, { "id": "c803fc27-7ccf-494b-ae39-0067d5b7ac79", "key": "recordingId", "value": "", "description": "(Required) Internal identifier of a recording" } ] }, "description": "Pause/resume recording" }, "response": [ { "id": "65fb828f-7cd6-41f6-a448-ab97a8cee3f9", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings/:recordingId?brandId=~", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings", ":recordingId" ], "query": [ { "description": "(Required) Identifies a brand of a logged-in user or a brand of a sign-up session", "key": "brandId", "value": "~" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" }, { "key": "recordingId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"active\": \"\"\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-65fb828f-7cd6-41f6-a448-ab97a8cee3f9" }, { "id": "e19c90ba-065e-4cd3-92e6-1ec126024f4f", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings/:recordingId?brandId=~", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings", ":recordingId" ], "query": [ { "description": "(Required) Identifies a brand of a logged-in user or a brand of a sign-up session", "key": "brandId", "value": "~" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" }, { "key": "recordingId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-e19c90ba-065e-4cd3-92e6-1ec126024f4f" }, { "id": "6ff6aede-32ee-468d-937a-22aeb2e3b3dc", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings/:recordingId?brandId=~", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings", ":recordingId" ], "query": [ { "description": "(Required) Identifies a brand of a logged-in user or a brand of a sign-up session", "key": "brandId", "value": "~" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" }, { "key": "recordingId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-6ff6aede-32ee-468d-937a-22aeb2e3b3dc" }, { "id": "a1f2eaab-3430-40b1-b8cb-6ddeaba10211", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings/:recordingId?brandId=~", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings", ":recordingId" ], "query": [ { "description": "(Required) Identifies a brand of a logged-in user or a brand of a sign-up session", "key": "brandId", "value": "~" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" }, { "key": "recordingId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-a1f2eaab-3430-40b1-b8cb-6ddeaba10211" }, { "id": "4ecce208-e1f2-4f8b-b72d-7312a9cde811", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings/:recordingId?brandId=~", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings", ":recordingId" ], "query": [ { "description": "(Required) Identifies a brand of a logged-in user or a brand of a sign-up session", "key": "brandId", "value": "~" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" }, { "key": "recordingId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-4ecce208-e1f2-4f8b-b72d-7312a9cde811" }, { "id": "792b81ec-0b15-4f8f-aa6c-156eec61d610", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings/:recordingId?brandId=~", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings", ":recordingId" ], "query": [ { "description": "(Required) Identifies a brand of a logged-in user or a brand of a sign-up session", "key": "brandId", "value": "~" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" }, { "key": "recordingId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-792b81ec-0b15-4f8f-aa6c-156eec61d610" }, { "id": "acfdbd0f-eb71-4065-84e0-c71c94e6387b", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"active\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings/:recordingId?brandId=~", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings", ":recordingId" ], "query": [ { "description": "(Required) Identifies a brand of a logged-in user or a brand of a sign-up session", "key": "brandId", "value": "~" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" }, { "key": "recordingId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-acfdbd0f-eb71-4065-84e0-c71c94e6387b" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-e76ecb2e-5165-4059-87aa-5e9fcbb80c99" } ], "id": "ffd5b771-5301-4d1b-96d5-54124a101900", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-ffd5b771-5301-4d1b-96d5-54124a101900" }, { "name": "Create Recording", "id": "bad44148-33e6-40f0-a2cb-649c9195212e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings" ], "variable": [ { "id": "ce29f923-cda4-4f3a-84bb-4865990b3399", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "51f7c98a-af7f-462a-900f-27a0a103bb6a", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "de16338a-440b-41c0-97d1-040f595f5214", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "Starts a new call recording for the party" }, "response": [ { "id": "06936504-2026-4510-b5c3-61d052398ba3", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-06936504-2026-4510-b5c3-61d052398ba3" }, { "id": "44723687-9a83-49fe-bb74-ef681904eed2", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-44723687-9a83-49fe-bb74-ef681904eed2" }, { "id": "30e1ba89-d8d8-4550-8ea0-dccbade0a59f", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-30e1ba89-d8d8-4550-8ea0-dccbade0a59f" }, { "id": "79620286-ae5a-43bd-9bc0-b34a2ac8c818", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-79620286-ae5a-43bd-9bc0-b34a2ac8c818" }, { "id": "7e7523ef-360b-415e-931d-0ba4960d89cd", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-7e7523ef-360b-415e-931d-0ba4960d89cd" }, { "id": "78e01d99-f07c-4d8c-ab56-8dad384b8861", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-78e01d99-f07c-4d8c-ab56-8dad384b8861" }, { "id": "eef8e854-5ee1-4faa-acf6-fa5a5dcb7fdd", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/recordings", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "recordings" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-eef8e854-5ee1-4faa-acf6-fa5a5dcb7fdd" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-bad44148-33e6-40f0-a2cb-649c9195212e" } ], "id": "16c34ab8-2830-42ef-a11f-bf674158080d", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-16c34ab8-2830-42ef-a11f-bf674158080d" }, { "name": "answer", "item": [ { "name": "Answer Call Party", "id": "914c7824-fe0a-4f87-ac72-5ccf520ba5d5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/answer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "answer" ], "variable": [ { "id": "b7346ce0-a077-469e-b809-17b53c6528b1", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "ba03685f-4b6a-4d3a-95c1-bd576f20656f", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "a09459f8-b569-4e74-894d-146a8ebbb44d", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "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." }, "response": [ { "id": "dc40ffa9-993e-44a9-911d-10f2d25702d9", "name": "Call Session Information", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/answer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "answer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-dc40ffa9-993e-44a9-911d-10f2d25702d9" }, { "id": "2bfe7acc-737c-4569-a6be-879d74830f37", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/answer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "answer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-2bfe7acc-737c-4569-a6be-879d74830f37" }, { "id": "b4d053b9-7825-4cb1-b781-c5d1ce5ea52d", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/answer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "answer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-b4d053b9-7825-4cb1-b781-c5d1ce5ea52d" }, { "id": "c0819ef1-dd82-4aef-b6e3-8fafb8b7ddd7", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/answer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "answer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-c0819ef1-dd82-4aef-b6e3-8fafb8b7ddd7" }, { "id": "6433c7b7-d744-4fa5-aac1-e59a730e0f6d", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/answer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "answer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-6433c7b7-d744-4fa5-aac1-e59a730e0f6d" }, { "id": "cccbbdbd-73de-4e97-acfe-4c7deab4b924", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/answer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "answer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-cccbbdbd-73de-4e97-acfe-4c7deab4b924" }, { "id": "77d90da4-2a94-464a-81c5-eaaf4d3f98c8", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/answer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "answer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-77d90da4-2a94-464a-81c5-eaaf4d3f98c8" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-914c7824-fe0a-4f87-ac72-5ccf520ba5d5" } ], "id": "88e939af-c1c5-476e-b361-8c1102f3aaad", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-88e939af-c1c5-476e-b361-8c1102f3aaad" }, { "name": "transfer", "item": [ { "name": "Transfer Call Party", "id": "aa4ada87-892e-4385-8fdb-81844a087755", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"parkOrbit\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/transfer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "transfer" ], "variable": [ { "id": "f31f1600-b75f-40dc-bd4e-86dab5a12d02", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "465c7e8d-382b-4b45-9282-a0b1017f2d5d", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "f55828bf-67c4-4dcc-8342-d02e573c8dce", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "Transfers an answered call to the specified call party. Applicable for a call session in \"Answered\" or \"Hold\" state." }, "response": [ { "id": "8426bb86-59d1-4c4a-8a64-276efd97ec93", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"parkOrbit\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/transfer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "transfer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-8426bb86-59d1-4c4a-8a64-276efd97ec93" }, { "id": "b1063ecd-f848-4016-aef4-ffd9af605b51", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"parkOrbit\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/transfer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "transfer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-b1063ecd-f848-4016-aef4-ffd9af605b51" }, { "id": "0b9c475e-fd5c-4ec6-ab5f-b72faddf07b8", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"parkOrbit\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/transfer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "transfer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-0b9c475e-fd5c-4ec6-ab5f-b72faddf07b8" }, { "id": "0b51b499-a6fc-4c69-9b5f-098a85667147", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"parkOrbit\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/transfer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "transfer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-0b51b499-a6fc-4c69-9b5f-098a85667147" }, { "id": "3472eaed-b4ba-4e2c-b516-0da1c217a0ca", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"parkOrbit\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/transfer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "transfer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-3472eaed-b4ba-4e2c-b516-0da1c217a0ca" }, { "id": "b76a406e-8cea-4843-b8fa-a1339af52519", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"parkOrbit\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/transfer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "transfer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-b76a406e-8cea-4843-b8fa-a1339af52519" }, { "id": "7336f3ca-9f7c-441e-adfa-186ab87e3c95", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"parkOrbit\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/transfer", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "transfer" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-7336f3ca-9f7c-441e-adfa-186ab87e3c95" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-aa4ada87-892e-4385-8fdb-81844a087755" } ], "id": "0229819d-8d40-42c4-bb6e-734d29ac057b", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-0229819d-8d40-42c4-bb6e-734d29ac057b" }, { "name": "hold", "item": [ { "name": "Hold Call Party", "id": "38da0a6c-2c3c-4112-80c8-1a9e9b59e99a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"proto\": \"Auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/hold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "hold" ], "variable": [ { "id": "8d734c46-3232-4a6d-b642-b3dc26692b36", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "a0f0a120-6a6a-4cbc-bfd9-c7507d0f1cf2", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "c404cbd8-8aae-4b7b-8cda-7bfeab53da09", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "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." }, "response": [ { "id": "bd25f703-8f3d-4b9b-b434-a089ec8680a9", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"proto\": \"Auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/hold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "hold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-bd25f703-8f3d-4b9b-b434-a089ec8680a9" }, { "id": "62244cc5-7092-4df8-a178-223a4a536a9f", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"proto\": \"Auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/hold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "hold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-62244cc5-7092-4df8-a178-223a4a536a9f" }, { "id": "802fdbef-8da6-4560-b5e7-9f95135aa9a0", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"proto\": \"Auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/hold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "hold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-802fdbef-8da6-4560-b5e7-9f95135aa9a0" }, { "id": "2a7146ee-927c-4c89-abc3-9c924edafeb4", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"proto\": \"Auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/hold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "hold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-2a7146ee-927c-4c89-abc3-9c924edafeb4" }, { "id": "3a16c7d7-24c1-4021-a24c-4a86498db9d4", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"proto\": \"Auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/hold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "hold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-3a16c7d7-24c1-4021-a24c-4a86498db9d4" }, { "id": "6c64968b-8ce4-4e5b-b7e3-e0dffacf9548", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"proto\": \"Auto\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/hold", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "hold" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-6c64968b-8ce4-4e5b-b7e3-e0dffacf9548" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-38da0a6c-2c3c-4112-80c8-1a9e9b59e99a" } ], "id": "38ee3e19-073e-402e-a0fc-0b071272e9fb", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-38ee3e19-073e-402e-a0fc-0b071272e9fb" }, { "name": "pickup", "item": [ { "name": "Pickup Call", "id": "80fcd645-76c3-4f34-8dfd-4e6cccff2599", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/pickup", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "pickup" ], "variable": [ { "id": "e199c67c-edbc-4cfb-9502-dd92644ee550", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "4e0ce23b-3a20-4ef8-b10a-53c62371fdba", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "ed1d5003-669a-43b5-9d52-0f440da86641", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "Picks up a call parked to the specified park location." }, "response": [ { "id": "06059bd4-cc6f-48bf-9a40-7ff7e4bf30cd", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/pickup", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "pickup" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-06059bd4-cc6f-48bf-9a40-7ff7e4bf30cd" }, { "id": "562f5ee3-1c06-43d7-b35f-7e4dfe1ea1ea", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/pickup", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "pickup" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-562f5ee3-1c06-43d7-b35f-7e4dfe1ea1ea" }, { "id": "53a044d4-4197-4d0a-8540-e24f1102254e", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/pickup", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "pickup" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-53a044d4-4197-4d0a-8540-e24f1102254e" }, { "id": "0c6a5477-3ee4-42aa-ac15-7590e583d43e", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/pickup", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "pickup" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-0c6a5477-3ee4-42aa-ac15-7590e583d43e" }, { "id": "e668afc9-ba1a-475c-84a5-ae1bdb97766e", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/pickup", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "pickup" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-e668afc9-ba1a-475c-84a5-ae1bdb97766e" }, { "id": "208a4c99-2f28-4379-8b1b-61657bf56255", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/pickup", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "pickup" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-208a4c99-2f28-4379-8b1b-61657bf56255" }, { "id": "5c7d8a71-0ef5-4b63-bc7f-d4d265960608", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"deviceId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/pickup", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "pickup" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-5c7d8a71-0ef5-4b63-bc7f-d4d265960608" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-80fcd645-76c3-4f34-8dfd-4e6cccff2599" } ], "id": "618dcce7-ab45-4f9c-a4aa-eb9b071938a3", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-618dcce7-ab45-4f9c-a4aa-eb9b071938a3" }, { "name": "forward", "item": [ { "name": "Forward Call Party", "id": "ffc8c76e-1a40-4f1d-856f-65d3f4d14f6e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/forward", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "forward" ], "variable": [ { "id": "6bb279b5-d875-4b00-8cdd-d4896b42c173", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "e66d51de-f201-4952-b463-28b7894cff21", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "648a8a8e-36e1-401d-832c-88003827cf77", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "Forwards a non-answered incoming call to the specified call party. Applicable for a call session in \"Setup\" or \"Proceeding\" state." }, "response": [ { "id": "c2eb4558-cfe7-415d-a38c-be024fe14816", "name": "Success", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/forward", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "forward" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-c2eb4558-cfe7-415d-a38c-be024fe14816" }, { "id": "e995517b-e4d1-4d79-94de-9d87023aa978", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/forward", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "forward" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-e995517b-e4d1-4d79-94de-9d87023aa978" }, { "id": "45a3f7f2-9cd4-4bf7-9acc-2c7be23c9600", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/forward", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "forward" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-45a3f7f2-9cd4-4bf7-9acc-2c7be23c9600" }, { "id": "01cb6811-1d3c-45e2-a5de-5a19b2566497", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/forward", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "forward" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-01cb6811-1d3c-45e2-a5de-5a19b2566497" }, { "id": "e4c331c6-8a1d-4e41-be36-60e45c5603d7", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/forward", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "forward" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-e4c331c6-8a1d-4e41-be36-60e45c5603d7" }, { "id": "20545cd5-6043-4189-ad4c-f2086a677756", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/forward", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "forward" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-20545cd5-6043-4189-ad4c-f2086a677756" }, { "id": "45f2cfb2-b978-4266-b57b-a2027edbe6ca", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"phoneNumber\": \"\",\n \"voicemail\": \"\",\n \"extensionNumber\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId/forward", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId", "forward" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-45f2cfb2-b978-4266-b57b-a2027edbe6ca" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-ffc8c76e-1a40-4f1d-856f-65d3f4d14f6e" } ], "id": "ec8335b6-3888-45cb-98e2-28a41079650a", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-ec8335b6-3888-45cb-98e2-28a41079650a" }, { "name": "Get Call Party Status", "id": "e2f8f71f-558a-4578-9e9e-325ab4380bc1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "id": "093980fe-542b-47f7-acdb-dba50a7c8f9e", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "7aefba77-39ef-45b2-a01b-2e9adc047940", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "fa708807-e7b1-498f-8475-0dfc90f25f5f", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "Returns a call party status by ID." }, "response": [ { "id": "9560ec0b-b924-4a42-9fc4-e18e64f0d55c", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-9560ec0b-b924-4a42-9fc4-e18e64f0d55c" }, { "id": "a03336f3-1544-4b0c-be60-fded68468e8c", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-a03336f3-1544-4b0c-be60-fded68468e8c" }, { "id": "5ef6d790-be11-4018-9ca4-b2c7357fed52", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-5ef6d790-be11-4018-9ca4-b2c7357fed52" }, { "id": "184ca166-b95d-4465-98fb-1c09c5e2d405", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-184ca166-b95d-4465-98fb-1c09c5e2d405" }, { "id": "f935810e-7a0e-43bc-87d5-b2ccdcbd3bf9", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-f935810e-7a0e-43bc-87d5-b2ccdcbd3bf9" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-e2f8f71f-558a-4578-9e9e-325ab4380bc1" }, { "name": "Delete Call Party", "id": "2c3c28cb-c763-46dc-b54e-551970d5e689", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "id": "8c90d1fb-6037-4061-8efb-72c4edafe495", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "40364c7c-ec58-447d-9709-f9a4e5ed9cbe", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "af758ecc-fe4a-4837-b87b-0de2f996745e", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "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." }, "response": [ { "id": "ea5b4041-a736-419a-9881-8d6835ba8852", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-ea5b4041-a736-419a-9881-8d6835ba8852" }, { "id": "ace6eb8c-dbe3-4f07-b514-9b5b4be27524", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-ace6eb8c-dbe3-4f07-b514-9b5b4be27524" }, { "id": "b55308bf-2190-4b45-88fe-ca591400c5ef", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-b55308bf-2190-4b45-88fe-ca591400c5ef" }, { "id": "f457451a-add7-4072-8e9f-1782e366cbff", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-f457451a-add7-4072-8e9f-1782e366cbff" }, { "id": "1f6cafcb-3581-4755-9083-299534eee12e", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-1f6cafcb-3581-4755-9083-299534eee12e" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-2c3c28cb-c763-46dc-b54e-551970d5e689" }, { "name": "Update Call Party", "id": "b5a4b8c8-8d19-4efe-a451-63def8e2d131", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"party\": {\n \"muted\": \"\",\n \"standAlone\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "id": "2873e0de-43c1-4cc6-9bb5-322164cdc050", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "2859f4a6-b7f2-45ff-8f84-f6bdeac3fd67", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" }, { "id": "ce74160f-27dc-4861-9308-b5149e8f097a", "key": "partyId", "value": "", "description": "(Required) Internal identifier of a call party" } ] }, "description": "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." }, "response": [ { "id": "bf29612b-16d5-46bf-a70f-3da3620128d8", "name": "Success", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"party\": {\n \"muted\": \"\",\n \"standAlone\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"status\": {\n \"code\": \"FaxReceive\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"TargetBusy\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Participant\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-bf29612b-16d5-46bf-a70f-3da3620128d8" }, { "id": "3559c430-0ee2-4eb7-8466-569bbd4d1b4c", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"party\": {\n \"muted\": \"\",\n \"standAlone\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-3559c430-0ee2-4eb7-8466-569bbd4d1b4c" }, { "id": "5ffcb0e2-8145-4d77-af84-8436974566cb", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"party\": {\n \"muted\": \"\",\n \"standAlone\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-5ffcb0e2-8145-4d77-af84-8436974566cb" }, { "id": "dc5918e9-2a25-44f5-afaf-a4028d0e248f", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"party\": {\n \"muted\": \"\",\n \"standAlone\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-dc5918e9-2a25-44f5-afaf-a4028d0e248f" }, { "id": "05afdbdd-8b30-48bf-8b31-57e4ed3b3cae", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"party\": {\n \"muted\": \"\",\n \"standAlone\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-05afdbdd-8b30-48bf-8b31-57e4ed3b3cae" }, { "id": "bc988c80-9c64-4318-afff-fdc0a5dc103c", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"party\": {\n \"muted\": \"\",\n \"standAlone\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-bc988c80-9c64-4318-afff-fdc0a5dc103c" }, { "id": "f037b0bc-8bf5-4a44-a3cb-da6c7e7fcf76", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"party\": {\n \"muted\": \"\",\n \"standAlone\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/parties/:partyId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "parties", ":partyId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" }, { "key": "partyId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-f037b0bc-8bf5-4a44-a3cb-da6c7e7fcf76" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-b5a4b8c8-8d19-4efe-a451-63def8e2d131" } ], "id": "e16abc63-69aa-4688-8483-fe28ad8e21c0", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-e16abc63-69aa-4688-8483-fe28ad8e21c0" } ], "id": "a234ebb9-e16d-4d80-a9ed-ae8af51c88cb", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-a234ebb9-e16d-4d80-a9ed-ae8af51c88cb" }, { "name": "supervise", "item": [ { "name": "Supervise Call Session", "id": "3aa54513-795b-4b66-9cee-d50f786a38da", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"agentExtensionId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendOnly\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "supervise" ], "variable": [ { "id": "b2386faa-6628-4bd3-ad97-a1162e3a4890", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "563004d7-a4a6-4839-beee-f219a88e6211", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" } ] }, "description": "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." }, "response": [ { "id": "212eb798-af66-40ff-86a0-598da4a3373c", "name": "Created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"agentExtensionId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendOnly\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Inbound\",\n \"id\": \"\",\n \"accountId\": \"\",\n \"extensionId\": \"\",\n \"muted\": \"\",\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"standAlone\": \"\",\n \"status\": {\n \"code\": \"Gone\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"CallDropped\",\n \"description\": \"\"\n }\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-212eb798-af66-40ff-86a0-598da4a3373c" }, { "id": "4d9fceae-6f02-4d35-9c93-9bce0284451a", "name": "General response with **HTTP 400 \"Bad request\"** status.
\nReasons: unparsable request, path, query or body parameters are invalid.\nThe error description may contain reference to particular parameter(s) which haven't passed the validation.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"agentExtensionId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendOnly\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-4d9fceae-6f02-4d35-9c93-9bce0284451a" }, { "id": "990afcba-6e82-420a-9657-c667fe14d97d", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"agentExtensionId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendOnly\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-990afcba-6e82-420a-9657-c667fe14d97d" }, { "id": "4a998661-5475-4d2f-8269-7c460adbc27e", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"agentExtensionId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendOnly\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-4a998661-5475-4d2f-8269-7c460adbc27e" }, { "id": "571da16f-f7f1-4410-a8a2-e21137ac80ec", "name": "General response with **HTTP 409 \"Conflict\"** status.
\nReasons: the requested modification operation causes a conflict (for example, unique constraint violation).\nThe error definition may contain reference to particular parameter(s) which caused the co", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"agentExtensionId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendOnly\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\",\n \"parameterName\": \"\",\n \"parameterValue\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-571da16f-f7f1-4410-a8a2-e21137ac80ec" }, { "id": "25751a93-2e2d-4366-a724-21518f221492", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"agentExtensionId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendOnly\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-25751a93-2e2d-4366-a724-21518f221492" }, { "id": "9b616c8b-e9b0-4395-a178-dc63c1231ff1", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"mode\": \"Listen\",\n \"supervisorDeviceId\": \"\",\n \"agentExtensionId\": \"\",\n \"autoAnswer\": true,\n \"mediaSDP\": \"sendOnly\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId/supervise", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId", "supervise" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-9b616c8b-e9b0-4395-a178-dc63c1231ff1" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-3aa54513-795b-4b66-9cee-d50f786a38da" } ], "id": "50e7b8bb-203f-4fb8-ab10-16cb3831a241", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-50e7b8bb-203f-4fb8-ab10-16cb3831a241" }, { "name": "Get Call Session Status", "id": "4419dea8-9f97-4bf2-809f-838cc5ab8a2e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId?timestamp=&timeout=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "query": [ { "description": "The date and time of a call session latest change", "key": "timestamp", "value": "" }, { "description": "The time frame of awaiting for a status change before sending\nthe resulting one in response\n", "key": "timeout", "value": "" } ], "variable": [ { "id": "affff310-b874-465f-b9d3-eec2dd5267ec", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "3bcd909c-fa39-4fe7-b047-02a7a0cc6eee", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" } ] }, "description": "Returns the status of a call session by ID." }, "response": [ { "id": "9b51385e-7314-4b52-a6b1-1d72e816840b", "name": "Success", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId?timestamp=&timeout=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "query": [ { "description": "The date and time of a call session latest change", "key": "timestamp", "value": "" }, { "description": "The time frame of awaiting for a status change before sending\nthe resulting one in response\n", "key": "timeout", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"origin\": {\n \"type\": \"CallOut\"\n },\n \"voiceCallToken\": \"\",\n \"parties\": [\n {\n \"id\": \"\",\n \"status\": {\n \"code\": \"Setup\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"AgentDropped\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Outbound\",\n \"conferenceRole\": \"Host\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Initiator\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n },\n {\n \"id\": \"\",\n \"status\": {\n \"code\": \"Setup\",\n \"peerId\": {\n \"sessionId\": \"\",\n \"telephonySessionId\": \"\",\n \"partyId\": \"\"\n },\n \"reason\": \"CallPark\",\n \"description\": \"\"\n },\n \"muted\": \"\",\n \"standAlone\": \"\",\n \"park\": {\n \"id\": \"\"\n },\n \"from\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"to\": {\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"deviceId\": \"\",\n \"extensionId\": \"\"\n },\n \"owner\": {\n \"accountId\": \"\",\n \"extensionId\": \"\"\n },\n \"direction\": \"Inbound\",\n \"conferenceRole\": \"Host\",\n \"ringOutRole\": \"Target\",\n \"ringMeRole\": \"Target\",\n \"recordings\": [\n {\n \"id\": \"\",\n \"active\": \"\"\n },\n {\n \"id\": \"\",\n \"active\": \"\"\n }\n ]\n }\n ],\n \"creationTime\": \"\"\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-9b51385e-7314-4b52-a6b1-1d72e816840b" }, { "id": "f863b02b-b47f-4837-832c-d11c3dc8f208", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId?timestamp=&timeout=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "query": [ { "description": "The date and time of a call session latest change", "key": "timestamp", "value": "" }, { "description": "The time frame of awaiting for a status change before sending\nthe resulting one in response\n", "key": "timeout", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-f863b02b-b47f-4837-832c-d11c3dc8f208" }, { "id": "68f02149-ea75-435d-8024-91bd2e526696", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId?timestamp=&timeout=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "query": [ { "description": "The date and time of a call session latest change", "key": "timestamp", "value": "" }, { "description": "The time frame of awaiting for a status change before sending\nthe resulting one in response\n", "key": "timeout", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-68f02149-ea75-435d-8024-91bd2e526696" }, { "id": "cdbf2817-9fcc-4a42-9a93-ee965a8c3f4c", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId?timestamp=&timeout=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "query": [ { "description": "The date and time of a call session latest change", "key": "timestamp", "value": "" }, { "description": "The time frame of awaiting for a status change before sending\nthe resulting one in response\n", "key": "timeout", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-cdbf2817-9fcc-4a42-9a93-ee965a8c3f4c" }, { "id": "ad1b5022-45ec-4335-881c-2fba662c8459", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId?timestamp=&timeout=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "query": [ { "description": "The date and time of a call session latest change", "key": "timestamp", "value": "" }, { "description": "The time frame of awaiting for a status change before sending\nthe resulting one in response\n", "key": "timeout", "value": "" } ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-ad1b5022-45ec-4335-881c-2fba662c8459" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-4419dea8-9f97-4bf2-809f-838cc5ab8a2e" }, { "name": "Drop Call Session", "id": "c4818b2a-a0f0-4564-b5b5-adfa9ac6ed32", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "variable": [ { "id": "e9cd86da-8886-4713-ad7c-04b8e0f7a901", "key": "accountId", "value": "~", "description": "(Required) Internal identifier of the RingCentral account\n(can be set to \"~\" to indicate that the account associated with current authorization session should be used)\n" }, { "id": "00e93c4b-087f-434d-a0b8-19bece5f66d9", "key": "telephonySessionId", "value": "", "description": "(Required) Internal identifier of a call session" } ] }, "description": "Drops a call session." }, "response": [ { "id": "b8a92370-a6ea-4a15-91f9-041b72106248", "name": "No Content", "originalRequest": { "method": "DELETE", "header": [ { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-b8a92370-a6ea-4a15-91f9-041b72106248" }, { "id": "a521414a-a119-4a6a-9d62-f2f97541eb2d", "name": "General response with **HTTP 403 \"Forbidden\"** status.
\nReasons: the requested operation is forbidden because of certain resource state, lack of permissions, feature unavailability, etc.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-a521414a-a119-4a6a-9d62-f2f97541eb2d" }, { "id": "b7a349ec-4522-4830-84e0-04aff0b2c80d", "name": "General response with **HTTP 404 \"Not found\"** status.
\nReasons: the entity with given ID (typically specified in a path parameter), is not found or inaccessible\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-b7a349ec-4522-4830-84e0-04aff0b2c80d" }, { "id": "e0e7f7ab-04ff-4c76-9880-0f47fa05581c", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-e0e7f7ab-04ff-4c76-9880-0f47fa05581c" }, { "id": "eb3955ae-7676-4080-af46-4774cdb2bff9", "name": "General response with **HTTP 503 \"Service not available\"** status.
\nReasons: server cannot process the request because of being overloaded, misconfiguration or other issues.\n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/telephony/sessions/:telephonySessionId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "telephony", "sessions", ":telephonySessionId" ], "variable": [ { "key": "accountId" }, { "key": "telephonySessionId" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ]\n}", "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-eb3955ae-7676-4080-af46-4774cdb2bff9" } ], "createdAt": "2026-07-28T02:48:01.000Z", "updatedAt": "2026-07-28T02:48:01.000Z", "uid": "35240-c4818b2a-a0f0-4564-b5b5-adfa9ac6ed32" } ], "id": "e55bee34-ee45-47a8-a32c-43ca8abd49b2", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-e55bee34-ee45-47a8-a32c-43ca8abd49b2" } ], "id": "afb125d9-afd4-4564-8822-4c8e28e598c4", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-afb125d9-afd4-4564-8822-4c8e28e598c4" } ], "id": "bf930c39-deb2-46f7-9930-fcfd7b8132bf", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-bf930c39-deb2-46f7-9930-fcfd7b8132bf" } ], "id": "239eb323-141e-4d17-a283-d24b143c6729", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-239eb323-141e-4d17-a283-d24b143c6729" } ], "id": "1b0d9563-314e-4d95-9267-dbd49a7f0c58", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-1b0d9563-314e-4d95-9267-dbd49a7f0c58" } ], "id": "f7accbfc-ce16-4f60-9102-44327abf3f7f", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-f7accbfc-ce16-4f60-9102-44327abf3f7f" } ], "id": "024a9f3d-114b-49ed-98ff-2ed489240ea4", "createdAt": "2026-07-28T02:48:00.000Z", "updatedAt": "2026-07-28T02:48:00.000Z", "uid": "35240-024a9f3d-114b-49ed-98ff-2ed489240ea4" } ], "auth": { "type": "oauth2", "oauth2": [ { "key": "redirect_uri", "value": "https://platform.ringcentral.com/restapi/oauth/token", "type": "string" }, { "key": "accessTokenUrl", "value": "https://platform.ringcentral.com/restapi/oauth/token", "type": "string" }, { "key": "authUrl", "value": "https://platform.ringcentral.com/restapi/oauth/authorize", "type": "string" }, { "key": "grant_type", "value": "authorization_code", "type": "string" } ] }, "variable": [ { "key": "baseUrl", "value": "https://platform.ringcentral.com" } ] }