{ "item": [ { "name": "Orders", "description": "Buy or cancel a number; receive lifecycle updates through webhooks.", "item": [ { "id": "ced89c24-adce-475b-b9b5-959f8d05efa2", "name": "Create an order (buy a number)", "request": { "name": "Create an order (buy a number)", "description": { "content": "Buys a temporary number for the given service and country. The order\nstays `pending` until a number is allocated (usually within seconds),\nthen becomes `active`; when the SMS code arrives it becomes\n`completed`.\n\n**Billing**: your wallet is charged **when the number is successfully\nallocated**, not at creation — while the order is `pending`,\n`amount_cents` is `0` and no funds have moved. If allocation fails\n(`failed`), you are never charged.\n\n**Price is resolved server-side** from the current catalog — you\ncannot self-quote. Pass `max_price_cents` to protect against price\nmoves between your catalog read and the purchase: if the resolved\nprice exceeds your cap by **more than 5%**, a `412 PRICE_CHANGED`\nis returned instead of charging you. Note the 5% tolerance — with\n`max_price_cents: 100` you may still be charged up to 105 cents;\ntreat it as drift protection, not an exact budget ceiling.\n\nSupports idempotency: pass a UUID in the `Idempotency-Key` header;\nretrying with the same key returns the original order instead of\nbuying twice. When order status queries are disabled, both the first\nresponse and idempotent replays return a fixed `pending` creation\nacknowledgement (`amount_cents: 0`) without phone/SMS/live status;\nreceive all lifecycle updates through webhooks.\n\nReceive the allocated number and SMS code through the\n`order.number_allocated` and `order.completed` webhook events.\n", "type": "text/plain" }, "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": true, "description": "Optional. Enable and set a real UUID to make retries idempotent.", "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"service_code\": \"whatsapp\",\n \"country_code\": \"US\"\n}\n", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "auth": null }, "response": [ { "id": "181309b7-a21a-4858-bade-9e9c25c0991e", "name": "Order accepted (`pending`). When order status queries are disabled, this is a fixed creation acknowledgement even on idempotent replay: no phone, SMS, live status, or settled amount is returned. Lifecycle updates are delivered by webhook.", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "UUID; retries with the same key return the original order.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"service_code\": \"\",\n \"country_code\": \"\",\n \"tier\": \"premium\",\n \"max_price_cents\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Created", "code": 201, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"order_no\": \"\",\n \"service_code\": \"\",\n \"country_code\": \"\",\n \"status\": \"failed\",\n \"amount_cents\": \"\",\n \"currency\": \"\",\n \"phone_number\": \"\",\n \"sms_code\": \"\",\n \"sms_content\": \"\",\n \"created_at\": \"\",\n \"activated_at\": \"\",\n \"expired_at\": \"\",\n \"completed_at\": \"\",\n \"cancelled_at\": \"\",\n \"sms_received_at\": \"\",\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4cbe3b82-03c7-49bb-b5c4-ded68c831b3f", "name": "Validation error (`VALIDATION_ERROR`, `CURRENCY_MISMATCH`).", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "UUID; retries with the same key return the original order.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"service_code\": \"\",\n \"country_code\": \"\",\n \"tier\": \"premium\",\n \"max_price_cents\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "322b0502-3f3b-4b2b-91fd-b20011ed7cbb", "name": "Missing or invalid API key (`API_KEY_MISSING`, `API_KEY_INVALID_FORMAT`, `API_KEY_INVALID`, `API_KEY_REVOKED`). Emitted by the auth layer before the handler — flat shape, no `request_id`.", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "UUID; retries with the same key return the original order.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"service_code\": \"\",\n \"country_code\": \"\",\n \"tier\": \"premium\",\n \"max_price_cents\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "404757c9-a640-4550-863c-fb09be147aae", "name": "Key is valid but access is blocked. Authentication eligibility failures are flat errors; an exhausted trial without a verified webhook returns envelope code `WEBHOOK_REQUIRED`.", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "UUID; retries with the same key return the original order.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"service_code\": \"\",\n \"country_code\": \"\",\n \"tier\": \"premium\",\n \"max_price_cents\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d49cb7ff-2cd3-47cb-a0e3-919018b40b96", "name": "`PRICE_CHANGED` — current price exceeds your `max_price_cents`; re-read the catalog and retry.", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "UUID; retries with the same key return the original order.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"service_code\": \"\",\n \"country_code\": \"\",\n \"tier\": \"premium\",\n \"max_price_cents\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Precondition Failed", "code": 412, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fc5777a1-7b62-443f-95ab-52ecb894cb45", "name": "`INSUFFICIENT_BALANCE`, `WALLET_NOT_INITIALIZED`, or `SERVICE_NOT_AVAILABLE`.", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "UUID; retries with the same key return the original order.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"service_code\": \"\",\n \"country_code\": \"\",\n \"tier\": \"premium\",\n \"max_price_cents\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7572cfd8-8596-4525-9377-a7c6440cb77c", "name": "Branch on `code` and honour `Retry-After`:\n- `RATE_LIMITED` / `RATE_LIMITED_DAILY`: wait until the indicated reset.\n- `TOO_MANY_ACTIVE_ORDERS`: wait for current orders to finish.", "originalRequest": { "url": { "path": [ "orders" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "disabled": false, "description": { "content": "UUID; retries with the same key return the original order.", "type": "text/plain" }, "key": "Idempotency-Key", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"service_code\": \"\",\n \"country_code\": \"\",\n \"tier\": \"premium\",\n \"max_price_cents\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } } }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "fa392fa8-a4dc-4773-a053-31c0a519ed9b", "name": "Cancel an order (refund)", "request": { "name": "Cancel an order (refund)", "description": { "content": "Cancels an order that has not received an SMS yet. If the number was\nalready allocated (order charged), the charge is refunded; a still\n`pending` order was never charged. Allowed only after a 2-minute\ncooldown from creation (`422 CANCEL_TOO_EARLY` before that).\nWhen order status queries are disabled, a successful cancellation\nreturns a fixed `cancelled` acknowledgement (`amount_cents: 0`)\nwithout phone/SMS/live fields; an already-terminal order returns\n`409 ORDER_ALREADY_TERMINAL`. When queries are enabled, the legacy\nfull current-state response remains available.\n", "type": "text/plain" }, "url": { "path": [ "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "", "key": "id", "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {}, "auth": null }, "response": [ { "id": "ced4ee38-e7da-4a30-b331-b1f14b46c730", "name": "Cancelled. When order status queries are disabled, this is a fixed `cancelled` acknowledgement without phone, SMS, settled amount, or other live fields.", "originalRequest": { "url": { "path": [ "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"id\": \"\",\n \"order_no\": \"\",\n \"service_code\": \"\",\n \"country_code\": \"\",\n \"status\": \"failed\",\n \"amount_cents\": \"\",\n \"currency\": \"\",\n \"phone_number\": \"\",\n \"sms_code\": \"\",\n \"sms_content\": \"\",\n \"created_at\": \"\",\n \"activated_at\": \"\",\n \"expired_at\": \"\",\n \"completed_at\": \"\",\n \"cancelled_at\": \"\",\n \"sms_received_at\": \"\",\n \"error_code\": \"\",\n \"error_message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "70004624-2ca3-46a0-b2be-c34a991fc0a8", "name": "Missing or invalid API key (`API_KEY_MISSING`, `API_KEY_INVALID_FORMAT`, `API_KEY_INVALID`, `API_KEY_REVOKED`). Emitted by the auth layer before the handler — flat shape, no `request_id`.", "originalRequest": { "url": { "path": [ "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "537f4fcb-b1ac-4415-b61c-67623528d2e7", "name": "Key is valid but access is blocked. Authentication eligibility failures are flat errors; an exhausted trial without a verified webhook returns envelope code `WEBHOOK_REQUIRED`.", "originalRequest": { "url": { "path": [ "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ea571a9a-e246-4c4e-ad40-1af62216582f", "name": "`ORDER_NOT_FOUND` — no such order under your account.", "originalRequest": { "url": { "path": [ "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e77e60ae-388d-4d9a-acb4-caadf9942130", "name": "`ORDER_ALREADY_TERMINAL` — no longer cancellable.", "originalRequest": { "url": { "path": [ "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Conflict", "code": 409, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b9389698-43f2-45b0-ba6c-eaa160b88865", "name": "`CANCEL_TOO_EARLY` — wait out the 2-minute cooldown.", "originalRequest": { "url": { "path": [ "orders", ":id", "cancel" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) ", "type": "text/plain" }, "type": "any", "value": "", "key": "id" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Balance", "description": "Read your wallet balance.", "item": [ { "id": "29b77668-3343-4587-bcd0-c9bdf6f37c16", "name": "Get wallet balance", "request": { "name": "Get wallet balance", "description": {}, "url": { "path": [ "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "7f009ca7-650b-4752-a29e-68ef073923a5", "name": "Current balance in cents.", "originalRequest": { "url": { "path": [ "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": {\n \"balance_cents\": \"\",\n \"currency\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4b4f3c37-ffc3-45cc-b056-496bf4ad00ee", "name": "Missing or invalid API key (`API_KEY_MISSING`, `API_KEY_INVALID_FORMAT`, `API_KEY_INVALID`, `API_KEY_REVOKED`). Emitted by the auth layer before the handler — flat shape, no `request_id`.", "originalRequest": { "url": { "path": [ "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a973cd9f-fb61-4fb5-a6ee-3cec05930fc8", "name": "Key is valid but access is blocked. Authentication eligibility failures are flat errors; an exhausted trial without a verified webhook returns envelope code `WEBHOOK_REQUIRED`.", "originalRequest": { "url": { "path": [ "balance" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Catalog", "description": "Discover available services, countries and prices.", "item": [ { "id": "a706094f-3b11-42d9-801d-142b5a0ded75", "name": "List available services", "request": { "name": "List available services", "description": { "content": "Cached — response carries `Cache-Control: private, max-age=300`.", "type": "text/plain" }, "url": { "path": [ "catalog", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "0d376fe9-0eb6-4e2a-9a80-a50f302d347f", "name": "Service list.", "originalRequest": { "url": { "path": [ "catalog", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"code\": \"\",\n \"name\": \"\"\n },\n {\n \"code\": \"\",\n \"name\": \"\"\n }\n ],\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57b4f882-30cd-4c34-9912-b952b9aa0185", "name": "Missing or invalid API key (`API_KEY_MISSING`, `API_KEY_INVALID_FORMAT`, `API_KEY_INVALID`, `API_KEY_REVOKED`). Emitted by the auth layer before the handler — flat shape, no `request_id`.", "originalRequest": { "url": { "path": [ "catalog", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fda613ed-a4d4-4076-819a-3ccaf97ad205", "name": "Key is valid but access is blocked. Authentication eligibility failures are flat errors; an exhausted trial without a verified webhook returns envelope code `WEBHOOK_REQUIRED`.", "originalRequest": { "url": { "path": [ "catalog", "services" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "4cdbd470-661e-4a56-bfaf-2421e7f1ef26", "name": "List available countries", "request": { "name": "List available countries", "description": { "content": "Cached — response carries `Cache-Control: private, max-age=300`.", "type": "text/plain" }, "url": { "path": [ "catalog", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "9bd7785c-55d9-455a-8dfa-c62a6bc64e67", "name": "Country list.", "originalRequest": { "url": { "path": [ "catalog", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"code\": \"\",\n \"name\": \"\",\n \"phone_prefix\": \"\",\n \"service_count\": \"\"\n },\n {\n \"code\": \"\",\n \"name\": \"\",\n \"phone_prefix\": \"\",\n \"service_count\": \"\"\n }\n ],\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7a6b4fae-57b5-491d-a066-dca6ad2f9826", "name": "Missing or invalid API key (`API_KEY_MISSING`, `API_KEY_INVALID_FORMAT`, `API_KEY_INVALID`, `API_KEY_REVOKED`). Emitted by the auth layer before the handler — flat shape, no `request_id`.", "originalRequest": { "url": { "path": [ "catalog", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "dfb989ce-66f7-4426-947f-a6fd7662afff", "name": "Key is valid but access is blocked. Authentication eligibility failures are flat errors; an exhausted trial without a verified webhook returns envelope code `WEBHOOK_REQUIRED`.", "originalRequest": { "url": { "path": [ "catalog", "countries" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "88e565eb-8ba8-407d-9c30-31bde517c348", "name": "List prices for one country", "request": { "name": "List prices for one country", "description": { "content": "Prices (in cents) and availability per service for the given country.\n\nCached — response carries `Cache-Control: private, max-age=60`.\n**Do not repeatedly query this endpoint**: cache it client-side\nand honour `Retry-After` on 429. Standard accounts receive 1,000 price\nqueries per 5 hours and 10,000 per 7 days. VIP accounts receive 5,000\nper 5 hours and 50,000 per 7 days.\n", "type": "text/plain" }, "url": { "path": [ "catalog", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2, e.g. `US`.", "type": "text/plain" }, "key": "country_code", "value": "US" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": null }, "response": [ { "id": "a76b3b87-f853-4908-8b88-2eeea4f000ff", "name": "Price list.", "originalRequest": { "url": { "path": [ "catalog", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2, e.g. `US`.", "type": "text/plain" }, "key": "country_code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"data\": [\n {\n \"service_code\": \"\",\n \"service_name\": \"\",\n \"price_cents\": \"\",\n \"available_count\": \"\"\n },\n {\n \"service_code\": \"\",\n \"service_name\": \"\",\n \"price_cents\": \"\",\n \"available_count\": \"\"\n }\n ],\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "9cbf44b2-1d9b-49be-bb8f-c0ad12aa284b", "name": "`INVALID_REQUEST` — missing or malformed `country_code`.", "originalRequest": { "url": { "path": [ "catalog", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2, e.g. `US`.", "type": "text/plain" }, "key": "country_code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "806afc10-ee96-4529-9a19-1947b487e264", "name": "Missing or invalid API key (`API_KEY_MISSING`, `API_KEY_INVALID_FORMAT`, `API_KEY_INVALID`, `API_KEY_REVOKED`). Emitted by the auth layer before the handler — flat shape, no `request_id`.", "originalRequest": { "url": { "path": [ "catalog", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2, e.g. `US`.", "type": "text/plain" }, "key": "country_code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e361fbd9-93cf-4fcc-8ce0-fae6f2ac4132", "name": "Key is valid but access is blocked. Authentication eligibility failures are flat errors; an exhausted trial without a verified webhook returns envelope code `WEBHOOK_REQUIRED`.", "originalRequest": { "url": { "path": [ "catalog", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2, e.g. `US`.", "type": "text/plain" }, "key": "country_code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": \"\",\n \"code\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "eeeb45ff-e7fa-4590-aa4e-978c4b68e960", "name": "`COUNTRY_NOT_FOUND`.", "originalRequest": { "url": { "path": [ "catalog", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2, e.g. `US`.", "type": "text/plain" }, "key": "country_code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d270455-a928-43b8-a5ce-73675c987ba1", "name": "`PRICE_RATE_LIMITED` — cache responses and retry after the returned reset time. Contact vip@dogesms.com if a verified business integration needs higher limits.", "originalRequest": { "url": { "path": [ "catalog", "prices" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) ISO 3166-1 alpha-2, e.g. `US`.", "type": "text/plain" }, "key": "country_code", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: bearer", "type": "text/plain" }, "key": "Authorization", "value": "Bearer " } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error\": {\n \"code\": \"\",\n \"message\": \"\"\n },\n \"request_id\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{apiKey}}", "type": "string" } ] }, "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.dogesms.com/v1", "type": "string" }, { "key": "apiKey", "value": "", "type": "string" } ], "info": { "_postman_id": "52bfe9fd-5a86-4526-9cab-7f61b0c53cee", "name": "DogeSMS API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "DogeSMS API Postman Collection (v2026.07).\n\nSet the `apiKey` collection variable to your `sk_live_` key, then run any request.\n\nGenerated from the OpenAPI spec — do not edit by hand; download the latest from https://dogesms.com/docs.", "type": "text/markdown" }, "version": "2026.07" } }