{ "item": [ { "name": "System", "item": [ { "name": "Health Check", "request": { "name": "Public liveness probe", "description": { "content": "Public, unauthenticated endpoint intended for customer-side monitoring (Pingdom,\nUptimeRobot, BetterStack, Datadog HTTP checks, custom dashboards). Runs real\ndependency checks behind the scenes; returns a summary status only.\n\nKey the integration off the HTTP status code, not the body string - 200 means\noperational, 503 means do not call other endpoints right now. We deliberately\ndo not return 200 with a \"down\" body.\n\nSubsystem detail is intentionally not exposed. When the service is unavailable,\nthe body does not say which subsystem is at fault.\n\nRecommended polling interval: 30 seconds. The endpoint is cached server-side\nfor 5 seconds, so polling faster does not get fresher data.\n", "type": "text/plain" }, "url": { "path": [ "v3", "api", "health" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "All checks passing. Safe to call other endpoints.", "originalRequest": { "url": { "path": [ "v3", "api", "health" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"version\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Service is either in operator-set maintenance (status=maintenance) or\ncannot service requests right now (status=unavailable). Retry with backoff.\n", "originalRequest": { "url": { "path": [ "v3", "api", "health" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"version\": \"\",\n \"timestamp\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Version", "request": { "name": "Deployed backend version", "description": { "content": "Public, unauthenticated endpoint that returns the deployed backend version.\nUseful for detecting that a new release has rolled out without making an\nauthed call.\n", "type": "text/plain" }, "url": { "path": [ "v3", "api", "version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Version info", "originalRequest": { "url": { "path": [ "v3", "api", "version" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"\",\n \"version\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Account", "item": [ { "name": "Get Balance", "request": { "name": "Get account balance", "description": {}, "url": { "path": [ "v3", "api", "balance" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Current balance", "originalRequest": { "url": { "path": [ "v3", "api", "balance" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "User not found", "originalRequest": { "url": { "path": [ "v3", "api", "balance" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get Webhook Settings", "request": { "name": "Get webhook settings", "description": { "content": "Returns the account's webhook URL, whether delivery is currently live, and - if a run of failed deliveries paused it - when and why.", "type": "text/plain" }, "url": { "path": [ "v3", "api", "webhook" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Current webhook settings", "originalRequest": { "url": { "path": [ "v3", "api", "webhook" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "User not found", "originalRequest": { "url": { "path": [ "v3", "api", "webhook" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Set Webhook URL", "request": { "name": "Set or change the webhook URL", "description": { "content": "Sets or replaces the webhook URL that receives your event notifications. The URL must be HTTP(S) and must not point to a private or internal address. Saving also re-enables a webhook that was automatically paused after repeated delivery failures.", "type": "text/plain" }, "url": { "path": [ "v3", "api", "webhook" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"url\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Webhook URL saved", "originalRequest": { "url": { "path": [ "v3", "api", "webhook" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Missing url, invalid JSON, or an unsafe URL (bad scheme, embedded credentials, or a private/internal/unresolvable host).", "originalRequest": { "url": { "path": [ "v3", "api", "webhook" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"url\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Clear Webhook URL", "request": { "name": "Clear the webhook URL", "description": { "content": "Removes the webhook URL. Event delivery stops immediately and any automatic-pause state is cleared.", "type": "text/plain" }, "url": { "path": [ "v3", "api", "webhook" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "auth": null }, "response": [ { "name": "Webhook URL cleared", "originalRequest": { "url": { "path": [ "v3", "api", "webhook" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "DELETE", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Services", "item": [ { "name": "List Services (Paginated)", "request": { "name": "List services (paginated)", "description": { "content": "Paginated list of available services. Use `/services/all` instead if you want every service in one call. Same fields per service as `/services/all`.", "type": "text/plain" }, "url": { "path": [ "v3", "api", "services" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "page", "value": "1", "description": "1-based page number." }, { "disabled": false, "key": "limit", "value": "50", "description": "Services per page (max 100)." } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "A page of services", "originalRequest": { "url": { "path": [ "v3", "api", "services" ], "host": [ "{{base_url}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid page or limit", "originalRequest": { "url": { "path": [ "v3", "api", "services" ], "host": [ "{{base_url}}" ], "query": [ { "key": "page", "value": "1" }, { "key": "limit", "value": "50" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get All Services", "request": { "name": "List all services (no pagination)", "description": {}, "url": { "path": [ "v3", "api", "services", "all" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "All services", "originalRequest": { "url": { "path": [ "v3", "api", "services", "all" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get Service by ID", "request": { "name": "Get service by ID", "description": {}, "url": { "path": [ "v3", "api", "service", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Service details", "originalRequest": { "url": { "path": [ "v3", "api", "service", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "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 \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Service ID is required", "originalRequest": { "url": { "path": [ "v3", "api", "service", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get Inventory", "request": { "name": "Stock per US state and per area code", "description": { "content": "How many numbers a service has right now in each US state and each area code, counted from the same pools a purchase draws on. Use it to show customers only states that have numbers, then purchase with `state` - one call, no trial and error. Counts are cached for about a minute. With several serviceIds each count is the minimum across those services.", "type": "text/plain" }, "url": { "path": [ "v3", "api", "inventory" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "serviceId", "value": "", "description": "Service ID from /services (or use serviceIds)" }, { "disabled": false, "key": "serviceIds", "value": "", "description": "Comma-separated service IDs, at most 10" }, { "disabled": false, "key": "type", "value": "", "description": "(Required) STR (temporary numbers) or LTR (rentals)" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Stock per state and per area code", "originalRequest": { "url": { "path": [ "v3", "api", "inventory" ], "host": [ "{{base_url}}" ], "query": [ { "key": "serviceId", "value": "" }, { "key": "serviceIds", "value": "" }, { "key": "type", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Service not found", "originalRequest": { "url": { "path": [ "v3", "api", "inventory" ], "host": [ "{{base_url}}" ], "query": [ { "key": "serviceId", "value": "" }, { "key": "serviceIds", "value": "" }, { "key": "type", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error (type must be STR or LTR, serviceId required, at most 10 ids)", "originalRequest": { "url": { "path": [ "v3", "api", "inventory" ], "host": [ "{{base_url}}" ], "query": [ { "key": "serviceId", "value": "" }, { "key": "serviceIds", "value": "" }, { "key": "type", "value": "" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "STR (Short-Term Rental)", "item": [ { "name": "Purchase Number", "request": { "name": "Purchase STR numbers", "description": {}, "url": { "path": [ "v3", "api", "purchase" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"services\": [\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n },\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n }\n ],\n \"isLtr\": false,\n \"ltrDuration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Numbers purchased", "originalRequest": { "url": { "path": [ "v3", "api", "purchase" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"services\": [\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n },\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n }\n ],\n \"isLtr\": false,\n \"ltrDuration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Insufficient credits", "originalRequest": { "url": { "path": [ "v3", "api", "purchase" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"services\": [\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n },\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n }\n ],\n \"isLtr\": false,\n \"ltrDuration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "User blocked from purchasing", "originalRequest": { "url": { "path": [ "v3", "api", "purchase" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"services\": [\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n },\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n }\n ],\n \"isLtr\": false,\n \"ltrDuration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Service not found", "originalRequest": { "url": { "path": [ "v3", "api", "purchase" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"services\": [\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n },\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n }\n ],\n \"isLtr\": false,\n \"ltrDuration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "v3", "api", "purchase" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"services\": [\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n },\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n }\n ],\n \"isLtr\": false,\n \"ltrDuration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No numbers available", "originalRequest": { "url": { "path": [ "v3", "api", "purchase" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"services\": [\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n },\n {\n \"serviceId\": \"\",\n \"areaCode\": \"\",\n \"state\": \"\"\n }\n ],\n \"isLtr\": false,\n \"ltrDuration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Flag Number", "request": { "name": "Flag a number", "description": { "content": "Flag a number as bad and get a refund. Only allowed when allowFlag is true.", "type": "text/plain" }, "url": { "path": [ "v3", "api", "flag", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "name": "Number flagged", "originalRequest": { "url": { "path": [ "v3", "api", "flag", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "User blocked due to excessive flagging", "originalRequest": { "url": { "path": [ "v3", "api", "flag", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Request not found", "originalRequest": { "url": { "path": [ "v3", "api", "flag", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Flag not allowed for this request", "originalRequest": { "url": { "path": [ "v3", "api", "flag", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Reuse Number", "request": { "name": "Reuse a number", "description": { "content": "Reuse a previously purchased number for the same service.", "type": "text/plain" }, "url": { "path": [ "v3", "api", "reuse", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "name": "Number reused", "originalRequest": { "url": { "path": [ "v3", "api", "reuse", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Request not found", "originalRequest": { "url": { "path": [ "v3", "api", "reuse", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Reuse not allowed", "originalRequest": { "url": { "path": [ "v3", "api", "reuse", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "LTR (Long-Term Rental)", "item": [ { "name": "Purchase Number", "request": { "name": "Purchase LTR number", "description": {}, "url": { "path": [ "v3", "api", "purchase-ltr" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"\",\n \"duration\": \"\",\n \"country\": \"US\",\n \"areaCode\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "LTR number purchased", "originalRequest": { "url": { "path": [ "v3", "api", "purchase-ltr" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"\",\n \"duration\": \"\",\n \"country\": \"US\",\n \"areaCode\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Insufficient credits", "originalRequest": { "url": { "path": [ "v3", "api", "purchase-ltr" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"\",\n \"duration\": \"\",\n \"country\": \"US\",\n \"areaCode\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Service not found", "originalRequest": { "url": { "path": [ "v3", "api", "purchase-ltr" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"\",\n \"duration\": \"\",\n \"country\": \"US\",\n \"areaCode\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Validation error", "originalRequest": { "url": { "path": [ "v3", "api", "purchase-ltr" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"\",\n \"duration\": \"\",\n \"country\": \"US\",\n \"areaCode\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "No numbers available", "originalRequest": { "url": { "path": [ "v3", "api", "purchase-ltr" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"\",\n \"duration\": \"\",\n \"country\": \"US\",\n \"areaCode\": \"\",\n \"state\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Flag Number", "request": { "name": "Flag a number", "description": { "content": "Flag a number as bad and get a refund. Only allowed when allowFlag is true.", "type": "text/plain" }, "url": { "path": [ "v3", "api", "flag", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "name": "Number flagged", "originalRequest": { "url": { "path": [ "v3", "api", "flag", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "User blocked due to excessive flagging", "originalRequest": { "url": { "path": [ "v3", "api", "flag", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Request not found", "originalRequest": { "url": { "path": [ "v3", "api", "flag", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Flag not allowed for this request", "originalRequest": { "url": { "path": [ "v3", "api", "flag", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Renew Number", "request": { "name": "Set LTR renewal (one-time for All Services, auto-renew for per-service)", "description": { "content": "Controls the renewal switch on an LTR number. **Always send the value\nexplicitly**: `{ \"autoRenew\": true }` to turn it on, `{ \"autoRenew\": false }`\nto turn it off. If you send **no body**, the switch is **toggled** - flipped\nfrom whatever it currently is - so send `autoRenew` unless you specifically\nintend to flip it. Only works when the request status is RESERVED.\n\n**All Services numbers are ONE-TIME renewal.** Turning the switch on renews\nthe number ONCE at its expiry, then the switch resets to OFF. To keep an All\nServices number for the next term you must turn it on AGAIN after each\nrenewal - it does not stay on by itself.\n\n**Per-service LTR numbers** (a specific service, duration 3/7/14/30) behave\nthe opposite way: once on, they keep auto-renewing every term until you turn\nthe switch off.\n\n**UK, HK, and ID All Services numbers** have an upstream renewal lockout\nwindow. Within 4 days of the upstream provider expiry:\n- Turning OFF is blocked (422) because the number has already been forwarded\n for renewal.\n- Turning ON triggers an immediate renewal attempt. If successful, the number\n is renewed and your account is charged. If the provider cannot renew the\n number, a 422 error is returned.\n", "type": "text/plain" }, "url": { "path": [ "v3", "api", "renew-ltr", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"autoRenew\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Auto-renew updated", "originalRequest": { "url": { "path": [ "v3", "api", "renew-ltr", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"autoRenew\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Unauthorized", "originalRequest": { "url": { "path": [ "v3", "api", "renew-ltr", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"autoRenew\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Request not found", "originalRequest": { "url": { "path": [ "v3", "api", "renew-ltr", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"autoRenew\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Returned when: the request is not in RESERVED status; turning OFF\nauto-renew within 4 days of upstream expiry for UK/HK/ID All\nServices numbers; or turning ON auto-renew late and the provider\ncannot renew the number.\n", "originalRequest": { "url": { "path": [ "v3", "api", "renew-ltr", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"autoRenew\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Reuse Number", "request": { "name": "Reuse a number", "description": { "content": "Reuse a previously purchased number for the same service.", "type": "text/plain" }, "url": { "path": [ "v3", "api", "reuse", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null }, "response": [ { "name": "Number reused", "originalRequest": { "url": { "path": [ "v3", "api", "reuse", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Request not found", "originalRequest": { "url": { "path": [ "v3", "api", "reuse", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Reuse not allowed", "originalRequest": { "url": { "path": [ "v3", "api", "reuse", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Purchase All Service Number", "request": { "name": "Purchase LTR number", "description": {}, "url": { "path": [ "v3", "api", "purchase-ltr" ], "host": [ "{{base_url}}" ], "query": [], "variable": [] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"serviceId\": \"ALL_SERVICES\",\n \"country\": \"US\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Change Duration (Preview)", "request": { "name": "Preview an LTR duration change", "description": { "content": "Preview the cost of changing an existing LTR number to a longer duration.\nReturns the fee breakdown, the new expiry, and the wallet balance. Only\navailable for pool LTR numbers with status RESERVED (or COMPLETED when\nallowReuse is true); the 28-day All Service number is not eligible.\n", "type": "text/plain" }, "url": { "path": [ "v3", "api", "ltr-change-duration", ":id", "preview" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "duration", "value": "", "description": "(Required) Target duration in days (7, 14, or 30). Must be longer than the current duration." } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Upgrade preview retrieved", "originalRequest": { "url": { "path": [ "v3", "api", "ltr-change-duration", ":id", "preview" ], "host": [ "{{base_url}}" ], "query": [ { "key": "duration", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "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 \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Insufficient credits", "originalRequest": { "url": { "path": [ "v3", "api", "ltr-change-duration", ":id", "preview" ], "host": [ "{{base_url}}" ], "query": [ { "key": "duration", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Request not found", "originalRequest": { "url": { "path": [ "v3", "api", "ltr-change-duration", ":id", "preview" ], "host": [ "{{base_url}}" ], "query": [ { "key": "duration", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "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 \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not eligible (not an LTR pool number, wrong status, or not a longer duration)", "originalRequest": { "url": { "path": [ "v3", "api", "ltr-change-duration", ":id", "preview" ], "host": [ "{{base_url}}" ], "query": [ { "key": "duration", "value": "" } ], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Change Duration", "request": { "name": "Change an LTR number's duration", "description": { "content": "Change an existing LTR number to a longer duration. Charges a $2 fixed\nfee plus the full price of the target duration and extends the rental to\nthe new expiry. Same eligibility as the preview endpoint.\n", "type": "text/plain" }, "url": { "path": [ "v3", "api", "ltr-change-duration", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "method": "POST", "auth": null, "body": { "mode": "raw", "raw": "{\n \"duration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "response": [ { "name": "Duration changed", "originalRequest": { "url": { "path": [ "v3", "api", "ltr-change-duration", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Insufficient credits", "originalRequest": { "url": { "path": [ "v3", "api", "ltr-change-duration", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Payment Required", "code": 402, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Request not found", "originalRequest": { "url": { "path": [ "v3", "api", "ltr-change-duration", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Not Found", "code": 404, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Not eligible (not an LTR pool number, wrong status, or not a longer duration)", "originalRequest": { "url": { "path": [ "v3", "api", "ltr-change-duration", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "POST", "body": { "mode": "raw", "raw": "{\n \"duration\": \"\"\n}", "options": { "raw": { "language": "json" } } } }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Requests", "item": [ { "name": "List Service Requests", "request": { "name": "List service requests (cursor-paginated)", "description": {}, "url": { "path": [ "v3", "api", "requests" ], "host": [ "{{base_url}}" ], "query": [ { "disabled": false, "key": "first", "value": "20" }, { "disabled": false, "key": "after", "value": "", "description": "Cursor for forward pagination" }, { "disabled": false, "key": "last", "value": "" }, { "disabled": false, "key": "before", "value": "", "description": "Cursor for backward pagination" }, { "disabled": false, "key": "number", "value": "", "description": "Filter by phone number (e.g. +12345678901)" }, { "disabled": false, "key": "status", "value": "", "description": "Filter by status" }, { "disabled": false, "key": "orderField", "value": "_id" }, { "disabled": false, "key": "orderBy", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Paginated list of requests", "originalRequest": { "url": { "path": [ "v3", "api", "requests" ], "host": [ "{{base_url}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "" }, { "key": "last", "value": "" }, { "key": "before", "value": "" }, { "key": "number", "value": "" }, { "key": "status", "value": "" }, { "key": "orderField", "value": "_id" }, { "key": "orderBy", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid status value", "originalRequest": { "url": { "path": [ "v3", "api", "requests" ], "host": [ "{{base_url}}" ], "query": [ { "key": "first", "value": "20" }, { "key": "after", "value": "" }, { "key": "last", "value": "" }, { "key": "before", "value": "" }, { "key": "number", "value": "" }, { "key": "status", "value": "" }, { "key": "orderField", "value": "_id" }, { "key": "orderBy", "value": "desc" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "name": "Get Service Request by ID", "request": { "name": "Get request by ID", "description": {}, "url": { "path": [ "v3", "api", "request", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "auth": null }, "response": [ { "name": "Request details", "originalRequest": { "url": { "path": [ "v3", "api", "request", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "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 \"success\": \"\",\n \"message\": \"\",\n \"data\": \"\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Request not found", "originalRequest": { "url": { "path": [ "v3", "api", "request", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "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 \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "name": "Invalid requestId format", "originalRequest": { "url": { "path": [ "v3", "api", "request", ":id" ], "host": [ "{{base_url}}" ], "query": [], "variable": [ { "disabled": false, "type": "any", "value": "", "key": "id", "description": "(Required) " } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {} }, "status": "Unprocessable Entity (WebDAV) (RFC 4918)", "code": 422, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"success\": \"\",\n \"message\": \"\",\n \"data\": {},\n \"errors\": [\n \"\",\n \"\"\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "base_url", "value": "https://prod-v3.pvadeals.com", "type": "string", "description": "Base URL for API." }, { "key": "api_key", "value": "API-xxxxx", "type": "string", "description": "Your API key from Developer Settings. Sent as 'Authorization: Bearer API-xxxxx...'." } ], "auth": { "type": "bearer", "bearer": [ { "key": "token", "value": "{{api_key}}" } ] }, "info": { "_postman_id": "pvadeals-developer-api-collection", "name": "PVADeals Developer API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": "Generated from docs/openapi.yaml - do not hand-edit. Run `node scripts/gen-postman.js` after changing the spec." } }