{ "info": { "_postman_id": "347118de-c13e-4968-8a73-ca3d5f889d27", "name": "RingCentral Adaptive Cards Phone Numbers 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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "lastUpdatedBy": "35240", "uid": "35240-347118de-c13e-4968-8a73-ca3d5f889d27" }, "item": [ { "name": "restapi", "item": [ { "name": "v2", "item": [ { "name": "accounts", "item": [ { "name": "{accountId}", "item": [ { "name": "phone-numbers", "item": [ { "name": "{phoneNumberId}", "item": [ { "name": "replace", "item": [ { "name": "Replace Phone Number", "id": "65d4153e-9bad-4336-8897-2fd5adddb230", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"targetPhoneNumberId\": \"942546905230\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId/replace", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId", "replace" ], "variable": [ { "id": "4ff215a7-604d-4fd8-8908-645df16bd564", "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": "c2f9b12d-adeb-4ea5-8466-5c13901c8f7a", "key": "phoneNumberId", "value": "23072", "description": "(Required) Internal identifier of a phone number" } ] }, "description": "Replaces (swaps) phone numbers from Inventory with the main, company, direct or company fax numbers.\nThis method is used to replace temporary numbers when the porting process is complete.\n" }, "response": [ { "id": "c4e36dc8-0f06-4ec5-8081-5e3bab64ab3c", "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 \"targetPhoneNumberId\": \"942546905230\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId/replace", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId", "replace" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"15852\",\n \"tollType\": \"Toll\",\n \"usageType\": \"CompanyFaxNumber\",\n \"status\": \"PortedIn\",\n \"phoneNumber\": \"+57952\",\n \"type\": \"VoiceFax\",\n \"byocNumber\": \"\",\n \"extension\": {\n \"id\": \"\",\n \"extensionNumber\": \"593\"\n }\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-c4e36dc8-0f06-4ec5-8081-5e3bab64ab3c" }, { "id": "f0210bf0-a563-4c2a-8ac7-9e30d9dfcc17", "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 \"targetPhoneNumberId\": \"942546905230\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId/replace", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId", "replace" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-f0210bf0-a563-4c2a-8ac7-9e30d9dfcc17" }, { "id": "74f0ad5a-df25-447b-9b5e-149914daa85e", "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 \"targetPhoneNumberId\": \"942546905230\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId/replace", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId", "replace" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-74f0ad5a-df25-447b-9b5e-149914daa85e" }, { "id": "e64516a3-9868-4571-b5e9-2dafbd5036f9", "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 \"targetPhoneNumberId\": \"942546905230\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId/replace", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId", "replace" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-e64516a3-9868-4571-b5e9-2dafbd5036f9" }, { "id": "5971ca97-f94d-423e-a3e7-3d526d253d76", "name": "General response with **HTTP 429 \"Too many requests\"** status.
\nReasons: certain rate limit is exceeded.\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 \"targetPhoneNumberId\": \"942546905230\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId/replace", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId", "replace" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "status": "Too Many Requests", "code": 429, "_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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-5971ca97-f94d-423e-a3e7-3d526d253d76" }, { "id": "207ce527-cf3c-4f02-b165-339d7c3496a4", "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 \"targetPhoneNumberId\": \"942546905230\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId/replace", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId", "replace" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-207ce527-cf3c-4f02-b165-339d7c3496a4" }, { "id": "ca0e2f89-4ef8-4152-a7ff-ed357781ba1b", "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 \"targetPhoneNumberId\": \"942546905230\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId/replace", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId", "replace" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-ca0e2f89-4ef8-4152-a7ff-ed357781ba1b" } ], "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-65d4153e-9bad-4336-8897-2fd5adddb230" } ], "id": "592d61df-4e77-438c-ae9a-ff4b6d346c6d", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-592d61df-4e77-438c-ae9a-ff4b6d346c6d" }, { "name": "Assign Phone Number", "id": "1dadac75-87b7-44b6-a50c-123f45901f06", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"usageType\": \"PhoneLine\",\n \"type\": \"VoiceOnly\",\n \"extension\": {\n \"id\": \"\"\n },\n \"costCenterId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId" ], "variable": [ { "id": "7144313e-554f-4578-a483-84a3c5c68508", "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": "1a528f50-7f4a-40e3-b1df-fab5b15e452f", "key": "phoneNumberId", "value": "23072", "description": "(Required) Internal identifier of a phone number" } ] }, "description": "Assigns or reassigns a phone number as a company or extension number.\n\nAssign scenarios supported:\n- from Inventory to a company number;\n- from Inventory to an extension number.\n\nReassign scenarios supported:\n- from an extension to another extension;\n- from an extension to a company number;\n- from a company number to an extension.\n" }, "response": [ { "id": "80b94a1b-b681-41c1-85cd-46d69cc026c2", "name": "Successful response", "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 \"usageType\": \"PhoneLine\",\n \"type\": \"VoiceOnly\",\n \"extension\": {\n \"id\": \"\"\n },\n \"costCenterId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"15852\",\n \"tollType\": \"Toll\",\n \"usageType\": \"CompanyFaxNumber\",\n \"status\": \"PortedIn\",\n \"phoneNumber\": \"+57952\",\n \"type\": \"VoiceFax\",\n \"byocNumber\": \"\",\n \"extension\": {\n \"id\": \"\",\n \"extensionNumber\": \"593\"\n }\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-80b94a1b-b681-41c1-85cd-46d69cc026c2" }, { "id": "e2ad965e-0f1f-4f79-ad5c-24a183189276", "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 \"usageType\": \"PhoneLine\",\n \"type\": \"VoiceOnly\",\n \"extension\": {\n \"id\": \"\"\n },\n \"costCenterId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-e2ad965e-0f1f-4f79-ad5c-24a183189276" }, { "id": "8a031c59-7193-4449-970c-6d68262f8e8a", "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 \"usageType\": \"PhoneLine\",\n \"type\": \"VoiceOnly\",\n \"extension\": {\n \"id\": \"\"\n },\n \"costCenterId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-8a031c59-7193-4449-970c-6d68262f8e8a" }, { "id": "31e308d8-ce17-46b5-a964-e1f5d0192453", "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 \"usageType\": \"PhoneLine\",\n \"type\": \"VoiceOnly\",\n \"extension\": {\n \"id\": \"\"\n },\n \"costCenterId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-31e308d8-ce17-46b5-a964-e1f5d0192453" }, { "id": "b57bbea2-7829-4c9b-90fe-634bb7146b46", "name": "General response with **HTTP 429 \"Too many requests\"** status.
\nReasons: certain rate limit is exceeded.\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 \"usageType\": \"PhoneLine\",\n \"type\": \"VoiceOnly\",\n \"extension\": {\n \"id\": \"\"\n },\n \"costCenterId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "status": "Too Many Requests", "code": 429, "_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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-b57bbea2-7829-4c9b-90fe-634bb7146b46" }, { "id": "4d2bc5b8-4c0b-4d32-b982-32dd87b6c95e", "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 \"usageType\": \"PhoneLine\",\n \"type\": \"VoiceOnly\",\n \"extension\": {\n \"id\": \"\"\n },\n \"costCenterId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-4d2bc5b8-4c0b-4d32-b982-32dd87b6c95e" }, { "id": "09ef44b4-e533-4624-b8c3-cfca59bbc23e", "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 \"usageType\": \"PhoneLine\",\n \"type\": \"VoiceOnly\",\n \"extension\": {\n \"id\": \"\"\n },\n \"costCenterId\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/:phoneNumberId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", ":phoneNumberId" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-09ef44b4-e533-4624-b8c3-cfca59bbc23e" } ], "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-1dadac75-87b7-44b6-a50c-123f45901f06" } ], "id": "711e22d2-78f0-40fb-9f7d-5c425133f38e", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-711e22d2-78f0-40fb-9f7d-5c425133f38e" }, { "name": "bulk-add", "item": [ { "name": "{taskId}", "item": [ { "name": "Get Add Numbers Task Results", "id": "f211ea42-fb7a-4da9-9d31-40f8e7a048c1", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/bulk-add/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add", ":taskId" ], "variable": [ { "id": "b98ab2a5-34c0-4a34-aabe-5e19563ebf88", "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": "21c6c400-d340-4656-9e9a-8dcf26dafdb8", "key": "taskId", "value": "", "description": "(Required) Identifier of a task returned by asynchronous bulk add operation" } ] }, "description": "Returns the result of asynchronous operation which adds phone numbers to the account Inventory.\n" }, "response": [ { "id": "1e44f83c-2333-4ee5-a112-e7a1d11cd018", "name": "Successful response", "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/v2/accounts/:accountId/phone-numbers/bulk-add/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add", ":taskId" ], "variable": [ { "key": "accountId" }, { "key": "taskId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"records\": [\n {\n \"bulkItemSuccessful\": \"\",\n \"phoneNumber\": \"+5931655141499\",\n \"bulkItemErrors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ],\n \"id\": \"249\"\n }\n ]\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-1e44f83c-2333-4ee5-a112-e7a1d11cd018" }, { "id": "8613bfe6-579c-4027-a6ee-0ba0e64d9a1e", "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/v2/accounts/:accountId/phone-numbers/bulk-add/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add", ":taskId" ], "variable": [ { "key": "accountId" }, { "key": "taskId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-8613bfe6-579c-4027-a6ee-0ba0e64d9a1e" }, { "id": "837a6ac0-2387-4284-a408-fd853fe8b7e7", "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/v2/accounts/:accountId/phone-numbers/bulk-add/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add", ":taskId" ], "variable": [ { "key": "accountId" }, { "key": "taskId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-837a6ac0-2387-4284-a408-fd853fe8b7e7" }, { "id": "33ea3ae9-8366-49a7-a743-b9ebd3f9f771", "name": "General response with **HTTP 429 \"Too many requests\"** status.
\nReasons: certain rate limit is exceeded.\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/v2/accounts/:accountId/phone-numbers/bulk-add/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add", ":taskId" ], "variable": [ { "key": "accountId" }, { "key": "taskId" } ] } }, "status": "Too Many Requests", "code": 429, "_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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-33ea3ae9-8366-49a7-a743-b9ebd3f9f771" }, { "id": "1eb21590-da2e-4a14-86a5-6c6f08b0d0d9", "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/v2/accounts/:accountId/phone-numbers/bulk-add/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add", ":taskId" ], "variable": [ { "key": "accountId" }, { "key": "taskId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-1eb21590-da2e-4a14-86a5-6c6f08b0d0d9" }, { "id": "a1460eb2-0a80-44e4-a1ce-e9694440853d", "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/v2/accounts/:accountId/phone-numbers/bulk-add/:taskId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add", ":taskId" ], "variable": [ { "key": "accountId" }, { "key": "taskId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-a1460eb2-0a80-44e4-a1ce-e9694440853d" } ], "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-f211ea42-fb7a-4da9-9d31-40f8e7a048c1" } ], "id": "0e132a40-5c82-457a-9d5f-381a462eedac", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-0e132a40-5c82-457a-9d5f-381a462eedac" }, { "name": "Add Numbers to Inventory", "id": "6fe7b9b6-0c99-4e62-ae82-7e9e848e248d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"phoneNumber\": \"\",\n \"usageType\": \"Inventory\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/bulk-add", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add" ], "variable": [ { "id": "d5efbf71-efda-4af6-b75c-fd185f7d468d", "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": "Adds phone numbers to the account Inventory as unassigned. Currently, we support the following values: `Inventory`,\n`InventoryPartnerBusinessMobileNumber` and `PartnerBusinessMobileNumber`. Later we may support some other values like `ForwardedNumber`, etc.\n" }, "response": [ { "id": "85448783-313f-4c77-af00-df79e58af607", "name": "Successful response (synchronous operation)", "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 \"records\": [\n {\n \"phoneNumber\": \"\",\n \"usageType\": \"Inventory\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/bulk-add", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"records\": [\n {\n \"bulkItemSuccessful\": \"\",\n \"phoneNumber\": \"+5931655141499\",\n \"bulkItemErrors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ],\n \"id\": \"249\"\n }\n ]\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-85448783-313f-4c77-af00-df79e58af607" }, { "id": "b49f9c5d-7944-460d-8f66-e43f315806c1", "name": "Successful response (asynchronous operation)", "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 \"records\": [\n {\n \"phoneNumber\": \"\",\n \"usageType\": \"Inventory\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/bulk-add", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add" ], "variable": [ { "key": "accountId" } ] } }, "status": "Accepted", "code": 202, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"creationTime\": \"\",\n \"status\": \"\"\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-b49f9c5d-7944-460d-8f66-e43f315806c1" }, { "id": "d564e79c-a678-4648-be0a-8b5fa9d38bfb", "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 \"records\": [\n {\n \"phoneNumber\": \"\",\n \"usageType\": \"Inventory\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/bulk-add", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add" ], "variable": [ { "key": "accountId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-d564e79c-a678-4648-be0a-8b5fa9d38bfb" }, { "id": "f649fe15-1bf6-4a6c-8aaa-66e8576b8f31", "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 \"records\": [\n {\n \"phoneNumber\": \"\",\n \"usageType\": \"Inventory\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/bulk-add", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add" ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-f649fe15-1bf6-4a6c-8aaa-66e8576b8f31" }, { "id": "b481e786-beb8-406e-b58a-5af15ba340b5", "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 \"records\": [\n {\n \"phoneNumber\": \"\",\n \"usageType\": \"Inventory\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/bulk-add", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add" ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-b481e786-beb8-406e-b58a-5af15ba340b5" }, { "id": "3eace12f-b8e0-4d23-b20a-80f21691088c", "name": "General response with **HTTP 429 \"Too many requests\"** status.
\nReasons: certain rate limit is exceeded.\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 \"records\": [\n {\n \"phoneNumber\": \"\",\n \"usageType\": \"Inventory\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/bulk-add", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add" ], "variable": [ { "key": "accountId" } ] } }, "status": "Too Many Requests", "code": 429, "_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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-3eace12f-b8e0-4d23-b20a-80f21691088c" }, { "id": "9881e0b2-207d-4f91-a1f2-56a4fc488b8c", "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 \"records\": [\n {\n \"phoneNumber\": \"\",\n \"usageType\": \"Inventory\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/bulk-add", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add" ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-9881e0b2-207d-4f91-a1f2-56a4fc488b8c" }, { "id": "18b84d55-f7e8-4317-8ad9-4d0764df5c96", "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 \"records\": [\n {\n \"phoneNumber\": \"\",\n \"usageType\": \"Inventory\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers/bulk-add", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers", "bulk-add" ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-18b84d55-f7e8-4317-8ad9-4d0764df5c96" } ], "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-6fe7b9b6-0c99-4e62-ae82-7e9e848e248d" } ], "id": "446002f8-08a5-4090-92e7-2ebf19bbcbf3", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-446002f8-08a5-4090-92e7-2ebf19bbcbf3" }, { "name": "List Account Phone Numbers", "id": "3df72fa3-2f5d-4466-8466-40f35b03ff58", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers?page=1&perPage=100&type=FaxOnly&type=FaxOnly&usageType=ConferencingNumber&usageType=MainCompanyNumber&status=PortedIn&tollType=TollFree&extensionStatus=Disabled&byocNumber=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "query": [ { "description": "The result set page number (1-indexed) to return", "key": "page", "value": "1" }, { "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n", "key": "perPage", "value": "100" }, { "description": "Types of phone numbers to be returned", "key": "type", "value": "FaxOnly" }, { "description": "Types of phone numbers to be returned", "key": "type", "value": "FaxOnly" }, { "description": "Usage type(s) of phone numbers to be returned", "key": "usageType", "value": "ConferencingNumber" }, { "description": "Usage type(s) of phone numbers to be returned", "key": "usageType", "value": "MainCompanyNumber" }, { "description": "Status of the phone number(s) to be returned", "key": "status", "value": "PortedIn" }, { "description": "Toll type of phone numbers to return", "key": "tollType", "value": "TollFree" }, { "description": "Statuses of extensions to return phone numbers for", "key": "extensionStatus", "value": "Disabled" }, { "description": "The parameter reflects whether this number is BYOC or not", "key": "byocNumber", "value": "" }, { "description": "Phone number in e.164 format to be searched for.\nParameter value can include wildcards (e.g. \"+165012345**\")\nor be an exact number \"+16501234500\" - single number is searched in that case.\nMake sure you escape the \"+\" in the URL as \"%2B\"\n", "key": "phoneNumber", "value": "" } ], "variable": [ { "id": "d5d0b27c-57d9-446d-923b-b25e03bdbfa9", "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": "Returns the list of phone numbers assigned to RingCentral customer\naccount. Both company-level and extension-level numbers are returned.\nConferencing numbers, hot desk and ELIN numbers are not returned.\n" }, "response": [ { "id": "5c971031-f2bd-4df7-92b3-eb3d8aef1c75", "name": "Successful response", "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/v2/accounts/:accountId/phone-numbers?page=1&perPage=100&type=FaxOnly&usageType=MainCompanyNumber&status=PortedIn&tollType=TollFree&extensionStatus=Disabled&byocNumber=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "query": [ { "description": "The result set page number (1-indexed) to return", "key": "page", "value": "1" }, { "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n", "key": "perPage", "value": "100" }, { "description": "Types of phone numbers to be returned", "key": "type", "value": "FaxOnly" }, { "description": "Usage type(s) of phone numbers to be returned", "key": "usageType", "value": "MainCompanyNumber" }, { "description": "Status of the phone number(s) to be returned", "key": "status", "value": "PortedIn" }, { "description": "Toll type of phone numbers to return", "key": "tollType", "value": "TollFree" }, { "description": "Statuses of extensions to return phone numbers for", "key": "extensionStatus", "value": "Disabled" }, { "description": "The parameter reflects whether this number is BYOC or not", "key": "byocNumber", "value": "" }, { "description": "Phone number in e.164 format to be searched for.\nParameter value can include wildcards (e.g. \"+165012345**\")\nor be an exact number \"+16501234500\" - single number is searched in that case.\nMake sure you escape the \"+\" in the URL as \"%2B\"\n", "key": "phoneNumber", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"records\": [\n {\n \"id\": \"710342093\",\n \"tollType\": \"TollFree\",\n \"usageType\": \"ForwardedNumber\",\n \"status\": \"Unknown\",\n \"phoneNumber\": \"+7193261282\",\n \"type\": \"FaxOnly\",\n \"byocNumber\": \"\",\n \"extension\": {\n \"id\": \"\",\n \"extensionNumber\": \"46238\"\n }\n },\n {\n \"id\": \"6466749602914\",\n \"tollType\": \"TollFree\",\n \"usageType\": \"BusinessMobileNumber\",\n \"status\": \"PortedIn\",\n \"phoneNumber\": \"+3672757020226\",\n \"type\": \"VoiceFax\",\n \"byocNumber\": \"\",\n \"extension\": {\n \"id\": \"\",\n \"extensionNumber\": \"847\"\n }\n }\n ],\n \"paging\": {\n \"perPage\": \"\",\n \"page\": \"\",\n \"pageStart\": \"\",\n \"pageEnd\": \"\",\n \"totalPages\": \"\",\n \"totalElements\": \"\"\n }\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-5c971031-f2bd-4df7-92b3-eb3d8aef1c75" }, { "id": "afa6a0be-047e-4789-a5f7-bb2800e973b3", "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": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers?page=1&perPage=100&type=FaxOnly&usageType=MainCompanyNumber&status=PortedIn&tollType=TollFree&extensionStatus=Disabled&byocNumber=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "query": [ { "description": "The result set page number (1-indexed) to return", "key": "page", "value": "1" }, { "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n", "key": "perPage", "value": "100" }, { "description": "Types of phone numbers to be returned", "key": "type", "value": "FaxOnly" }, { "description": "Usage type(s) of phone numbers to be returned", "key": "usageType", "value": "MainCompanyNumber" }, { "description": "Status of the phone number(s) to be returned", "key": "status", "value": "PortedIn" }, { "description": "Toll type of phone numbers to return", "key": "tollType", "value": "TollFree" }, { "description": "Statuses of extensions to return phone numbers for", "key": "extensionStatus", "value": "Disabled" }, { "description": "The parameter reflects whether this number is BYOC or not", "key": "byocNumber", "value": "" }, { "description": "Phone number in e.164 format to be searched for.\nParameter value can include wildcards (e.g. \"+165012345**\")\nor be an exact number \"+16501234500\" - single number is searched in that case.\nMake sure you escape the \"+\" in the URL as \"%2B\"\n", "key": "phoneNumber", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-afa6a0be-047e-4789-a5f7-bb2800e973b3" }, { "id": "bf732a48-6b96-4997-b9a2-4fe4ffcaf9d8", "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/v2/accounts/:accountId/phone-numbers?page=1&perPage=100&type=FaxOnly&usageType=MainCompanyNumber&status=PortedIn&tollType=TollFree&extensionStatus=Disabled&byocNumber=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "query": [ { "description": "The result set page number (1-indexed) to return", "key": "page", "value": "1" }, { "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n", "key": "perPage", "value": "100" }, { "description": "Types of phone numbers to be returned", "key": "type", "value": "FaxOnly" }, { "description": "Usage type(s) of phone numbers to be returned", "key": "usageType", "value": "MainCompanyNumber" }, { "description": "Status of the phone number(s) to be returned", "key": "status", "value": "PortedIn" }, { "description": "Toll type of phone numbers to return", "key": "tollType", "value": "TollFree" }, { "description": "Statuses of extensions to return phone numbers for", "key": "extensionStatus", "value": "Disabled" }, { "description": "The parameter reflects whether this number is BYOC or not", "key": "byocNumber", "value": "" }, { "description": "Phone number in e.164 format to be searched for.\nParameter value can include wildcards (e.g. \"+165012345**\")\nor be an exact number \"+16501234500\" - single number is searched in that case.\nMake sure you escape the \"+\" in the URL as \"%2B\"\n", "key": "phoneNumber", "value": "" } ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-bf732a48-6b96-4997-b9a2-4fe4ffcaf9d8" }, { "id": "3d50510e-dbe7-40ab-91fa-6053a16b391d", "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/v2/accounts/:accountId/phone-numbers?page=1&perPage=100&type=FaxOnly&usageType=MainCompanyNumber&status=PortedIn&tollType=TollFree&extensionStatus=Disabled&byocNumber=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "query": [ { "description": "The result set page number (1-indexed) to return", "key": "page", "value": "1" }, { "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n", "key": "perPage", "value": "100" }, { "description": "Types of phone numbers to be returned", "key": "type", "value": "FaxOnly" }, { "description": "Usage type(s) of phone numbers to be returned", "key": "usageType", "value": "MainCompanyNumber" }, { "description": "Status of the phone number(s) to be returned", "key": "status", "value": "PortedIn" }, { "description": "Toll type of phone numbers to return", "key": "tollType", "value": "TollFree" }, { "description": "Statuses of extensions to return phone numbers for", "key": "extensionStatus", "value": "Disabled" }, { "description": "The parameter reflects whether this number is BYOC or not", "key": "byocNumber", "value": "" }, { "description": "Phone number in e.164 format to be searched for.\nParameter value can include wildcards (e.g. \"+165012345**\")\nor be an exact number \"+16501234500\" - single number is searched in that case.\nMake sure you escape the \"+\" in the URL as \"%2B\"\n", "key": "phoneNumber", "value": "" } ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-3d50510e-dbe7-40ab-91fa-6053a16b391d" }, { "id": "861a1513-5486-4c3e-b568-1920ba390354", "name": "General response with **HTTP 429 \"Too many requests\"** status.
\nReasons: certain rate limit is exceeded.\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/v2/accounts/:accountId/phone-numbers?page=1&perPage=100&type=FaxOnly&usageType=MainCompanyNumber&status=PortedIn&tollType=TollFree&extensionStatus=Disabled&byocNumber=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "query": [ { "description": "The result set page number (1-indexed) to return", "key": "page", "value": "1" }, { "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n", "key": "perPage", "value": "100" }, { "description": "Types of phone numbers to be returned", "key": "type", "value": "FaxOnly" }, { "description": "Usage type(s) of phone numbers to be returned", "key": "usageType", "value": "MainCompanyNumber" }, { "description": "Status of the phone number(s) to be returned", "key": "status", "value": "PortedIn" }, { "description": "Toll type of phone numbers to return", "key": "tollType", "value": "TollFree" }, { "description": "Statuses of extensions to return phone numbers for", "key": "extensionStatus", "value": "Disabled" }, { "description": "The parameter reflects whether this number is BYOC or not", "key": "byocNumber", "value": "" }, { "description": "Phone number in e.164 format to be searched for.\nParameter value can include wildcards (e.g. \"+165012345**\")\nor be an exact number \"+16501234500\" - single number is searched in that case.\nMake sure you escape the \"+\" in the URL as \"%2B\"\n", "key": "phoneNumber", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Too Many Requests", "code": 429, "_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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-861a1513-5486-4c3e-b568-1920ba390354" }, { "id": "4505bc82-d8f2-4e52-82d3-d6fed09a119a", "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/v2/accounts/:accountId/phone-numbers?page=1&perPage=100&type=FaxOnly&usageType=MainCompanyNumber&status=PortedIn&tollType=TollFree&extensionStatus=Disabled&byocNumber=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "query": [ { "description": "The result set page number (1-indexed) to return", "key": "page", "value": "1" }, { "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n", "key": "perPage", "value": "100" }, { "description": "Types of phone numbers to be returned", "key": "type", "value": "FaxOnly" }, { "description": "Usage type(s) of phone numbers to be returned", "key": "usageType", "value": "MainCompanyNumber" }, { "description": "Status of the phone number(s) to be returned", "key": "status", "value": "PortedIn" }, { "description": "Toll type of phone numbers to return", "key": "tollType", "value": "TollFree" }, { "description": "Statuses of extensions to return phone numbers for", "key": "extensionStatus", "value": "Disabled" }, { "description": "The parameter reflects whether this number is BYOC or not", "key": "byocNumber", "value": "" }, { "description": "Phone number in e.164 format to be searched for.\nParameter value can include wildcards (e.g. \"+165012345**\")\nor be an exact number \"+16501234500\" - single number is searched in that case.\nMake sure you escape the \"+\" in the URL as \"%2B\"\n", "key": "phoneNumber", "value": "" } ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-4505bc82-d8f2-4e52-82d3-d6fed09a119a" }, { "id": "4c300f4d-b09e-414a-8e39-118d49be5ac2", "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/v2/accounts/:accountId/phone-numbers?page=1&perPage=100&type=FaxOnly&usageType=MainCompanyNumber&status=PortedIn&tollType=TollFree&extensionStatus=Disabled&byocNumber=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "query": [ { "description": "The result set page number (1-indexed) to return", "key": "page", "value": "1" }, { "description": "The number of items per page. If provided value in the request\nis greater than a maximum, the maximum value is applied\n", "key": "perPage", "value": "100" }, { "description": "Types of phone numbers to be returned", "key": "type", "value": "FaxOnly" }, { "description": "Usage type(s) of phone numbers to be returned", "key": "usageType", "value": "MainCompanyNumber" }, { "description": "Status of the phone number(s) to be returned", "key": "status", "value": "PortedIn" }, { "description": "Toll type of phone numbers to return", "key": "tollType", "value": "TollFree" }, { "description": "Statuses of extensions to return phone numbers for", "key": "extensionStatus", "value": "Disabled" }, { "description": "The parameter reflects whether this number is BYOC or not", "key": "byocNumber", "value": "" }, { "description": "Phone number in e.164 format to be searched for.\nParameter value can include wildcards (e.g. \"+165012345**\")\nor be an exact number \"+16501234500\" - single number is searched in that case.\nMake sure you escape the \"+\" in the URL as \"%2B\"\n", "key": "phoneNumber", "value": "" } ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-4c300f4d-b09e-414a-8e39-118d49be5ac2" } ], "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-3df72fa3-2f5d-4466-8466-40f35b03ff58" }, { "name": "Delete Numbers from Inventory", "id": "88bd3fd4-b7b2-47f7-8f2c-0c706fbbc1fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"records\": [\n {\n \"id\": \"674397691069\",\n \"phoneNumber\": \"+8636\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "variable": [ { "id": "39e1d36a-bce9-432a-93f1-dcddf523d1bb", "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": "This method can only delete numbers that meet one of the following requirements:\n - numbers that have `\"usageType\": \"Inventory\"`\n - `\"Forwarded\"` numbers\n - `\"Forwarded Company\"` numbers\n\nIn other words, this method will not delete numbers which are in use on the account - extension direct numbers,\nmain number, etc. It is possible to indicate phone numbers to be deleted using their IDs or exact string values\nin e.164 format. However, the same lookup method (by ID or by value) must be used for all numbers within the same API call.\n" }, "response": [ { "id": "00f18543-cba0-4f36-ad00-0464f7f5ca10", "name": "Successful response", "originalRequest": { "method": "DELETE", "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 \"records\": [\n {\n \"id\": \"674397691069\",\n \"phoneNumber\": \"+8636\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"records\": [\n {\n \"bulkItemSuccessful\": \"\",\n \"bulkItemErrors\": [\n {\n \"errorCode\": \"\",\n \"message\": \"\"\n }\n ],\n \"id\": \"315\",\n \"phoneNumber\": \"+9909971054\"\n }\n ]\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-00f18543-cba0-4f36-ad00-0464f7f5ca10" }, { "id": "0bb1c659-8e8e-4d02-adb7-2a9c0bee14ff", "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": "DELETE", "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 \"records\": [\n {\n \"id\": \"674397691069\",\n \"phoneNumber\": \"+8636\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "variable": [ { "key": "accountId" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-0bb1c659-8e8e-4d02-adb7-2a9c0bee14ff" }, { "id": "362656f3-b845-4b26-8744-b55e4c8e9769", "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": "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 \"records\": [\n {\n \"id\": \"674397691069\",\n \"phoneNumber\": \"+8636\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-362656f3-b845-4b26-8744-b55e4c8e9769" }, { "id": "220c43ac-2419-4a49-8c38-dc7fc36d8459", "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": "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 \"records\": [\n {\n \"id\": \"674397691069\",\n \"phoneNumber\": \"+8636\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-220c43ac-2419-4a49-8c38-dc7fc36d8459" }, { "id": "7b6f6a00-5c5c-4737-ac26-d81708b7bfb5", "name": "General response with **HTTP 429 \"Too many requests\"** status.
\nReasons: certain rate limit is exceeded.\n", "originalRequest": { "method": "DELETE", "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 \"records\": [\n {\n \"id\": \"674397691069\",\n \"phoneNumber\": \"+8636\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "variable": [ { "key": "accountId" } ] } }, "status": "Too Many Requests", "code": 429, "_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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-7b6f6a00-5c5c-4737-ac26-d81708b7bfb5" }, { "id": "51e8d3c1-5b09-4b03-939e-2b1f27fbe11c", "name": "General response with **HTTP 500 \"Internal Server Error\"** status.
\nReasons: general server-side error.\n", "originalRequest": { "method": "DELETE", "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 \"records\": [\n {\n \"id\": \"674397691069\",\n \"phoneNumber\": \"+8636\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-51e8d3c1-5b09-4b03-939e-2b1f27fbe11c" }, { "id": "01e3b135-545c-444b-99a6-1ee717d8a7f9", "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": "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 \"records\": [\n {\n \"id\": \"674397691069\",\n \"phoneNumber\": \"+8636\"\n }\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v2/accounts/:accountId/phone-numbers", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v2", "accounts", ":accountId", "phone-numbers" ], "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-01e3b135-545c-444b-99a6-1ee717d8a7f9" } ], "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-88bd3fd4-b7b2-47f7-8f2c-0c706fbbc1fa" } ], "id": "8ed48b0b-b573-49ed-9ff7-ed6c78bb8c1b", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-8ed48b0b-b573-49ed-9ff7-ed6c78bb8c1b" } ], "id": "bb53471e-d085-4cbe-9e2a-4b528015b9ca", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-bb53471e-d085-4cbe-9e2a-4b528015b9ca" } ], "id": "7bb37793-cfc4-4cea-8192-c6710dc6f379", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-7bb37793-cfc4-4cea-8192-c6710dc6f379" } ], "id": "4070d5d7-dab8-4a96-82d5-0b2385d54e02", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-4070d5d7-dab8-4a96-82d5-0b2385d54e02" }, { "name": "v1.0", "item": [ { "name": "account", "item": [ { "name": "{accountId}", "item": [ { "name": "extension", "item": [ { "name": "{extensionId}", "item": [ { "name": "phone-number", "item": [ { "name": "Get Extension Phone Number List", "id": "5df26fdd-13d8-4dd6-856d-6c32cf520278", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/extension/:extensionId/phone-number?status=Temporary&usageType=BusinessMobileNumber&usageType=AdditionalCompanyNumber&page=1&perPage=100", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "extension", ":extensionId", "phone-number" ], "query": [ { "description": "Status of a phone number", "key": "status", "value": "Temporary" }, { "description": "Usage type of phone number", "key": "usageType", "value": "BusinessMobileNumber" }, { "description": "Usage type of phone number", "key": "usageType", "value": "AdditionalCompanyNumber" }, { "description": "Indicates a page number to retrieve. Only positive number values\nare allowed. Default value is '1'\n", "key": "page", "value": "1" }, { "description": "Indicates a page size (number of items). If not specified, the value is '100' by default", "key": "perPage", "value": "100" } ], "variable": [ { "id": "21c40fac-9171-4963-8386-5beb32db91da", "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": "ea5649fd-7399-4e62-94d6-ad28f5e61567", "key": "extensionId", "value": "~", "description": "(Required) Internal identifier of the RingCentral extension/user\n(can be set to \"~\" to indicate that the extension associated with current authorization session should be used)\n" } ] }, "description": "Returns the list of phone numbers that are used by a particular extension,\ncan be filtered by the phone number type. The returned list contains all\nnumbers which are directly mapped to the given extension. Plus the features\nand company-level numbers that may be used when performing different operations\non behalf of this extension.\n" }, "response": [ { "id": "a400390e-6817-47fb-91a3-75fe410b73e0", "name": "OK: User Phone Number List", "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/extension/:extensionId/phone-number?status=Temporary&usageType=AdditionalCompanyNumber&page=1&perPage=100", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "extension", ":extensionId", "phone-number" ], "query": [ { "description": "Status of a phone number", "key": "status", "value": "Temporary" }, { "description": "Usage type of phone number", "key": "usageType", "value": "AdditionalCompanyNumber" }, { "description": "Indicates a page number to retrieve. Only positive number values\nare allowed. Default value is '1'\n", "key": "page", "value": "1" }, { "description": "Indicates a page size (number of items). If not specified, the value is '100' by default", "key": "perPage", "value": "100" } ], "variable": [ { "key": "accountId" }, { "key": "extensionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"\"\n },\n \"nextPage\": {\n \"uri\": \"\"\n },\n \"previousPage\": {\n \"uri\": \"\"\n },\n \"lastPage\": {\n \"uri\": \"\"\n }\n },\n \"paging\": {\n \"perPage\": \"\",\n \"page\": \"\",\n \"pageStart\": \"\",\n \"pageEnd\": \"\",\n \"totalPages\": \"\",\n \"totalElements\": \"\"\n },\n \"records\": [\n {\n \"uri\": \"\",\n \"id\": \"\",\n \"country\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"name\": \"\"\n },\n \"contactCenterProvider\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"extension\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"extensionNumber\": \"\",\n \"partnerId\": \"\",\n \"type\": \"DigitalUser\",\n \"contactCenterProvider\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\"\n },\n \"label\": \"\",\n \"location\": \"\",\n \"paymentType\": \"ExternalNumberProvider\",\n \"phoneNumber\": \"\",\n \"primary\": \"\",\n \"status\": \"Temporary\",\n \"type\": \"VoiceOnly\",\n \"subType\": \"DigitalSignage\",\n \"usageType\": \"ContactCenterNumber\",\n \"features\": [\n \"A2PSmsSender\",\n \"Delegated\"\n ]\n },\n {\n \"uri\": \"\",\n \"id\": \"\",\n \"country\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"name\": \"\"\n },\n \"contactCenterProvider\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"extension\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"extensionNumber\": \"\",\n \"partnerId\": \"\",\n \"type\": \"ApplicationExtension\",\n \"contactCenterProvider\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"name\": \"\"\n },\n \"label\": \"\",\n \"location\": \"\",\n \"paymentType\": \"BusinessMobileNumberProvider\",\n \"phoneNumber\": \"\",\n \"primary\": \"\",\n \"status\": \"Temporary\",\n \"type\": \"VoiceFax\",\n \"subType\": \"VideoPro\",\n \"usageType\": \"IntegrationNumber\",\n \"features\": [\n \"SmsSender\",\n \"CallerId\"\n ]\n }\n ],\n \"uri\": \"\"\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-a400390e-6817-47fb-91a3-75fe410b73e0" } ], "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-5df26fdd-13d8-4dd6-856d-6c32cf520278" } ], "id": "d3520ee2-fc88-4894-95fb-deca88a675b9", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-d3520ee2-fc88-4894-95fb-deca88a675b9" } ], "id": "ec88a902-d4e5-436b-975f-f3033805fc3a", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-ec88a902-d4e5-436b-975f-f3033805fc3a" } ], "id": "c4c9c06a-05b5-485f-bc60-8da7e26d92f8", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-c4c9c06a-05b5-485f-bc60-8da7e26d92f8" }, { "name": "phone-number", "item": [ { "name": "{phoneNumberId}", "item": [ { "name": "Get Phone Number", "id": "f67cf6ee-5abf-411c-868e-ae2eb9c7280f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/phone-number/:phoneNumberId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "phone-number", ":phoneNumberId" ], "variable": [ { "id": "074bf0f5-6a60-43e0-80eb-ba1e4c032cf7", "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": "07a6def0-1555-446b-ab9e-3dda54af9aab", "key": "phoneNumberId", "value": "", "description": "(Required) Internal identifier of a phone number" } ] }, "description": "Returns phone number(s) belonging to a certain account or extension by phoneNumberId(s).\n[Batch request syntax](https://developers.ringcentral.com/api-reference/Batch-Requests) is supported.\n" }, "response": [ { "id": "6e7d7c06-358c-42a7-b111-51e037b8d1ee", "name": "Phone number information", "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/phone-number/:phoneNumberId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "phone-number", ":phoneNumberId" ], "variable": [ { "key": "accountId" }, { "key": "phoneNumberId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"uri\": \"\",\n \"id\": \"\",\n \"country\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"name\": \"\"\n },\n \"extension\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"name\": \"\",\n \"extensionNumber\": \"\",\n \"partnerId\": \"\"\n },\n \"label\": \"\",\n \"location\": \"\",\n \"paymentType\": \"ExternalNumberProviderTollFree\",\n \"phoneNumber\": \"\",\n \"status\": \"PortedIn\",\n \"type\": \"VoiceFax\",\n \"usageType\": \"BusinessMobileNumber\",\n \"temporaryNumber\": {\n \"id\": \"\",\n \"phoneNumber\": \"\"\n },\n \"contactCenterProvider\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"vanityPattern\": \"\",\n \"primary\": \"\"\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-6e7d7c06-358c-42a7-b111-51e037b8d1ee" } ], "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-f67cf6ee-5abf-411c-868e-ae2eb9c7280f" } ], "id": "dd71d486-f06c-4d73-9ca2-0335a3386278", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-dd71d486-f06c-4d73-9ca2-0335a3386278" }, { "name": "List Company Phone Numbers", "id": "3984a57c-3615-4d86-9421-34cd8d50d999", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/phone-number?page=1&perPage=100&usageType=ConferencingNumber&usageType=CompanyNumber&paymentType=ExternalNumberProviderTollFree&status=Temporary", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "phone-number" ], "query": [ { "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n", "key": "page", "value": "1" }, { "description": "Indicates a page size (number of items)", "key": "perPage", "value": "100" }, { "description": "Usage type of phone number", "key": "usageType", "value": "ConferencingNumber" }, { "description": "Usage type of phone number", "key": "usageType", "value": "CompanyNumber" }, { "description": "Payment Type of the number", "key": "paymentType", "value": "ExternalNumberProviderTollFree" }, { "description": "Status of a phone number", "key": "status", "value": "Temporary" } ], "variable": [ { "id": "110ce775-9416-4d60-9723-4c3c4333b8f0", "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": "Returns the list of phone numbers assigned to RingCentral customer\naccount. Both company-level and extension-level numbers are returned.\n" }, "response": [ { "id": "937a6ba7-69dd-41f6-a958-5066d7d3d518", "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/phone-number?page=1&perPage=100&usageType=CompanyNumber&paymentType=ExternalNumberProviderTollFree&status=Temporary", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "phone-number" ], "query": [ { "description": "Indicates a page number to retrieve. Only positive number values\nare accepted\n", "key": "page", "value": "1" }, { "description": "Indicates a page size (number of items)", "key": "perPage", "value": "100" }, { "description": "Usage type of phone number", "key": "usageType", "value": "CompanyNumber" }, { "description": "Payment Type of the number", "key": "paymentType", "value": "ExternalNumberProviderTollFree" }, { "description": "Status of a phone number", "key": "status", "value": "Temporary" } ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"uri\": \"\",\n \"records\": [\n {\n \"uri\": \"\",\n \"id\": \"\",\n \"country\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"name\": \"\"\n },\n \"extension\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"name\": \"\",\n \"extensionNumber\": \"\",\n \"partnerId\": \"\"\n },\n \"label\": \"\",\n \"location\": \"\",\n \"paymentType\": \"TollFree\",\n \"phoneNumber\": \"\",\n \"status\": \"Pending\",\n \"type\": \"VoiceOnly\",\n \"usageType\": \"ForwardedNumber\",\n \"temporaryNumber\": {\n \"id\": \"\",\n \"phoneNumber\": \"\"\n },\n \"contactCenterProvider\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"vanityPattern\": \"\",\n \"primary\": \"\"\n },\n {\n \"uri\": \"\",\n \"id\": \"\",\n \"country\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"name\": \"\"\n },\n \"extension\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"name\": \"\",\n \"extensionNumber\": \"\",\n \"partnerId\": \"\"\n },\n \"label\": \"\",\n \"location\": \"\",\n \"paymentType\": \"Local\",\n \"phoneNumber\": \"\",\n \"status\": \"Normal\",\n \"type\": \"VoiceFax\",\n \"usageType\": \"MeetingsNumber\",\n \"temporaryNumber\": {\n \"id\": \"\",\n \"phoneNumber\": \"\"\n },\n \"contactCenterProvider\": {\n \"id\": \"\",\n \"name\": \"\"\n },\n \"vanityPattern\": \"\",\n \"primary\": \"\"\n }\n ],\n \"navigation\": {\n \"firstPage\": {\n \"uri\": \"\"\n },\n \"nextPage\": {\n \"uri\": \"\"\n },\n \"previousPage\": {\n \"uri\": \"\"\n },\n \"lastPage\": {\n \"uri\": \"\"\n }\n },\n \"paging\": {\n \"perPage\": \"\",\n \"page\": \"\",\n \"pageStart\": \"\",\n \"pageEnd\": \"\",\n \"totalPages\": \"\",\n \"totalElements\": \"\"\n }\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-937a6ba7-69dd-41f6-a958-5066d7d3d518" } ], "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-3984a57c-3615-4d86-9421-34cd8d50d999" } ], "id": "b3ad8329-cbd6-4601-9ddf-34c3d8c15490", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-b3ad8329-cbd6-4601-9ddf-34c3d8c15490" } ], "id": "49a05d02-53f6-4f80-ade6-2af6caee4773", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-49a05d02-53f6-4f80-ade6-2af6caee4773" } ], "id": "0de3d88d-7687-4eaf-bf9a-ac92cec4ca55", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-0de3d88d-7687-4eaf-bf9a-ac92cec4ca55" }, { "name": "number-parser", "item": [ { "name": "parse", "item": [ { "name": "Parse Phone Number(s)", "id": "47fd0f7a-b6be-4e73-a244-8df676eaa446", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"originalStrings\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/number-parser/parse?homeCountry=&nationalAsPriority=false", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "number-parser", "parse" ], "query": [ { "description": "ISO 3166 alpha2 code of the home country to be used if it is impossible to determine country from the number itself.\nBy default, this parameter is preset to the current user's home country or brand country if the user is undefined\n", "key": "homeCountry", "value": "" }, { "description": "The default value is `false`. If `true`, the numbers that are\ncloser to the home country are given higher priority\n", "key": "nationalAsPriority", "value": "false" } ] }, "description": "Returns one or more parsed and/or formatted phone numbers that are passed as strings." }, "response": [ { "id": "aee59d71-3751-487d-b7fd-01c744846e07", "name": "Successful response", "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 \"originalStrings\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/number-parser/parse?homeCountry=&nationalAsPriority=false", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "number-parser", "parse" ], "query": [ { "description": "ISO 3166 alpha2 code of the home country to be used if it is impossible to determine country from the number itself.\nBy default, this parameter is preset to the current user's home country or brand country if the user is undefined\n", "key": "homeCountry", "value": "" }, { "description": "The default value is `false`. If `true`, the numbers that are\ncloser to the home country are given higher priority\n", "key": "nationalAsPriority", "value": "false" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"homeCountry\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"callingCode\": \"\",\n \"isoCode\": \"TT\",\n \"name\": \"\"\n },\n \"phoneNumbers\": [\n {\n \"originalString\": \"\",\n \"country\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"callingCode\": \"\",\n \"isoCode\": \"GE\",\n \"name\": \"\"\n },\n \"areaCode\": \"\",\n \"dialable\": \"\",\n \"e164\": \"\",\n \"formattedInternational\": \"\",\n \"formattedNational\": \"\",\n \"special\": \"\",\n \"normalized\": \"\",\n \"tollFree\": \"\",\n \"subAddress\": \"\",\n \"subscriberNumber\": \"\",\n \"dtmfPostfix\": \"\"\n },\n {\n \"originalString\": \"\",\n \"country\": {\n \"id\": \"\",\n \"uri\": \"\",\n \"callingCode\": \"\",\n \"isoCode\": \"dw\",\n \"name\": \"\"\n },\n \"areaCode\": \"\",\n \"dialable\": \"\",\n \"e164\": \"\",\n \"formattedInternational\": \"\",\n \"formattedNational\": \"\",\n \"special\": \"\",\n \"normalized\": \"\",\n \"tollFree\": \"\",\n \"subAddress\": \"\",\n \"subscriberNumber\": \"\",\n \"dtmfPostfix\": \"\"\n }\n ],\n \"uri\": \"\"\n}", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-aee59d71-3751-487d-b7fd-01c744846e07" }, { "id": "bd39c611-6c9b-412e-9977-51ca88bb3fc5", "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 \"originalStrings\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/number-parser/parse?homeCountry=&nationalAsPriority=false", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "number-parser", "parse" ], "query": [ { "description": "ISO 3166 alpha2 code of the home country to be used if it is impossible to determine country from the number itself.\nBy default, this parameter is preset to the current user's home country or brand country if the user is undefined\n", "key": "homeCountry", "value": "" }, { "description": "The default value is `false`. If `true`, the numbers that are\ncloser to the home country are given higher priority\n", "key": "nationalAsPriority", "value": "false" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-bd39c611-6c9b-412e-9977-51ca88bb3fc5" }, { "id": "595b12c0-a24a-4bf0-a5ff-c1cdadf76b1b", "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 \"originalStrings\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/number-parser/parse?homeCountry=&nationalAsPriority=false", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "number-parser", "parse" ], "query": [ { "description": "ISO 3166 alpha2 code of the home country to be used if it is impossible to determine country from the number itself.\nBy default, this parameter is preset to the current user's home country or brand country if the user is undefined\n", "key": "homeCountry", "value": "" }, { "description": "The default value is `false`. If `true`, the numbers that are\ncloser to the home country are given higher priority\n", "key": "nationalAsPriority", "value": "false" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-595b12c0-a24a-4bf0-a5ff-c1cdadf76b1b" }, { "id": "62798b65-d6de-4ec6-a00d-10bfce4d60b4", "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 \"originalStrings\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/number-parser/parse?homeCountry=&nationalAsPriority=false", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "number-parser", "parse" ], "query": [ { "description": "ISO 3166 alpha2 code of the home country to be used if it is impossible to determine country from the number itself.\nBy default, this parameter is preset to the current user's home country or brand country if the user is undefined\n", "key": "homeCountry", "value": "" }, { "description": "The default value is `false`. If `true`, the numbers that are\ncloser to the home country are given higher priority\n", "key": "nationalAsPriority", "value": "false" } ] } }, "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:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-62798b65-d6de-4ec6-a00d-10bfce4d60b4" } ], "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-47fd0f7a-b6be-4e73-a244-8df676eaa446" } ], "id": "6b1c2286-6281-4d6b-8853-10d61946cfc2", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-6b1c2286-6281-4d6b-8853-10d61946cfc2" } ], "id": "451931ca-74ec-472a-a491-297fbe0a6396", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-451931ca-74ec-472a-a491-297fbe0a6396" } ], "id": "b0785130-4545-4a70-acb0-bccbb717a656", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-b0785130-4545-4a70-acb0-bccbb717a656" } ], "id": "9cd1aae0-0967-435f-9986-0d56ca3bee70", "createdAt": "2026-07-28T02:50:26.000Z", "updatedAt": "2026-07-28T02:50:26.000Z", "uid": "35240-9cd1aae0-0967-435f-9986-0d56ca3bee70" } ], "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" } ] }