{ "info": { "_postman_id": "3acd4e6e-e678-4d6f-9b6f-b79de51dfbab", "name": "RingCentral Adaptive Cards Fax 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:49:25.000Z", "updatedAt": "2026-07-28T02:49:25.000Z", "lastUpdatedBy": "35240", "uid": "35240-3acd4e6e-e678-4d6f-9b6f-b79de51dfbab" }, "item": [ { "name": "restapi", "item": [ { "name": "v1.0", "item": [ { "name": "account", "item": [ { "name": "{accountId}", "item": [ { "name": "extension", "item": [ { "name": "{extensionId}", "item": [ { "name": "fax", "item": [ { "name": "Create Fax Message", "id": "7a0e497a-1e96-4a95-b7a9-5acb7ef7f6ba", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) File to upload", "key": "attachment", "type": "file", "value": null }, { "description": "(Required) Recipient's phone number(s)", "key": "to", "value": "[object Object],[object Object]", "type": "text" }, { "description": "Fax only. Resolution of a fax message. 'High' for black and\nwhite image scanned at 200 dpi, 'Low' for black and white image scanned\nat 100 dpi\n (This can only be one of High,Low)", "key": "faxResolution", "value": "Low", "type": "text" }, { "description": "Timestamp to send a fax at. If not specified, current or the past\na fax message is sent immediately\n", "key": "sendTime", "value": "", "type": "text" }, { "description": "Alpha-2 ISO Code of a country", "key": "isoCode", "value": "", "type": "text" }, { "description": "Cover page identifier. If `coverIndex` is set to '0' (zero) a cover page\nis not attached. For a list of available cover page identifiers (1-13)\nplease call the Fax Cover Pages method. If not specified, the default cover\npage is attached (which is configured in 'Outbound Fax Settings')\n", "key": "coverIndex", "value": "", "type": "text" }, { "description": "Cover page text, entered by a fax sender and printed\non a cover page. Maximum length is limited to 1024 symbols\n", "key": "coverPageText", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/extension/:extensionId/fax", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "extension", ":extensionId", "fax" ], "variable": [ { "id": "1494f62c-c114-40d1-b247-454409629753", "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": "7672f8f2-232e-4fce-8aa7-f1b13f90f42f", "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": "Creates and sends/re-sends a fax message. Re-send can be implemented\nif sending has failed. Fax attachment size (both single and total) is\nlimited to 50Mb.\n" }, "response": [ { "id": "4362bce0-d2d4-4d60-8e44-e5e4c39af104", "name": "Fax message", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart/form-data" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "formdata", "formdata": [ { "description": "(Required) File to upload", "key": "attachment", "type": "file" }, { "description": "(Required) Recipient's phone number(s)", "key": "to", "value": "[object Object],[object Object]", "type": "text" }, { "description": "Fax only. Resolution of a fax message. 'High' for black and\nwhite image scanned at 200 dpi, 'Low' for black and white image scanned\nat 100 dpi\n (This can only be one of High,Low)", "key": "faxResolution", "value": "Low", "type": "text" }, { "description": "Timestamp to send a fax at. If not specified, current or the past\na fax message is sent immediately\n", "key": "sendTime", "value": "", "type": "text" }, { "description": "Alpha-2 ISO Code of a country", "key": "isoCode", "value": "", "type": "text" }, { "description": "Cover page identifier. If `coverIndex` is set to '0' (zero) a cover page\nis not attached. For a list of available cover page identifiers (1-13)\nplease call the Fax Cover Pages method. If not specified, the default cover\npage is attached (which is configured in 'Outbound Fax Settings')\n", "key": "coverIndex", "value": "", "type": "text" }, { "description": "Cover page text, entered by a fax sender and printed\non a cover page. Maximum length is limited to 1024 symbols\n", "key": "coverPageText", "value": "", "type": "text" } ] }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/extension/:extensionId/fax", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "extension", ":extensionId", "fax" ], "variable": [ { "key": "accountId" }, { "key": "extensionId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"uri\": \"\",\n \"type\": \"Fax\",\n \"from\": {\n \"extensionNumber\": \"\",\n \"extensionId\": \"\",\n \"location\": \"\",\n \"name\": \"\",\n \"phoneNumber\": \"\"\n },\n \"to\": [\n {\n \"recipientId\": \"\",\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"messageStatus\": \"SendingFailed\",\n \"location\": \"\"\n },\n {\n \"recipientId\": \"\",\n \"phoneNumber\": \"\",\n \"name\": \"\",\n \"messageStatus\": \"DeliveryFailed\",\n \"location\": \"\"\n }\n ],\n \"creationTime\": \"\",\n \"readStatus\": \"Read\",\n \"priority\": \"Normal\",\n \"attachments\": [\n {\n \"id\": \"\",\n \"uri\": \"\",\n \"type\": \"MmsAttachment\",\n \"contentType\": \"\",\n \"filename\": \"\",\n \"size\": \"\"\n },\n {\n \"id\": \"\",\n \"uri\": \"\",\n \"type\": \"AudioRecording\",\n \"contentType\": \"\",\n \"filename\": \"\",\n \"size\": \"\"\n }\n ],\n \"direction\": \"Outbound\",\n \"availability\": \"Alive\",\n \"messageStatus\": \"Received\",\n \"faxResolution\": \"High\",\n \"faxPageCount\": \"\",\n \"lastModifiedTime\": \"\",\n \"coverIndex\": \"\",\n \"coverPageText\": \"\"\n}", "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-4362bce0-d2d4-4d60-8e44-e5e4c39af104" } ], "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-7a0e497a-1e96-4a95-b7a9-5acb7ef7f6ba" } ], "id": "a913d513-71a4-456d-9d24-499436ebd7cb", "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-a913d513-71a4-456d-9d24-499436ebd7cb" } ], "id": "9b394868-fc4d-469e-b4d7-6c84202ec59f", "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-9b394868-fc4d-469e-b4d7-6c84202ec59f" } ], "id": "48bcda2c-dda8-457b-8682-9af11a7644ac", "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-48bcda2c-dda8-457b-8682-9af11a7644ac" } ], "id": "a9f3cd43-3d13-4592-aaf4-dc826863f62f", "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-a9f3cd43-3d13-4592-aaf4-dc826863f62f" } ], "id": "f38cd7e5-d603-4bc3-bfb3-90da0b94df62", "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-f38cd7e5-d603-4bc3-bfb3-90da0b94df62" }, { "name": "dictionary", "item": [ { "name": "fax-cover-page", "item": [ { "name": "List Fax Cover Pages", "id": "98c32090-d726-4e60-9589-e1aa2876c374", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/dictionary/fax-cover-page?page=1&perPage=100", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "dictionary", "fax-cover-page" ], "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": "Returns fax cover pages available for the current extension." }, "response": [ { "id": "e492f98b-d0d7-412b-b089-ba976bd84db3", "name": "List of fax cover pages", "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/dictionary/fax-cover-page?page=1&perPage=100", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "dictionary", "fax-cover-page" ], "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" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"uri\": \"\",\n \"records\": [\n {\n \"id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"name\": \"\"\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:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-e492f98b-d0d7-412b-b089-ba976bd84db3" } ], "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-98c32090-d726-4e60-9589-e1aa2876c374" } ], "id": "f4b3cd6d-caed-4fb6-8524-fc08f1e6c43f", "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-f4b3cd6d-caed-4fb6-8524-fc08f1e6c43f" } ], "id": "381c4e86-ac03-4268-a864-d4a5c571d290", "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-381c4e86-ac03-4268-a864-d4a5c571d290" } ], "id": "42b7f458-6881-44ca-9d34-8d49a7d32417", "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-42b7f458-6881-44ca-9d34-8d49a7d32417" } ], "id": "43fa03d8-632e-4b01-b94c-1b6adf5f0299", "createdAt": "2026-07-28T02:49:26.000Z", "updatedAt": "2026-07-28T02:49:26.000Z", "uid": "35240-43fa03d8-632e-4b01-b94c-1b6adf5f0299" } ], "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" } ] }