{ "item": [ { "id": "1bb98083-4265-1180-9924-bc31a1508965", "name": "SMS", "description": { "content": "Send messages and track delivery.", "type": "text/plain" }, "item": [ { "id": "81b7df7a-e038-a54e-3ea5-c6463dd62be1", "name": "Send SMS", "request": { "name": "Send SMS", "description": { "content": "Send an SMS to 1–100 recipients. Requires the `sms.send` permission.\n\nThe request is **atomic**: either every recipient is queued or none is\n(a `500 DB_ERROR` means nothing was sent — safe to retry the whole request).\n", "type": "text/plain" }, "url": { "path": [ "sms", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"+14155551234\",\n \"+447911123456\"\n ],\n \"message\": \"Your verification code is 847291\",\n \"sender_id\": \"MyApp\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "0a8cda99-c53c-7d9d-644d-d02d6ce01d29", "name": "Messages accepted for delivery.", "originalRequest": { "url": { "path": [ "sms", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"+14155551234\",\n \"+447911123456\"\n ],\n \"message\": \"Your verification code is 847291\",\n \"sender_id\": \"MyApp\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": true,\n \"sandbox\": true,\n \"messages\": [\n {\n \"dnis\": \"string\",\n \"message_id\": \"string\",\n \"segment_num\": 2832\n },\n {\n \"dnis\": \"string\",\n \"message_id\": \"string\",\n \"segment_num\": 7564\n }\n ],\n \"results\": [\n {\n \"dnis\": \"string\",\n \"message_id\": \"string\",\n \"segments\": 7681,\n \"status\": \"blocked_country\"\n },\n {\n \"dnis\": \"string\",\n \"message_id\": \"string\",\n \"segments\": 9776,\n \"status\": \"blocked_country\"\n }\n ],\n \"summary\": {\n \"total_recipients\": 1265,\n \"total_segments\": 2361,\n \"total_cost\": 9504.074244759977,\n \"encoding\": \"GSM-7\",\n \"accepted_count\": 6237,\n \"blocked_count\": 9758,\n \"queue_error_count\": 1708,\n \"config_error_count\": 2029,\n \"db_error_count\": 6461\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eac44ca0-fe6b-f03a-545e-1c5764c7315e", "name": "Request validation failed.", "originalRequest": { "url": { "path": [ "sms", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"+14155551234\",\n \"+447911123456\"\n ],\n \"message\": \"Your verification code is 847291\",\n \"sender_id\": \"MyApp\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_TO\",\n \"description\": \"Missing or empty 'to' array\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68d70fd6-33d3-cb17-d84e-39a75ec5481b", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "sms", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"+14155551234\",\n \"+447911123456\"\n ],\n \"message\": \"Your verification code is 847291\",\n \"sender_id\": \"MyApp\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e152034b-638a-5adc-7bf3-4644c2ff7cdb", "name": "Insufficient balance.", "originalRequest": { "url": { "path": [ "sms", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"+14155551234\",\n \"+447911123456\"\n ],\n \"message\": \"Your verification code is 847291\",\n \"sender_id\": \"MyApp\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": true,\n \"error_code\": \"string\",\n \"description\": \"string\",\n \"balance\": 5987.847689539194,\n \"estimated_cost\": 784.3845197930932,\n \"currency\": \"string\",\n \"total_recipients\": 5126,\n \"billable_recipients\": 7356,\n \"segments\": 9112\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eba0927e-23cf-d2a2-2400-a71d9f01b385", "name": "Authenticated but not allowed (permission, route or workspace).", "originalRequest": { "url": { "path": [ "sms", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"+14155551234\",\n \"+447911123456\"\n ],\n \"message\": \"Your verification code is 847291\",\n \"sender_id\": \"MyApp\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": true,\n \"error_code\": \"string\",\n \"description\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "39d3b6e0-dbc3-d67f-b7c6-93996c4c867f", "name": "Rate limit exceeded.", "originalRequest": { "url": { "path": [ "sms", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"+14155551234\",\n \"+447911123456\"\n ],\n \"message\": \"Your verification code is 847291\",\n \"sender_id\": \"MyApp\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"RATE_LIMIT_EXCEEDED\",\n \"description\": \"Too many requests\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a5bf309b-458f-ef7c-5c35-f2fec5446dc6", "name": "Request could not be queued (atomic rollback — nothing was sent).", "originalRequest": { "url": { "path": [ "sms", "send" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"to\": [\n \"+14155551234\",\n \"+447911123456\"\n ],\n \"message\": \"Your verification code is 847291\",\n \"sender_id\": \"MyApp\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": true,\n \"error_code\": \"string\",\n \"description\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6e9ff7b7-3083-cbd5-8859-20ba37cf6fca", "name": "Get message status", "request": { "name": "Get message status", "description": { "content": "Check the delivery status of a sent message. Requires `sms.read`.\nMessage IDs look like `api_42_1743667200123456789_a3f8b2c1d9e45f67`.\n", "type": "text/plain" }, "url": { "path": [ "sms", "status", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "api_42_1743667200123456789_a3f8b2c1d9e45f67", "key": "message_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "87187caa-6212-e992-030a-22bf98572110", "name": "Message found.", "originalRequest": { "url": { "path": [ "sms", "status", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "api_42_1743667200123456789_a3f8b2c1d9e45f67", "key": "message_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"message\": {\n \"message_id\": \"string\",\n \"telecom_message_id\": \"string\",\n \"recipient\": \"string\",\n \"segments\": 1323,\n \"message\": \"string\",\n \"sender_id\": \"string\",\n \"status\": \"UNDELIV\",\n \"status_code\": \"string\",\n \"cost\": 9623.593313153833,\n \"created_at\": \"2026-01-01T00:00:00.000Z\",\n \"delivered_at\": \"2026-01-01T00:00:00.000Z\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "908500f6-a314-b879-3a30-7bdb3addbc8a", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "sms", "status", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "api_42_1743667200123456789_a3f8b2c1d9e45f67", "key": "message_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cb73a95-ef56-e5ad-1a23-25a09df56214", "name": "Message not found (or belongs to another account).", "originalRequest": { "url": { "path": [ "sms", "status", ":message_id" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "api_42_1743667200123456789_a3f8b2c1d9e45f67", "key": "message_id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": true,\n \"error_code\": \"string\",\n \"description\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "b378328d-87b5-e239-4b65-57f92ff393ce", "name": "Statistics", "description": { "content": "Aggregate, daily and per-country statistics.", "type": "text/plain" }, "item": [ { "id": "91bc5243-ba57-beec-71e2-64a771703dc5", "name": "Get statistics", "request": { "name": "Get statistics", "description": { "content": "Aggregate SMS statistics for a period. Requires `sms.read`.", "type": "text/plain" }, "url": { "path": [ "sms", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "period", "value": "7d", "description": "Named period preset. Takes precedence over `from`/`to`." }, { "disabled": false, "key": "from", "value": "1993-06-08", "description": "Start date `YYYY-MM-DD`. Use only when `period` is omitted." }, { "disabled": false, "key": "to", "value": "1993-06-08", "description": "End date `YYYY-MM-DD`, inclusive. Use only when `period` is omitted." }, { "disabled": false, "key": "source", "value": "api", "description": "Traffic source filter." }, { "disabled": false, "key": "country", "value": "string", "description": "ISO 3166-1 alpha-2 code: `US`, `GB`, …" }, { "disabled": false, "key": "sender", "value": "string", "description": "Filter by sender ID." }, { "disabled": false, "key": "phone", "value": "string", "description": "Search by phone number (substring)." }, { "disabled": false, "key": "status", "value": "unknown", "description": "Delivery status filter." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "ebcd63d0-c755-88c1-17c4-d249f16a01b3", "name": "Aggregate statistics.", "originalRequest": { "url": { "path": [ "sms", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" }, { "key": "source", "value": "api" }, { "key": "country", "value": "string" }, { "key": "sender", "value": "string" }, { "key": "phone", "value": "string" }, { "key": "status", "value": "unknown" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": true,\n \"stats\": {\n \"total_sent\": 235,\n \"sent\": 3574,\n \"delivered\": 9194,\n \"undelivered\": 9122,\n \"pending\": 8186,\n \"expired\": 9738,\n \"not_billed\": 8511,\n \"failed\": 5744,\n \"click_count\": 6948,\n \"unique_click_count\": 2332,\n \"action_count\": 2148,\n \"sent_rate\": 7140.251635573804,\n \"delivery_rate\": 6081.923563033342,\n \"total_cost\": 1069.1171744838357,\n \"avg_cost_per_msg\": 5059.770485386252,\n \"currency\": \"string\"\n },\n \"period\": {\n \"from\": \"1989-10-23\",\n \"to\": \"1979-09-08\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fa894924-81b1-94fa-e6fc-951acaa10668", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "sms", "stats" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" }, { "key": "source", "value": "api" }, { "key": "country", "value": "string" }, { "key": "sender", "value": "string" }, { "key": "phone", "value": "string" }, { "key": "status", "value": "unknown" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "062c8eba-ac34-8a46-c6d7-dfcc7c550491", "name": "Get daily statistics", "request": { "name": "Get daily statistics", "description": { "content": "Day-by-day breakdown for charts, sorted by date ascending.\nWith `granularity=auto` on a single-day range, buckets are hourly.\nRequires `sms.read`.\n", "type": "text/plain" }, "url": { "path": [ "sms", "stats", "daily" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "period", "value": "7d", "description": "Named period preset. Takes precedence over `from`/`to`." }, { "disabled": false, "key": "from", "value": "1993-06-08", "description": "Start date `YYYY-MM-DD`. Use only when `period` is omitted." }, { "disabled": false, "key": "to", "value": "1993-06-08", "description": "End date `YYYY-MM-DD`, inclusive. Use only when `period` is omitted." }, { "disabled": false, "key": "source", "value": "api", "description": "Traffic source filter." }, { "disabled": false, "key": "granularity", "value": "auto", "description": "`auto` switches to hourly buckets on a single-day range." }, { "disabled": false, "key": "countries", "value": "string", "description": "Comma-separated ISO codes: `US,GB,DE`. Changes sort to descending." }, { "disabled": false, "key": "country", "value": "string", "description": "ISO 3166-1 alpha-2 code: `US`, `GB`, …" }, { "disabled": false, "key": "sender", "value": "string", "description": "Filter by sender ID." }, { "disabled": false, "key": "phone", "value": "string", "description": "Search by phone number (substring)." }, { "disabled": false, "key": "status", "value": "unknown", "description": "Delivery status filter." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "506e4fb8-9c04-d8eb-dfdd-a2a7165b86a7", "name": "Daily statistics.", "originalRequest": { "url": { "path": [ "sms", "stats", "daily" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" }, { "key": "source", "value": "api" }, { "key": "granularity", "value": "auto" }, { "key": "countries", "value": "string" }, { "key": "country", "value": "string" }, { "key": "sender", "value": "string" }, { "key": "phone", "value": "string" }, { "key": "status", "value": "unknown" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"daily_stats\": [\n {\n \"date\": \"string\",\n \"sent\": 7185,\n \"delivered\": 6769,\n \"undelivered\": 7157,\n \"pending\": 345,\n \"expired\": 2796,\n \"not_billed\": 6876,\n \"failed\": 7658,\n \"click_count\": 139,\n \"cost\": 2399.6219923719764,\n \"currency\": \"string\"\n },\n {\n \"date\": \"string\",\n \"sent\": 3289,\n \"delivered\": 2453,\n \"undelivered\": 4523,\n \"pending\": 8652,\n \"expired\": 8214,\n \"not_billed\": 2035,\n \"failed\": 4387,\n \"click_count\": 9924,\n \"cost\": 2243.970697745681,\n \"currency\": \"string\"\n }\n ],\n \"period\": {\n \"from\": \"2013-04-26\",\n \"to\": \"2016-06-03\"\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e4b96676-6a6d-fee0-bbc6-b7a443793ba0", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "sms", "stats", "daily" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" }, { "key": "source", "value": "api" }, { "key": "granularity", "value": "auto" }, { "key": "countries", "value": "string" }, { "key": "country", "value": "string" }, { "key": "sender", "value": "string" }, { "key": "phone", "value": "string" }, { "key": "status", "value": "unknown" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "a70ac688-b659-a11e-3fc6-df0d8d00bce8", "name": "Get country statistics", "request": { "name": "Get country statistics", "description": { "content": "Statistics grouped by destination country, sorted by total_sent descending. Requires `sms.read`.", "type": "text/plain" }, "url": { "path": [ "sms", "stats", "by-country" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "period", "value": "7d", "description": "Named period preset. Takes precedence over `from`/`to`." }, { "disabled": false, "key": "from", "value": "1993-06-08", "description": "Start date `YYYY-MM-DD`. Use only when `period` is omitted." }, { "disabled": false, "key": "to", "value": "1993-06-08", "description": "End date `YYYY-MM-DD`, inclusive. Use only when `period` is omitted." }, { "disabled": false, "key": "source", "value": "api", "description": "Traffic source filter." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "91b80fed-2b26-16ef-2702-3a9be728937f", "name": "Per-country statistics.", "originalRequest": { "url": { "path": [ "sms", "stats", "by-country" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" }, { "key": "source", "value": "api" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": true,\n \"countries\": [\n {\n \"country\": \"string\",\n \"country_code\": \"string\",\n \"country_flag\": \"string\",\n \"total_sent\": 9936,\n \"sent\": 1664,\n \"delivered\": 4737,\n \"undelivered\": 5207,\n \"pending\": 8482,\n \"expired\": 5602,\n \"not_billed\": 138,\n \"failed\": 1644,\n \"click_count\": 2218,\n \"delivery_rate\": 38.16333832219243,\n \"cost\": 3237.6607856713235,\n \"currency\": \"string\"\n },\n {\n \"country\": \"string\",\n \"country_code\": \"string\",\n \"country_flag\": \"string\",\n \"total_sent\": 6548,\n \"sent\": 56,\n \"delivered\": 1361,\n \"undelivered\": 1117,\n \"pending\": 4830,\n \"expired\": 3900,\n \"not_billed\": 7233,\n \"failed\": 9072,\n \"click_count\": 89,\n \"delivery_rate\": 8110.582327935845,\n \"cost\": 7657.849348615855,\n \"currency\": \"string\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a3a61cfe-9e20-0f2c-722a-96c357a930a8", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "sms", "stats", "by-country" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" }, { "key": "source", "value": "api" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "6bbafd98-1561-e610-d31b-f5ebe8110283", "name": "Messages", "description": { "content": "Message history, unified view and CSV export.", "type": "text/plain" }, "item": [ { "id": "e7619db5-3425-e583-d378-bbd4f151875b", "name": "List messages", "request": { "name": "List messages", "description": { "content": "Paginated list of sent messages with filtering. Requires `sms.read`.", "type": "text/plain" }, "url": { "path": [ "sms", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "status", "value": "unknown", "description": "Delivery status filter." }, { "disabled": false, "key": "phone", "value": "string", "description": "Search by phone number (substring)." }, { "disabled": false, "key": "country", "value": "string", "description": "ISO 3166-1 alpha-2 code: `US`, `GB`, …" }, { "disabled": false, "key": "sender", "value": "string", "description": "Filter by sender ID." }, { "disabled": false, "key": "period", "value": "7d", "description": "Named period preset. Takes precedence over `from`/`to`." }, { "disabled": false, "key": "from", "value": "1993-06-08", "description": "Start date `YYYY-MM-DD`. Use only when `period` is omitted." }, { "disabled": false, "key": "to", "value": "1993-06-08", "description": "End date `YYYY-MM-DD`, inclusive. Use only when `period` is omitted." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "d880f40e-1862-a2fc-45b8-fd8bb0244dc1", "name": "Paginated message list.", "originalRequest": { "url": { "path": [ "sms", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "25" }, { "key": "status", "value": "unknown" }, { "key": "phone", "value": "string" }, { "key": "country", "value": "string" }, { "key": "sender", "value": "string" }, { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"messages\": [\n {\n \"id\": 8597,\n \"client_message_id\": \"string\",\n \"recipient\": \"string\",\n \"sender_id\": \"string\",\n \"message\": \"string\",\n \"status\": \"string\",\n \"status_code\": \"string\",\n \"segments\": 1724,\n \"cost\": 4595.986558124423,\n \"created_at\": \"2026-01-01T00:00:00.000Z\",\n \"delivered_at\": \"2026-01-01T00:00:00.000Z\"\n },\n {\n \"id\": 8552,\n \"client_message_id\": \"string\",\n \"recipient\": \"string\",\n \"sender_id\": \"string\",\n \"message\": \"string\",\n \"status\": \"string\",\n \"status_code\": \"string\",\n \"segments\": 4358,\n \"cost\": 1906.068935059011,\n \"created_at\": \"2026-01-01T00:00:00.000Z\",\n \"delivered_at\": \"2026-01-01T00:00:00.000Z\"\n }\n ],\n \"total\": 6059,\n \"page\": 4465,\n \"limit\": 3119,\n \"total_pages\": 6271\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6dbf4a44-41fc-5e63-5c2b-6441420b37bc", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "sms", "messages" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "25" }, { "key": "status", "value": "unknown" }, { "key": "phone", "value": "string" }, { "key": "country", "value": "string" }, { "key": "sender", "value": "string" }, { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "6f15ac73-5959-9b4b-4942-bb5135657a31", "name": "List unified messages", "request": { "name": "List unified messages", "description": { "content": "Unified message view combining API traffic and broadcast campaigns.\nNote the response schema differs from `GET /sms/messages`\n(`sent_at` instead of `created_at`, extra click/conversion fields).\nRequires `sms.read`.\n", "type": "text/plain" }, "url": { "path": [ "sms", "messages", "unified" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "source", "value": "all" }, { "disabled": false, "key": "page", "value": "1" }, { "disabled": false, "key": "limit", "value": "25" }, { "disabled": false, "key": "status", "value": "unknown", "description": "Delivery status filter." }, { "disabled": false, "key": "phone", "value": "string", "description": "Search by phone number (substring)." }, { "disabled": false, "key": "country", "value": "string", "description": "ISO 3166-1 alpha-2 code: `US`, `GB`, …" }, { "disabled": false, "key": "sender", "value": "string", "description": "Filter by sender ID." }, { "disabled": false, "key": "period", "value": "7d", "description": "Named period preset. Takes precedence over `from`/`to`." }, { "disabled": false, "key": "from", "value": "1993-06-08", "description": "Start date `YYYY-MM-DD`. Use only when `period` is omitted." }, { "disabled": false, "key": "to", "value": "1993-06-08", "description": "End date `YYYY-MM-DD`, inclusive. Use only when `period` is omitted." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "a05ad37c-1b23-5d7e-3a70-0ff912daecf9", "name": "Paginated unified message list.", "originalRequest": { "url": { "path": [ "sms", "messages", "unified" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "source", "value": "all" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "25" }, { "key": "status", "value": "unknown" }, { "key": "phone", "value": "string" }, { "key": "country", "value": "string" }, { "key": "sender", "value": "string" }, { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"messages\": [\n {\n \"id\": \"string\",\n \"source\": \"api\",\n \"recipient\": \"string\",\n \"sender_id\": \"string\",\n \"message\": \"string\",\n \"status\": \"string\",\n \"status_code\": \"string\",\n \"cost\": 279.75762262940407,\n \"sent_at\": \"2026-01-01T00:00:00.000Z\",\n \"delivered_at\": \"2026-01-01T00:00:00.000Z\",\n \"clicked\": true,\n \"clicked_at\": \"2026-01-01T00:00:00.000Z\",\n \"action_type\": \"string\",\n \"action_at\": \"2026-01-01T00:00:00.000Z\",\n \"message_id\": \"string\",\n \"client_message_id\": \"string\",\n \"segments\": 867,\n \"broadcast_id\": 7880,\n \"broadcast_name\": \"string\"\n },\n {\n \"id\": \"string\",\n \"source\": \"api\",\n \"recipient\": \"string\",\n \"sender_id\": \"string\",\n \"message\": \"string\",\n \"status\": \"string\",\n \"status_code\": \"string\",\n \"cost\": 7676.78018193692,\n \"sent_at\": \"2026-01-01T00:00:00.000Z\",\n \"delivered_at\": \"2026-01-01T00:00:00.000Z\",\n \"clicked\": true,\n \"clicked_at\": \"2026-01-01T00:00:00.000Z\",\n \"action_type\": \"string\",\n \"action_at\": \"2026-01-01T00:00:00.000Z\",\n \"message_id\": \"string\",\n \"client_message_id\": \"string\",\n \"segments\": 1122,\n \"broadcast_id\": 3444,\n \"broadcast_name\": \"string\"\n }\n ],\n \"total\": 4985,\n \"page\": 7141,\n \"limit\": 4054,\n \"total_pages\": 7526\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0cb7bcc1-5c84-6329-0794-ee37cb057ac3", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "sms", "messages", "unified" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "source", "value": "all" }, { "key": "page", "value": "1" }, { "key": "limit", "value": "25" }, { "key": "status", "value": "unknown" }, { "key": "phone", "value": "string" }, { "key": "country", "value": "string" }, { "key": "sender", "value": "string" }, { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "15d2c840-4b83-994a-5b05-1e65d4c9ee2a", "name": "Export messages (CSV)", "request": { "name": "Export messages (CSV)", "description": { "content": "Streaming CSV export of unified messages. Same filters as the unified list.\nBody starts with a UTF-8 BOM (Excel-compatible). Row cap is advertised in\nthe `X-Export-Limit` response header (default 1,000,000).\nRequires `sms.read`.\n", "type": "text/plain" }, "url": { "path": [ "sms", "messages", "unified", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "source", "value": "all" }, { "disabled": false, "key": "period", "value": "7d", "description": "Named period preset. Takes precedence over `from`/`to`." }, { "disabled": false, "key": "from", "value": "1993-06-08", "description": "Start date `YYYY-MM-DD`. Use only when `period` is omitted." }, { "disabled": false, "key": "to", "value": "1993-06-08", "description": "End date `YYYY-MM-DD`, inclusive. Use only when `period` is omitted." }, { "disabled": false, "key": "status", "value": "unknown", "description": "Delivery status filter." }, { "disabled": false, "key": "phone", "value": "string", "description": "Search by phone number (substring)." }, { "disabled": false, "key": "country", "value": "string", "description": "ISO 3166-1 alpha-2 code: `US`, `GB`, …" }, { "disabled": false, "key": "sender", "value": "string", "description": "Filter by sender ID." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "auth": null }, "response": [ { "id": "3ee7d809-cbb2-21a5-20e1-a757ea6d0ceb", "name": "CSV stream.", "originalRequest": { "url": { "path": [ "sms", "messages", "unified", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "source", "value": "all" }, { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" }, { "key": "status", "value": "unknown" }, { "key": "phone", "value": "string" }, { "key": "country", "value": "string" }, { "key": "sender", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "text/csv" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Maximum rows included in this export.", "key": "X-Export-Limit", "value": "795" }, { "disabled": false, "key": "Content-Disposition", "value": "string", "description": "" }, { "key": "Content-Type", "value": "text/csv" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d3f18d39-63b1-f775-8561-d607951df07d", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "sms", "messages", "unified", "export" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "source", "value": "all" }, { "key": "period", "value": "7d" }, { "key": "from", "value": "1993-06-08" }, { "key": "to", "value": "1993-06-08" }, { "key": "status", "value": "unknown" }, { "key": "phone", "value": "string" }, { "key": "country", "value": "string" }, { "key": "sender", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "21edb314-7e8e-7f03-deb3-0c87d8921516", "name": "Account", "description": { "content": "Balance, pricing and payment history.", "type": "text/plain" }, "item": [ { "id": "0dcd7a45-88cc-8657-2ec1-ed46c8aa71d2", "name": "Get balance", "request": { "name": "Get balance", "description": { "content": "Current account balance, served from a background-refreshed cache.\nIf the cache is degraded the response still returns HTTP 200 and sets\nthe `X-Sms-Gateway-Status` / `X-Sms-Gateway-Reason` headers.\nRequires `balance.read`.\n", "type": "text/plain" }, "url": { "path": [ "user", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "038ed320-ede7-af89-fc9f-9538730cab44", "name": "Account balance.", "originalRequest": { "url": { "path": [ "user", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "disabled": false, "description": "Present only when data is degraded (`partial` or `unavailable`).", "key": "X-Sms-Gateway-Status", "value": "unavailable" }, { "disabled": false, "description": "Machine-readable degradation reason.", "key": "X-Sms-Gateway-Reason", "value": "string" }, { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"balance\": 2700.7370931096375,\n \"currency\": \"string\",\n \"updated\": \"string\",\n \"credit_blocked\": true\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "518eec0d-b3b8-714e-9df0-6ca7b864fb1b", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "user", "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "b2f482d7-4030-16a2-4da6-20371d429a7b", "name": "Get pricing", "request": { "name": "Get pricing", "description": { "content": "SMS rates per country and network. Requires `pricing.read`.", "type": "text/plain" }, "url": { "path": [ "user", "pricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "94f9e153-d697-7a93-e765-d96f6ec0ef33", "name": "Array of pricing entries.", "originalRequest": { "url": { "path": [ "user", "pricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"mcc\": \"string\",\n \"mnc\": \"string\",\n \"mccmnc\": \"string\",\n \"dialcode\": \"string\",\n \"country\": \"string\",\n \"network\": \"string\",\n \"rate\": 7632.716321386397,\n \"prev_rate\": 8456.852911040187,\n \"rate_start_date\": \"string\",\n \"rate_end_date\": \"string\",\n \"change_type\": \"Decrease\"\n },\n {\n \"mcc\": \"string\",\n \"mnc\": \"string\",\n \"mccmnc\": \"string\",\n \"dialcode\": \"string\",\n \"country\": \"string\",\n \"network\": \"string\",\n \"rate\": 8518.027602694929,\n \"prev_rate\": 3149.3896432220936,\n \"rate_start_date\": \"string\",\n \"rate_end_date\": \"string\",\n \"change_type\": \"Increase\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3dfe6d6f-26b5-5852-e13c-7b70c9ea6a7b", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "user", "pricing" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9881ec84-dc4e-f29a-9c16-6af75f345858", "name": "Get payments", "request": { "name": "Get payments", "description": { "content": "Transaction history merged from the SMS gateway and portal adjustments.\nRequires `payments.read`.\n", "type": "text/plain" }, "url": { "path": [ "user", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "e83b7396-cd51-47bb-4720-cc657e016420", "name": "Array of payments.", "originalRequest": { "url": { "path": [ "user", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"id\": \"string\",\n \"amount\": 2081.2177658081055,\n \"currency\": \"string\",\n \"date\": \"2026-01-01T00:00:00.000Z\",\n \"type\": \"deposit\",\n \"description\": \"string\",\n \"source\": \"sms_gateway\"\n },\n {\n \"id\": \"string\",\n \"amount\": 6035.833510104567,\n \"currency\": \"string\",\n \"date\": \"2026-01-01T00:00:00.000Z\",\n \"type\": \"deposit\",\n \"description\": \"string\",\n \"source\": \"portal\"\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "849ae6ba-77f7-f8fe-cf5c-c8a06cbfa4e9", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "user", "payments" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] }, { "id": "5bd76a62-96f1-8ce6-f631-724f19293224", "name": "Webhook settings", "description": { "content": "Webhook configuration, testing and delivery logs. (Webhook event payloads are described in the Webhooks section below.)", "type": "text/plain" }, "item": [ { "id": "f12128e1-a252-e60a-25fd-4bf9b12bff6a", "name": "Get webhook settings", "request": { "name": "Get webhook settings", "description": { "content": "Current webhook configuration for the workspace bound to your API key.\nThe signing secret is never echoed — only `signing_secret_set: true|false`.\nRequires `webhooks.read`.\n", "type": "text/plain" }, "url": { "path": [ "user", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "5622006c-1020-1ab2-30e1-250921682766", "name": "Webhook settings.", "originalRequest": { "url": { "path": [ "user", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"impression_url\": \"string\",\n \"click_url\": \"string\",\n \"conversion_url\": \"string\",\n \"delivery_url\": \"string\",\n \"unique_clicks_only\": true,\n \"signing_secret_set\": false,\n \"impression_fields\": [\n \"string\",\n \"string\"\n ],\n \"click_fields\": [\n \"string\",\n \"string\"\n ],\n \"conversion_fields\": [\n \"string\",\n \"string\"\n ],\n \"delivery_fields\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "620af59d-9533-9c98-1680-5be144e53aaa", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "user", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "062bc690-50d9-730c-e28b-fc9df0fdbda5", "name": "Update webhook settings", "request": { "name": "Update webhook settings", "description": { "content": "**Partial merge** — only the fields you send are touched.\nSend `null` or `\"\"` for a URL to disable that channel.\nRequires `webhooks.write`.\n", "type": "text/plain" }, "url": { "path": [ "user", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "PUT", "auth": null, "body": { "mode": "raw", "raw": "{\n \"delivery_url\": \"https://your-server.com/webhook/delivery\",\n \"click_url\": \"https://your-server.com/webhook/click\",\n \"unique_clicks_only\": true,\n \"delivery_fields\": [\n \"message_id\",\n \"recipient\",\n \"sender_id\",\n \"status\",\n \"status_code\",\n \"num_parts\",\n \"cost\",\n \"timestamp\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "99718869-2a7f-6d32-7ac4-ab2b031eb048", "name": "Settings updated.", "originalRequest": { "url": { "path": [ "user", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"delivery_url\": \"https://your-server.com/webhook/delivery\",\n \"click_url\": \"https://your-server.com/webhook/click\",\n \"unique_clicks_only\": true,\n \"delivery_fields\": [\n \"message_id\",\n \"recipient\",\n \"sender_id\",\n \"status\",\n \"status_code\",\n \"num_parts\",\n \"cost\",\n \"timestamp\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"impression_url\": \"string\",\n \"click_url\": \"string\",\n \"conversion_url\": \"string\",\n \"delivery_url\": \"string\",\n \"unique_clicks_only\": true,\n \"signing_secret_set\": false,\n \"impression_fields\": [\n \"string\",\n \"string\"\n ],\n \"click_fields\": [\n \"string\",\n \"string\"\n ],\n \"conversion_fields\": [\n \"string\",\n \"string\"\n ],\n \"delivery_fields\": [\n \"string\",\n \"string\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8783d962-492c-50ca-1757-4f34afa7b6eb", "name": "Typed validation error (INVALID_URL, INVALID_SECRET, INVALID_FIELDS, INVALID_TOGGLE, CONFLICTING_FIELDS, INVALID_BODY).", "originalRequest": { "url": { "path": [ "user", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"delivery_url\": \"https://your-server.com/webhook/delivery\",\n \"click_url\": \"https://your-server.com/webhook/click\",\n \"unique_clicks_only\": true,\n \"delivery_fields\": [\n \"message_id\",\n \"recipient\",\n \"sender_id\",\n \"status\",\n \"status_code\",\n \"num_parts\",\n \"cost\",\n \"timestamp\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": true,\n \"error_code\": \"string\",\n \"description\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8825b9bf-e252-9eec-e660-1f891fb45c57", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "user", "webhooks" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "PUT", "body": { "mode": "raw", "raw": "{\n \"delivery_url\": \"https://your-server.com/webhook/delivery\",\n \"click_url\": \"https://your-server.com/webhook/click\",\n \"unique_clicks_only\": true,\n \"delivery_fields\": [\n \"message_id\",\n \"recipient\",\n \"sender_id\",\n \"status\",\n \"status_code\",\n \"num_parts\",\n \"cost\",\n \"timestamp\"\n ]\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d8326ab9-1444-80d8-7ae8-a230a1b0f6a7", "name": "Send test webhook", "request": { "name": "Send test webhook", "description": { "content": "Sends a sample payload to your configured URL. Requires `webhooks.write`.", "type": "text/plain" }, "url": { "path": [ "user", "webhooks", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"type\": \"delivery\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "id": "85690937-ac02-52cd-c672-ba01c11bd1e9", "name": "Test dispatched.", "originalRequest": { "url": { "path": [ "user", "webhooks", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"delivery\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2d8bf03f-e2fc-d176-3df1-ef18111701cb", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "user", "webhooks", "test" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"type\": \"delivery\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fccbde0c-7520-56c4-dc23-55bf125b94a5", "name": "Get webhook delivery logs", "request": { "name": "Get webhook delivery logs", "description": { "content": "Payload sent, response code, response time and error details per attempt. Requires `webhooks.read`.", "type": "text/plain" }, "url": { "path": [ "user", "webhooks", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "id": "bd46a35e-c1bc-28ed-6814-a03dc7d6f0ca", "name": "Delivery log entries.", "originalRequest": { "url": { "path": [ "user", "webhooks", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" } ], "variable": [] }, "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "text/plain" } ], "body": "", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "68434bde-22e3-f0b2-661d-d37572eacbc5", "name": "Missing or invalid credentials.", "originalRequest": { "url": { "path": [ "user", "webhooks", "logs" ], "host": [ "{{baseUrl}}" ], "query": [ { "key": "limit", "value": "25" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": false,\n \"error_code\": \"INVALID_API_KEY\",\n \"description\": \"API key not found\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ], "event": [] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://restlink23telecom.com/api/v1", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" } ], "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "X-API-Key", "type": "string" }, { "key": "value", "value": "{{apiKey}}", "type": "string" }, { "key": "in", "value": "header", "type": "string" } ] }, "info": { "_postman_id": "729365ca-1f7b-f78a-0f48-afea8b1af693", "name": "23 Telecom SMS API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "REST API for sending SMS worldwide: message dispatch, delivery tracking,\nstatistics, balance, pricing and webhooks.\n\n**Base URL:** `https://restlink23telecom.com/api/v1`\n\nAuthenticate with the `X-API-Key` header. Create keys in the customer\nportal under **Settings → API Keys**. Full guides at\n[docs.23telecom.co.uk](https://docs.23telecom.co.uk).\n\n\nContact Support:\n Name: 23 Telecom Support", "type": "text/plain" } } }