{ "info": { "_postman_id": "75909ec8-0c9f-40cd-aa6f-e2643f6d255d", "name": "RingCentral Adaptive Cards High Volume SMS 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:28.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "lastUpdatedBy": "35240", "uid": "35240-75909ec8-0c9f-40cd-aa6f-e2643f6d255d" }, "item": [ { "name": "restapi", "item": [ { "name": "v1.0", "item": [ { "name": "account", "item": [ { "name": "{accountId}", "item": [ { "name": "a2p-sms", "item": [ { "name": "statuses", "item": [ { "name": "List A2P SMS Statuses", "id": "355e522c-9c15-4823-9188-5fd4f792bdc4", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/statuses?batchId=&direction=Outbound&dateFrom=&dateTo=&phoneNumber=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "statuses" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "key": "phoneNumber", "value": "" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "key": "phoneNumber", "value": "" } ], "variable": [ { "id": "c58dd5a2-6c9c-47d3-8bbb-958118a7792e", "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": "Retrieves a set of message counts by message status and error codes filtered by dates, batchId and message direction." }, "response": [ { "id": "2e000d9b-273d-415b-82d5-6e924807990e", "name": "The statuses of the messages sent by the account filtered by criteria specified in the query", "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/a2p-sms/statuses?batchId=&direction=Outbound&dateFrom=&dateTo=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "statuses" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "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 \"queued\": {\n \"cost\": \"\",\n \"count\": \"\",\n \"errorCodeCounts\": {\n \"cillum_a\": \"\",\n \"dolor_c91\": \"\",\n \"mollit43\": \"\"\n }\n },\n \"delivered\": {\n \"cost\": \"\",\n \"count\": \"\",\n \"errorCodeCounts\": {\n \"dolore4\": \"\",\n \"in49\": \"\",\n \"dolor_48a\": \"\",\n \"in_f\": \"\",\n \"laborumaa\": \"\"\n }\n },\n \"deliveryFailed\": {\n \"cost\": \"\",\n \"count\": \"\",\n \"errorCodeCounts\": {\n \"eiusmod_4\": \"\",\n \"inb4\": \"\"\n }\n },\n \"sent\": {\n \"cost\": \"\",\n \"count\": \"\",\n \"errorCodeCounts\": {\n \"nulla_d6c\": \"\",\n \"ince2\": \"\"\n }\n },\n \"sendingFailed\": {\n \"cost\": \"\",\n \"count\": \"\",\n \"errorCodeCounts\": {\n \"incididuntf4\": \"\",\n \"reprehenderit_7d\": \"\"\n }\n }\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-2e000d9b-273d-415b-82d5-6e924807990e" }, { "id": "2338c81b-c614-43c8-ade3-2e793b156910", "name": "Invalid request", "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/a2p-sms/statuses?batchId=&direction=Outbound&dateFrom=&dateTo=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "statuses" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "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 \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-2338c81b-c614-43c8-ade3-2e793b156910" }, { "id": "066c8d1e-d82e-4943-9415-c45c43198b5f", "name": "Unauthorized", "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/a2p-sms/statuses?batchId=&direction=Outbound&dateFrom=&dateTo=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "statuses" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "key": "phoneNumber", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-066c8d1e-d82e-4943-9415-c45c43198b5f" }, { "id": "6350a7bd-41b8-4c33-bd29-a65ea466485b", "name": "No resource found for the account", "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/a2p-sms/statuses?batchId=&direction=Outbound&dateFrom=&dateTo=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "statuses" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "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 \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-6350a7bd-41b8-4c33-bd29-a65ea466485b" }, { "id": "93f7b65c-dc7a-46ac-861e-c33970d9f534", "name": "Service Unavailable", "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/a2p-sms/statuses?batchId=&direction=Outbound&dateFrom=&dateTo=&phoneNumber=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "statuses" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "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 \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-93f7b65c-dc7a-46ac-861e-c33970d9f534" } ], "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-355e522c-9c15-4823-9188-5fd4f792bdc4" } ], "id": "9eb0d0bf-5ccf-4b3e-b04e-f839dbd616e8", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-9eb0d0bf-5ccf-4b3e-b04e-f839dbd616e8" }, { "name": "messages", "item": [ { "name": "{messageId}", "item": [ { "name": "Get A2P SMS", "id": "dfedee4e-e850-46a0-8192-a9d2037f5145", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages", ":messageId" ], "variable": [ { "id": "c2e37f75-cb41-420c-9c42-a01b1498bacd", "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": "464fe157-df0f-4d73-b657-86e37707d6e0", "key": "messageId", "value": "", "description": "(Required) Internal identifier of a message to be retrieved" } ] }, "description": "Returns the details of an A2P SMS message by ID." }, "response": [ { "id": "8de95679-76a1-43cb-97f4-1fb865c48ff9", "name": "The message is found and returned", "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/a2p-sms/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages", ":messageId" ], "variable": [ { "key": "accountId" }, { "key": "messageId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"from\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\",\n \"creationTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"messageStatus\": \"Queued\",\n \"segmentCount\": \"\",\n \"cost\": \"\",\n \"batchId\": \"\",\n \"direction\": \"Outbound\",\n \"errorCode\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-8de95679-76a1-43cb-97f4-1fb865c48ff9" }, { "id": "0247a163-904d-4eba-9f83-feee2a2a715e", "name": "Invalid request", "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/a2p-sms/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages", ":messageId" ], "variable": [ { "key": "accountId" }, { "key": "messageId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-0247a163-904d-4eba-9f83-feee2a2a715e" }, { "id": "7950f382-6f20-465c-bdda-1161e066684c", "name": "Unauthorized error", "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/a2p-sms/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages", ":messageId" ], "variable": [ { "key": "accountId" }, { "key": "messageId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-7950f382-6f20-465c-bdda-1161e066684c" }, { "id": "c4a3f48d-a76c-475e-a405-5f290c33495d", "name": "The message is not found", "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/a2p-sms/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages", ":messageId" ], "variable": [ { "key": "accountId" }, { "key": "messageId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-c4a3f48d-a76c-475e-a405-5f290c33495d" }, { "id": "14c50bc7-2ac2-4dd8-8bfe-8dd383a6fb7b", "name": "Service is not available", "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/a2p-sms/messages/:messageId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages", ":messageId" ], "variable": [ { "key": "accountId" }, { "key": "messageId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-14c50bc7-2ac2-4dd8-8bfe-8dd383a6fb7b" } ], "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-dfedee4e-e850-46a0-8192-a9d2037f5145" } ], "id": "00afd094-7e38-46d1-af9a-22a56d2d5658", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-00afd094-7e38-46d1-af9a-22a56d2d5658" }, { "name": "List A2P SMS Messages", "id": "ab4cfc43-9ba2-4c3a-8d56-0ae1b00f5177", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/messages?batchId=&direction=Outbound&dateFrom=&dateTo=&view=Simple&phoneNumber=&phoneNumber=&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Indicates if the response has to be detailed, includes text in the response if detailed", "key": "view", "value": "Simple" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "key": "phoneNumber", "value": "" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "key": "phoneNumber", "value": "" }, { "description": "The page token of the page to be retrieved.", "key": "pageToken", "value": "" }, { "description": "The number of messages to be returned per request", "key": "perPage", "value": "1000" } ], "variable": [ { "id": "6365b7b7-51a5-48e0-ac6c-7e6eeec9a812", "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 outbound/inbound A2P messages sent from/to A2P phone numbers of the current account. The list can be filtered by message batch ID and/or phone number." }, "response": [ { "id": "85c70f0f-3655-4264-b3a3-48bfd8882251", "name": "The list of messages sent by the account and filtered by the criteria specified in the query parameters\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/messages?batchId=&direction=Outbound&dateFrom=&dateTo=&view=Simple&phoneNumber=&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Indicates if the response has to be detailed, includes text in the response if detailed", "key": "view", "value": "Simple" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "key": "phoneNumber", "value": "" }, { "description": "The page token of the page to be retrieved.", "key": "pageToken", "value": "" }, { "description": "The number of messages to be returned per request", "key": "perPage", "value": "1000" } ], "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\": \"\",\n \"batchId\": \"\",\n \"from\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"creationTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"messageStatus\": \"Sent\",\n \"segmentCount\": \"\",\n \"text\": \"\",\n \"cost\": \"\",\n \"direction\": \"Inbound\",\n \"errorCode\": \"\"\n },\n {\n \"id\": \"\",\n \"batchId\": \"\",\n \"from\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"creationTime\": \"\",\n \"lastModifiedTime\": \"\",\n \"messageStatus\": \"SendingFailed\",\n \"segmentCount\": \"\",\n \"text\": \"\",\n \"cost\": \"\",\n \"direction\": \"Outbound\",\n \"errorCode\": \"\"\n }\n ],\n \"paging\": {\n \"pageToken\": \"\",\n \"perPage\": \"\",\n \"firstPageToken\": \"\",\n \"previousPageToken\": \"\",\n \"nextPageToken\": \"\"\n }\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-85c70f0f-3655-4264-b3a3-48bfd8882251" }, { "id": "21a9c805-d45c-4c93-b8dd-2b0a0e9521c1", "name": "Invalid Request", "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/a2p-sms/messages?batchId=&direction=Outbound&dateFrom=&dateTo=&view=Simple&phoneNumber=&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Indicates if the response has to be detailed, includes text in the response if detailed", "key": "view", "value": "Simple" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "key": "phoneNumber", "value": "" }, { "description": "The page token of the page to be retrieved.", "key": "pageToken", "value": "" }, { "description": "The number of messages to be returned per request", "key": "perPage", "value": "1000" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-21a9c805-d45c-4c93-b8dd-2b0a0e9521c1" }, { "id": "e03e9474-dcf0-4783-bf9e-c40428563d51", "name": "Unauthorized", "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/a2p-sms/messages?batchId=&direction=Outbound&dateFrom=&dateTo=&view=Simple&phoneNumber=&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Indicates if the response has to be detailed, includes text in the response if detailed", "key": "view", "value": "Simple" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "key": "phoneNumber", "value": "" }, { "description": "The page token of the page to be retrieved.", "key": "pageToken", "value": "" }, { "description": "The number of messages to be returned per request", "key": "perPage", "value": "1000" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-e03e9474-dcf0-4783-bf9e-c40428563d51" }, { "id": "136ce6b6-7a96-445f-a5d2-faf70539e734", "name": "No resource found for the account.", "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/a2p-sms/messages?batchId=&direction=Outbound&dateFrom=&dateTo=&view=Simple&phoneNumber=&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Indicates if the response has to be detailed, includes text in the response if detailed", "key": "view", "value": "Simple" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "key": "phoneNumber", "value": "" }, { "description": "The page token of the page to be retrieved.", "key": "pageToken", "value": "" }, { "description": "The number of messages to be returned per request", "key": "perPage", "value": "1000" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-136ce6b6-7a96-445f-a5d2-faf70539e734" }, { "id": "900d7048-a5f9-4161-8e5f-ae45ada728fa", "name": "Internal Server Error", "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/a2p-sms/messages?batchId=&direction=Outbound&dateFrom=&dateTo=&view=Simple&phoneNumber=&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "messages" ], "query": [ { "description": "Internal identifier of a message batch to filter the response", "key": "batchId", "value": "" }, { "description": "Direction of a message to filter the message list result.\nBy default, there is no filter applied - both Inbound and Outbound messages are returned\n", "key": "direction", "value": "Outbound" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Indicates if the response has to be detailed, includes text in the response if detailed", "key": "view", "value": "Simple" }, { "description": "List of phone numbers (specified in 'to' or 'from' fields of a message) to filter the results. Maximum number of phone numbers allowed to be specified as filters is 15", "key": "phoneNumber", "value": "" }, { "description": "The page token of the page to be retrieved.", "key": "pageToken", "value": "" }, { "description": "The number of messages to be returned per request", "key": "perPage", "value": "1000" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-900d7048-a5f9-4161-8e5f-ae45ada728fa" } ], "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-ab4cfc43-9ba2-4c3a-8d56-0ae1b00f5177" } ], "id": "18e2c1f8-5d1f-42ed-a9a3-1588fcc0d252", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-18e2c1f8-5d1f-42ed-a9a3-1588fcc0d252" }, { "name": "opt-outs", "item": [ { "name": "bulk-assign", "item": [ { "name": "Add Opt-In/Out Numbers", "id": "115d365e-7369-400c-9fb2-1319c05a7ade", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"optOuts\": [\n \"\",\n \"\"\n ],\n \"optIns\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/opt-outs/bulk-assign", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "opt-outs", "bulk-assign" ], "variable": [ { "id": "45d8efdc-2556-494e-b6c2-924500ce552d", "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 multiple opt-outs and/or opt-ins for the specified sender number and a set of recipient numbers.\n" }, "response": [ { "id": "b41f01ff-9c1c-4b6f-acf4-abf2158410f3", "name": "The results of adding opt-outs and opt-ins.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"optOuts\": [\n \"\",\n \"\"\n ],\n \"optIns\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/opt-outs/bulk-assign", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "opt-outs", "bulk-assign" ], "variable": [ { "key": "accountId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"optIns\": {\n \"successful\": [\n \"\",\n \"\"\n ],\n \"failed\": [\n {\n \"to\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"to\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n },\n \"optOuts\": {\n \"successful\": [\n \"\",\n \"\"\n ],\n \"failed\": [\n {\n \"to\": \"\",\n \"errorMessage\": \"\"\n },\n {\n \"to\": \"\",\n \"errorMessage\": \"\"\n }\n ]\n }\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-b41f01ff-9c1c-4b6f-acf4-abf2158410f3" }, { "id": "c4dba548-32b6-4a36-9409-748c673a4f50", "name": "Invalid Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"optOuts\": [\n \"\",\n \"\"\n ],\n \"optIns\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/opt-outs/bulk-assign", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "opt-outs", "bulk-assign" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-c4dba548-32b6-4a36-9409-748c673a4f50" }, { "id": "0039fdf3-68fb-4037-87bb-41ec4aee940b", "name": "Service Unavailable", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"optOuts\": [\n \"\",\n \"\"\n ],\n \"optIns\": [\n \"\",\n \"\"\n ]\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/opt-outs/bulk-assign", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "opt-outs", "bulk-assign" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-0039fdf3-68fb-4037-87bb-41ec4aee940b" } ], "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-115d365e-7369-400c-9fb2-1319c05a7ade" } ], "id": "11e9b64d-9b29-4d19-b706-819bca85431b", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-11e9b64d-9b29-4d19-b706-819bca85431b" }, { "name": "List Opted Out Numbers", "id": "2a110c4e-6b81-4866-a944-57d847bf59ac", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/opt-outs?from=&to=&status=optout&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "opt-outs" ], "query": [ { "description": "The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages.\nThe asterisk value \"*\" means any number in `from` field\n", "key": "from", "value": "" }, { "description": "The receiver's phone number (`to` field) in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages\n", "key": "to", "value": "" }, { "description": "The status (opted out, opted in, or both) to be used as the filter", "key": "status", "value": "optout" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned for the page", "key": "perPage", "value": "1000" } ], "variable": [ { "id": "896a6452-45d8-47f4-a1ab-2e5ead1d24f8", "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 numbers opted out from the account. The list\ncan be filtered by `to`/`from` phone number query parameters. Specifying `text/csv`\nin the `Accept` header lets download the data in the CSV format.\n" }, "response": [ { "id": "3cf62f0e-9812-43e1-a4e6-f50deb22d64d", "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/v1.0/account/:accountId/a2p-sms/opt-outs?from=&to=&status=optout&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "opt-outs" ], "query": [ { "description": "The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages.\nThe asterisk value \"*\" means any number in `from` field\n", "key": "from", "value": "" }, { "description": "The receiver's phone number (`to` field) in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages\n", "key": "to", "value": "" }, { "description": "The status (opted out, opted in, or both) to be used as the filter", "key": "status", "value": "optout" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned for the page", "key": "perPage", "value": "1000" } ], "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 \"from\": \"\",\n \"to\": \"\",\n \"status\": \"OptOut\",\n \"source\": \"Recipient\"\n },\n {\n \"from\": \"\",\n \"to\": \"\",\n \"status\": \"OptIn\",\n \"source\": \"Recipient\"\n }\n ],\n \"paging\": {\n \"pageToken\": \"\",\n \"perPage\": \"\",\n \"firstPageToken\": \"\",\n \"previousPageToken\": \"\",\n \"nextPageToken\": \"\"\n }\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-3cf62f0e-9812-43e1-a4e6-f50deb22d64d" }, { "id": "d224013f-d3cd-4d4f-879e-d6bcf713bcfd", "name": "Invalid Request", "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/a2p-sms/opt-outs?from=&to=&status=optout&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "opt-outs" ], "query": [ { "description": "The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages.\nThe asterisk value \"*\" means any number in `from` field\n", "key": "from", "value": "" }, { "description": "The receiver's phone number (`to` field) in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages\n", "key": "to", "value": "" }, { "description": "The status (opted out, opted in, or both) to be used as the filter", "key": "status", "value": "optout" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned for the page", "key": "perPage", "value": "1000" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-d224013f-d3cd-4d4f-879e-d6bcf713bcfd" }, { "id": "bdbac1f4-58e1-429e-b5ae-fbc902b05231", "name": "Unauthorized", "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/a2p-sms/opt-outs?from=&to=&status=optout&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "opt-outs" ], "query": [ { "description": "The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages.\nThe asterisk value \"*\" means any number in `from` field\n", "key": "from", "value": "" }, { "description": "The receiver's phone number (`to` field) in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages\n", "key": "to", "value": "" }, { "description": "The status (opted out, opted in, or both) to be used as the filter", "key": "status", "value": "optout" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned for the page", "key": "perPage", "value": "1000" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-bdbac1f4-58e1-429e-b5ae-fbc902b05231" }, { "id": "109d3a71-2c91-49a2-a375-78909d9a9c78", "name": "No resource found for the account", "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/a2p-sms/opt-outs?from=&to=&status=optout&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "opt-outs" ], "query": [ { "description": "The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages.\nThe asterisk value \"*\" means any number in `from` field\n", "key": "from", "value": "" }, { "description": "The receiver's phone number (`to` field) in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages\n", "key": "to", "value": "" }, { "description": "The status (opted out, opted in, or both) to be used as the filter", "key": "status", "value": "optout" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned for the page", "key": "perPage", "value": "1000" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-109d3a71-2c91-49a2-a375-78909d9a9c78" }, { "id": "d397e3b9-06de-4d52-a259-590992669103", "name": "Service Unavailable", "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/a2p-sms/opt-outs?from=&to=&status=optout&pageToken=&perPage=1000", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "opt-outs" ], "query": [ { "description": "The sender's phone number in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages.\nThe asterisk value \"*\" means any number in `from` field\n", "key": "from", "value": "" }, { "description": "The receiver's phone number (`to` field) in [E.164](https://www.itu.int/rec/T-REC-E.164-201011-I) format for filtering messages\n", "key": "to", "value": "" }, { "description": "The status (opted out, opted in, or both) to be used as the filter", "key": "status", "value": "optout" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned for the page", "key": "perPage", "value": "1000" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-d397e3b9-06de-4d52-a259-590992669103" } ], "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-2a110c4e-6b81-4866-a944-57d847bf59ac" } ], "id": "99e6fe34-dcdb-4167-96f4-4631dc0f0e56", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-99e6fe34-dcdb-4167-96f4-4631dc0f0e56" }, { "name": "batches", "item": [ { "name": "{batchId}", "item": [ { "name": "Get A2P SMS Batch", "id": "79d37d4a-43ca-47c0-b992-f11461291adf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/batches/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches", ":batchId" ], "variable": [ { "id": "d4b5e55c-fe24-473a-a600-165fcf3793b9", "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": "0391ff04-c2c8-41a7-9381-bb14b630ce13", "key": "batchId", "value": "", "description": "(Required) Internal identifier of a message batch to be retrieved" } ] }, "description": "Returns information on a message batch." }, "response": [ { "id": "d064f725-1092-4783-884e-9e4f8f0ef22a", "name": "Message batch 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/a2p-sms/batches/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches", ":batchId" ], "variable": [ { "key": "accountId" }, { "key": "batchId" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"from\": \"\",\n \"batchSize\": \"\",\n \"processedCount\": \"\",\n \"lastModifiedTime\": \"\",\n \"status\": \"Processing\",\n \"creationTime\": \"\",\n \"rejected\": [\n {\n \"index\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"errorCode\": \"\",\n \"description\": \"\"\n },\n {\n \"index\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"errorCode\": \"\",\n \"description\": \"\"\n }\n ],\n \"cost\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-d064f725-1092-4783-884e-9e4f8f0ef22a" }, { "id": "f263d751-c201-49bb-98f5-22851bf9c9b7", "name": "Invalid request", "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/a2p-sms/batches/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches", ":batchId" ], "variable": [ { "key": "accountId" }, { "key": "batchId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-f263d751-c201-49bb-98f5-22851bf9c9b7" }, { "id": "e4422749-f9bd-4c37-931c-b7066c0fe2e3", "name": "Unauthorized error", "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/a2p-sms/batches/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches", ":batchId" ], "variable": [ { "key": "accountId" }, { "key": "batchId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-e4422749-f9bd-4c37-931c-b7066c0fe2e3" }, { "id": "8aa596c0-d9eb-4a09-8122-958a84e1429f", "name": "The batch is not found", "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/a2p-sms/batches/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches", ":batchId" ], "variable": [ { "key": "accountId" }, { "key": "batchId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-8aa596c0-d9eb-4a09-8122-958a84e1429f" }, { "id": "b57bed9d-b981-4d07-b0bc-5bc8625d620a", "name": "Service is unavailable", "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/a2p-sms/batches/:batchId", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches", ":batchId" ], "variable": [ { "key": "accountId" }, { "key": "batchId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-b57bed9d-b981-4d07-b0bc-5bc8625d620a" } ], "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-79d37d4a-43ca-47c0-b992-f11461291adf" } ], "id": "1bca741c-f5ad-470a-b29c-fd1f05e0fa57", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-1bca741c-f5ad-470a-b29c-fd1f05e0fa57" }, { "name": "Send A2P SMS", "id": "dda818df-7961-424b-8aa5-fb9446a68682", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"messages\": [\n {\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\"\n },\n {\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\"\n }\n ],\n \"text\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/batches", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "variable": [ { "id": "17762b6c-23e4-4c11-bb2e-d3f6035cc576", "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": "Allows to send high volume of A2P (Application-to-Person) SMS messages\n(in message batches). Only phone number with the `A2PSmsSender` feature can\nbe used as a sender.\n" }, "response": [ { "id": "6335cf60-bc28-4ae7-82a6-bfd3991e00e5", "name": "Message batch created", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"messages\": [\n {\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\"\n },\n {\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\"\n }\n ],\n \"text\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/batches", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "variable": [ { "key": "accountId" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"from\": \"\",\n \"batchSize\": \"\",\n \"processedCount\": \"\",\n \"lastModifiedTime\": \"\",\n \"status\": \"Processing\",\n \"creationTime\": \"\",\n \"rejected\": [\n {\n \"index\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"errorCode\": \"\",\n \"description\": \"\"\n },\n {\n \"index\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"errorCode\": \"\",\n \"description\": \"\"\n }\n ],\n \"cost\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-6335cf60-bc28-4ae7-82a6-bfd3991e00e5" }, { "id": "3feb8ec9-5743-4355-a5ed-b0eb6c79d407", "name": "Validation Failed, Invalid Request", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"messages\": [\n {\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\"\n },\n {\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\"\n }\n ],\n \"text\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/batches", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-3feb8ec9-5743-4355-a5ed-b0eb6c79d407" }, { "id": "56555610-e99f-4acf-a112-cea23477d1ad", "name": "Unauthorized error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"messages\": [\n {\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\"\n },\n {\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\"\n }\n ],\n \"text\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/batches", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-56555610-e99f-4acf-a112-cea23477d1ad" }, { "id": "d7aef1de-a036-437d-9b00-a8a0096e1f4f", "name": "Internal server error", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "body": { "mode": "raw", "raw": "{\n \"from\": \"\",\n \"messages\": [\n {\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\"\n },\n {\n \"to\": [\n \"\",\n \"\"\n ],\n \"text\": \"\"\n }\n ],\n \"text\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/batches", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "variable": [ { "key": "accountId" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-d7aef1de-a036-437d-9b00-a8a0096e1f4f" } ], "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-dda818df-7961-424b-8aa5-fb9446a68682" }, { "name": "List A2P SMS Batches", "id": "d89f0688-b7c5-4869-bc4e-860c30a8993d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/batches?dateFrom=&dateTo=&from=&status=Processing&status=Sent&pageToken=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "query": [ { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Phone number in E.164 format from which the messages are going to be sent", "key": "from", "value": "" }, { "description": "A list of batch statuses to filter the results", "key": "status", "value": "Processing" }, { "description": "A list of batch statuses to filter the results", "key": "status", "value": "Sent" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned per page", "key": "perPage", "value": "" } ], "variable": [ { "id": "6a177b5e-438e-443f-83ab-abf126754a67", "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 A2P batches sent from the current account.\nThe list can be filtered by message batch ID and/or from phone number.\n" }, "response": [ { "id": "69296044-f3e8-4990-ba5e-e293afea3e72", "name": "The list of batches sent by the account and filtered by the criteria specified in the query parameters\n", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" }, { "description": "Added as a part of security scheme: oauth2", "key": "Authorization", "value": "" } ], "url": { "raw": "{{baseUrl}}/restapi/v1.0/account/:accountId/a2p-sms/batches?dateFrom=&dateTo=&from=&status=Sent&pageToken=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "query": [ { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Phone number in E.164 format from which the messages are going to be sent", "key": "from", "value": "" }, { "description": "A list of batch statuses to filter the results", "key": "status", "value": "Sent" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned per page", "key": "perPage", "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\": \"\",\n \"from\": \"\",\n \"batchSize\": \"\",\n \"processedCount\": \"\",\n \"lastModifiedTime\": \"\",\n \"status\": \"Processing\",\n \"creationTime\": \"\",\n \"rejected\": [\n {\n \"index\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"errorCode\": \"\",\n \"description\": \"\"\n },\n {\n \"index\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"errorCode\": \"\",\n \"description\": \"\"\n }\n ],\n \"cost\": \"\"\n },\n {\n \"id\": \"\",\n \"from\": \"\",\n \"batchSize\": \"\",\n \"processedCount\": \"\",\n \"lastModifiedTime\": \"\",\n \"status\": \"Processing\",\n \"creationTime\": \"\",\n \"rejected\": [\n {\n \"index\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"errorCode\": \"\",\n \"description\": \"\"\n },\n {\n \"index\": \"\",\n \"to\": [\n \"\",\n \"\"\n ],\n \"errorCode\": \"\",\n \"description\": \"\"\n }\n ],\n \"cost\": \"\"\n }\n ],\n \"paging\": {\n \"pageToken\": \"\",\n \"perPage\": \"\",\n \"firstPageToken\": \"\",\n \"previousPageToken\": \"\",\n \"nextPageToken\": \"\"\n }\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-69296044-f3e8-4990-ba5e-e293afea3e72" }, { "id": "c90d5050-90a3-43f1-814d-aef38660ee25", "name": "Invalid Request", "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/a2p-sms/batches?dateFrom=&dateTo=&from=&status=Sent&pageToken=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "query": [ { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Phone number in E.164 format from which the messages are going to be sent", "key": "from", "value": "" }, { "description": "A list of batch statuses to filter the results", "key": "status", "value": "Sent" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned per page", "key": "perPage", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-c90d5050-90a3-43f1-814d-aef38660ee25" }, { "id": "9dbf5b8e-eb48-411e-9c8b-ef397fc0335a", "name": "Unauthorized", "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/a2p-sms/batches?dateFrom=&dateTo=&from=&status=Sent&pageToken=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "query": [ { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Phone number in E.164 format from which the messages are going to be sent", "key": "from", "value": "" }, { "description": "A list of batch statuses to filter the results", "key": "status", "value": "Sent" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned per page", "key": "perPage", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-9dbf5b8e-eb48-411e-9c8b-ef397fc0335a" }, { "id": "f5e84211-ae08-4c2f-82a4-52642a1d4b08", "name": "No resource found for the account.", "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/a2p-sms/batches?dateFrom=&dateTo=&from=&status=Sent&pageToken=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "query": [ { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Phone number in E.164 format from which the messages are going to be sent", "key": "from", "value": "" }, { "description": "A list of batch statuses to filter the results", "key": "status", "value": "Sent" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned per page", "key": "perPage", "value": "" } ], "variable": [ { "key": "accountId" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-f5e84211-ae08-4c2f-82a4-52642a1d4b08" }, { "id": "eb8e5af0-e987-4740-8649-4ac7cf3087a4", "name": "Service Unavailable", "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/a2p-sms/batches?dateFrom=&dateTo=&from=&status=Sent&pageToken=&perPage=", "host": [ "{{baseUrl}}" ], "path": [ "restapi", "v1.0", "account", ":accountId", "a2p-sms", "batches" ], "query": [ { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the 'dateTo' minus 24 hours", "key": "dateFrom", "value": "" }, { "description": "The end of the time range to filter the results in ISO 8601 format including timezone. Default is the current time", "key": "dateTo", "value": "" }, { "description": "Phone number in E.164 format from which the messages are going to be sent", "key": "from", "value": "" }, { "description": "A list of batch statuses to filter the results", "key": "status", "value": "Sent" }, { "description": "The page token of the page to be retrieved", "key": "pageToken", "value": "" }, { "description": "The number of records to be returned per page", "key": "perPage", "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 \"errorCode\": \"\",\n \"message\": \"\"\n}", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-eb8e5af0-e987-4740-8649-4ac7cf3087a4" } ], "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-d89f0688-b7c5-4869-bc4e-860c30a8993d" } ], "id": "1e8ee803-7b5c-4fe8-a457-2c8b0440ae69", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-1e8ee803-7b5c-4fe8-a457-2c8b0440ae69" } ], "id": "9ab11360-89df-4e68-8a13-c0495dfe7f7c", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-9ab11360-89df-4e68-8a13-c0495dfe7f7c" } ], "id": "f7e1c4e0-a062-46c2-bec1-a82b988f1d72", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-f7e1c4e0-a062-46c2-bec1-a82b988f1d72" } ], "id": "cf51cfc8-f0f7-4d0f-9976-b8fd392eb217", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-cf51cfc8-f0f7-4d0f-9976-b8fd392eb217" } ], "id": "7ce7b516-f407-4cc0-bde1-881ee33ca8a0", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-7ce7b516-f407-4cc0-bde1-881ee33ca8a0" } ], "id": "ecaa3c3f-40c5-4737-bc74-d2b26b531489", "createdAt": "2026-07-28T02:49:29.000Z", "updatedAt": "2026-07-28T02:49:29.000Z", "uid": "35240-ecaa3c3f-40c5-4737-bc74-d2b26b531489" } ], "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" } ] }