{ "openapi": "3.1.0", "info": { "title": "Vozira SMS Developer API", "version": "1.0.0", "description": "Long and temporary numbers through your Vozira wallet. Server-to-server use; API keys must never be embedded in browser code." }, "servers": [ { "url": "https://vozirasms.com/api/v1" } ], "security": [ { "ApiKey": [] } ], "paths": { "/balance": { "get": { "summary": "Account balance", "description": "", "operationId": "get_balance", "parameters": [], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "balance": { "type": [ "string", "null" ] }, "currency": { "const": "USD" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/recharge": { "get": { "summary": "Website recharge link", "description": "", "operationId": "get_recharge", "parameters": [], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "url": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/limits": { "get": { "summary": "Long-number limits", "description": "", "operationId": "get_limits", "parameters": [], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Limits" }, "rates": { "type": "object" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/apps": { "get": { "summary": "Long-number catalog", "description": "", "operationId": "get_apps", "parameters": [ { "name": "type", "in": "query", "required": false, "schema": { "type": "integer", "enum": [ 1 ], "default": 1 }, "description": "" }, { "name": "expiry", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "maximum": 6, "default": 0 }, "description": "" }, { "name": "search", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 }, "description": "" }, { "name": "cate_id", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "" } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Product" } }, "categories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "name": { "type": [ "string", "null" ] }, "name_en": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false } }, "catalog": { "type": "object", "properties": { "stale": { "type": "boolean" }, "lastSuccessfulAt": { "type": [ "number", "null", "string" ] } }, "required": [], "additionalProperties": false }, "limits": { "$ref": "#/components/schemas/Limits" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/buy": { "post": { "summary": "Buy long numbers", "description": "", "operationId": "post_buy", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._~:+/=\\-]{16,128}$" }, "description": "Save before sending. Reuse only for the exact original operation; never rotate after an unknown outcome." } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Purchase" } } } }, "202": { "description": "Processing; query the original operation. Do not create a replacement purchase.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Purchase" } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "type": "integer", "minimum": 1 }, "cate_id": { "type": "integer", "minimum": 1 }, "type": { "type": "integer", "enum": [ 1 ], "default": 1 }, "quantity": { "type": "integer", "minimum": 1 }, "expiry": { "type": "integer", "minimum": 0, "maximum": 6, "default": 0 }, "expected_total": { "type": "string", "pattern": "^(0|[1-9]\\d{0,5})(\\.\\d{1,4})?$" }, "prefix": { "type": "string" } }, "required": [ "app_id", "cate_id", "quantity", "expected_total" ], "additionalProperties": false } } } } } }, "/requests/by-key": { "get": { "summary": "Recover a long purchase by key", "description": "", "operationId": "get_requests_by_key", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._~:+/=\\-]{16,128}$" }, "description": "Save before sending. Reuse only for the exact original operation; never rotate after an unknown outcome." } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Purchase" } } } }, "202": { "description": "Processing; query the original operation. Do not create a replacement purchase.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Purchase" } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/requests/{id}": { "get": { "summary": "Long purchase status", "description": "", "operationId": "get_requests_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Purchase" } } } }, "202": { "description": "Processing; query the original operation. Do not create a replacement purchase.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Purchase" } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orders": { "get": { "summary": "Long-number orders", "description": "", "operationId": "get_orders", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "description": "" }, { "name": "before_id", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "" } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/LongOrder" } }, "has_more": { "type": "boolean" }, "next_before_id": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orders/{reference}": { "get": { "summary": "Long-number order", "description": "", "operationId": "get_orders_reference", "parameters": [ { "name": "reference", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^VZ-\\d+$" } } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/LongOrder" }, "has_more": { "type": "boolean" }, "next_before_id": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/sms/{item_id}": { "get": { "summary": "Read long-number SMS", "description": "", "operationId": "get_sms_item_id", "parameters": [ { "name": "item_id", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "number": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "app": { "type": [ "string", "null" ] }, "end_time": { "type": [ "string", "null" ] }, "session_end": { "type": [ "string", "null" ] }, "sms_status": { "type": [ "string", "null" ] }, "sms": { "type": "array", "items": { "$ref": "#/components/schemas/SMS" } } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/sms-history": { "get": { "summary": "SMS history", "description": "", "operationId": "get_sms_history", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "description": "" }, { "name": "before_id", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "" }, { "name": "item_id", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "" } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/SMS" } }, "has_more": { "type": "boolean" }, "next_before_id": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/transactions": { "get": { "summary": "Wallet transactions", "description": "Regular accounts only. Includes website and API wallet transactions.", "operationId": "get_transactions", "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "description": "" }, { "name": "before_id", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "" } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Transaction" } }, "has_more": { "type": "boolean" }, "next_before_id": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/renewal/eligibility/{itemId}": { "get": { "summary": "Check renewal eligibility", "description": "Regular accounts only. Read state and payment_state. Confirm the original operation once, then query it; do not create another quote to retry an uncertain result.", "operationId": "get_renewal_eligibility_itemId", "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Renewal" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/renewal/quote/{itemId}": { "post": { "summary": "Quote renewal", "description": "Regular accounts only. Read state and payment_state. Confirm the original operation once, then query it; do not create another quote to retry an uncertain result.", "operationId": "post_renewal_quote_itemId", "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Renewal" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/renewal/confirm/{id}": { "post": { "summary": "Confirm renewal", "description": "Regular accounts only. Read state and payment_state. Confirm the original operation once, then query it; do not create another quote to retry an uncertain result.", "operationId": "post_renewal_confirm_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._~:+/=\\-]{16,128}$" }, "description": "Save before sending. Reuse only for the exact original operation; never rotate after an unknown outcome." } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Renewal" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } } } }, "/renewal/by-key": { "get": { "summary": "Recover renewal by key", "description": "Regular accounts only. Read state and payment_state. Confirm the original operation once, then query it; do not create another quote to retry an uncertain result.", "operationId": "get_renewal_by_key", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._~:+/=\\-]{16,128}$" }, "description": "Save before sending. Reuse only for the exact original operation; never rotate after an unknown outcome." } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Renewal" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/renewal/{id}": { "get": { "summary": "Renewal status", "description": "Regular accounts only. Read state and payment_state. Confirm the original operation once, then query it; do not create another quote to retry an uncertain result.", "operationId": "get_renewal_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "$ref": "#/components/schemas/Renewal" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/one-time/catalog": { "get": { "summary": "Temporary services and countries", "description": "Search services and countries separately. Initial response is a shortlist, not the complete catalog. Selecting a pair does not guarantee inventory; request a quote.", "operationId": "get_one_time_catalog", "parameters": [ { "name": "service", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 }, "description": "" }, { "name": "country", "in": "query", "required": false, "schema": { "type": "string", "maxLength": 80 }, "description": "" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 30 }, "description": "" } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "type": "object", "properties": { "services": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "name_en": { "type": [ "string", "null" ] }, "name_zh": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false } }, "countries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "iso2": { "type": [ "string", "null" ] }, "name_en": { "type": [ "string", "null" ] }, "name_zh": { "type": [ "string", "null" ] }, "dial_code": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false } }, "mode": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/one-time/quote": { "post": { "summary": "Quote a temporary number", "description": "", "operationId": "post_one_time_quote", "parameters": [], "responses": { "201": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "quote": { "$ref": "#/components/schemas/TemporaryQuote" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "service_code": { "type": "string" }, "country_id": { "type": "integer", "minimum": 0 } }, "required": [ "service_code", "country_id" ], "additionalProperties": false } } } } } }, "/one-time/buy": { "post": { "summary": "Buy a temporary number", "description": "", "operationId": "post_one_time_buy", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._~:+/=\\-]{16,128}$" }, "description": "Save before sending. Reuse only for the exact original operation; never rotate after an unknown outcome." } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "order": { "$ref": "#/components/schemas/TemporaryOrder" } }, "required": [], "additionalProperties": false } } } }, "202": { "description": "Processing; query the original operation. Do not create a replacement purchase.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "order": { "$ref": "#/components/schemas/TemporaryOrder" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "quote_id": { "type": "string", "format": "uuid" } }, "required": [ "quote_id" ], "additionalProperties": false } } } } } }, "/one-time/requests/by-key": { "get": { "summary": "Recover temporary purchase", "description": "", "operationId": "get_one_time_requests_by_key", "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 16, "maxLength": 128, "pattern": "^[A-Za-z0-9._~:+/=\\-]{16,128}$" }, "description": "Save before sending. Reuse only for the exact original operation; never rotate after an unknown outcome." } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "order": { "$ref": "#/components/schemas/TemporaryOrder" } }, "required": [], "additionalProperties": false } } } }, "202": { "description": "Processing; query the original operation. Do not create a replacement purchase.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "order": { "$ref": "#/components/schemas/TemporaryOrder" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/one-time/orders": { "get": { "summary": "Latest 100 temporary orders", "description": "", "operationId": "get_one_time_orders", "parameters": [], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/TemporaryOrder" } }, "limit": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/one-time/orders/{id}": { "get": { "summary": "Temporary order, SMS and refund", "description": "", "operationId": "get_one_time_orders_id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^OT-[A-Z0-9]{16}$" } } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "order": { "$ref": "#/components/schemas/TemporaryOrder" } }, "required": [], "additionalProperties": false } } } }, "202": { "description": "Processing; query the original operation. Do not create a replacement purchase.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "order": { "$ref": "#/components/schemas/TemporaryOrder" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/one-time/orders/{id}/cancel": { "post": { "summary": "Cancel a temporary number", "description": "", "operationId": "post_one_time_orders_id_cancel", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^OT-[A-Z0-9]{16}$" } } ], "responses": { "200": { "description": "Inspect the returned business state; HTTP success alone does not prove delivery.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "order": { "$ref": "#/components/schemas/TemporaryOrder" } }, "required": [], "additionalProperties": false } } } }, "202": { "description": "Processing; query the original operation. Do not create a replacement purchase.", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "const": true }, "order": { "$ref": "#/components/schemas/TemporaryOrder" } }, "required": [], "additionalProperties": false } } } }, "400": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "API error; 429 includes Retry-After. Network/site-level limits can also apply.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } } } } }, "components": { "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "X-Api-Key" } }, "schemas": { "Error": { "type": "object", "properties": { "ok": { "const": false }, "success": { "const": false }, "error": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "request_id": { "type": [ "string", "null" ] }, "charge_status": { "type": [ "string", "null" ], "enum": [ "charged", "not_charged", "unknown" ] }, "retry_after": { "type": [ "number", "null" ] }, "unit_price": { "type": [ "number", "null", "string" ] }, "total_price": { "type": [ "number", "null", "string" ] }, "currency": { "type": [ "string", "null" ] }, "max_quantity": { "type": [ "integer", "null" ] }, "expiry": { "type": [ "integer", "null" ] } }, "required": [ "code", "message", "request_id" ], "additionalProperties": false }, "request_id": { "type": [ "string", "null" ] }, "public_ref": { "type": [ "string", "null" ] }, "request_status": { "type": [ "string", "null" ] }, "payment_state": { "type": [ "string", "null" ] }, "retry_purchase": { "type": "boolean" }, "status": { "type": [ "string", "null" ] } }, "required": [ "error" ], "additionalProperties": false }, "Number": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "tel": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "end_time": { "type": [ "string", "null" ], "description": "Receipt expiry. Unix seconds/milliseconds or date-time; no offset means UTC+08:00. Nullable before delivery." }, "session_end": { "type": [ "string", "null" ] }, "sms_count": { "type": [ "integer", "null" ] } }, "required": [], "additionalProperties": false }, "Limits": { "type": "object", "properties": { "max_quantity": { "type": [ "number", "null" ] }, "daily_count": { "type": [ "number", "null" ] }, "daily_quantity": { "type": [ "number", "null" ] }, "daily_spend": { "type": [ "number", "null" ] } }, "required": [], "additionalProperties": false }, "Product": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "app_id": { "type": [ "integer", "null" ] }, "cate_id": { "type": [ "integer", "null" ] }, "type": { "type": [ "integer", "null" ] }, "stock": { "type": [ "number", "null", "string" ] }, "stock_state": { "type": [ "string", "null" ] }, "price": { "type": [ "number", "null" ] }, "price_t1": { "type": [ "number", "null" ] }, "price_t2": { "type": [ "number", "null" ] }, "price_t3": { "type": [ "number", "null" ] }, "expiry": { "type": [ "integer", "null" ] }, "currency": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "name_en": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "country_en": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false }, "LongOrder": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "order_reference": { "type": [ "string", "null" ] }, "app_name": { "type": [ "string", "null" ] }, "quantity": { "type": [ "integer", "null" ] }, "unit_price": { "type": [ "number", "null", "string" ] }, "total_price": { "type": [ "number", "null", "string" ] }, "status": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "purchased_at": { "type": [ "string", "null" ] }, "item_ids": { "type": [ "string", "null" ] }, "numbers": { "type": [ "string", "null" ] }, "item_statuses": { "type": [ "string", "null" ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Number" } } }, "required": [], "additionalProperties": false }, "Purchase": { "type": "object", "properties": { "ok": { "type": "boolean" }, "success": { "type": "boolean" }, "status": { "type": [ "string", "null" ] }, "request_id": { "type": [ "string", "null" ] }, "public_ref": { "type": [ "string", "null" ] }, "request_status": { "type": [ "string", "null" ] }, "payment_state": { "type": [ "string", "null" ] }, "retry_purchase": { "type": "boolean" }, "charge_status": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "data": { "type": "object", "properties": { "order_reference": { "type": [ "string", "null" ] }, "app_id": { "type": [ "integer", "null" ] }, "app_name": { "type": [ "string", "null" ] }, "count": { "type": [ "integer", "null" ] }, "total_charged": { "type": [ "number", "null" ] }, "balance_remaining": { "type": [ "number", "null" ] }, "session_minutes": { "type": [ "integer", "null" ] }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/Number" } } }, "required": [], "additionalProperties": false }, "error": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "message": { "type": [ "string", "null" ] }, "request_id": { "type": [ "string", "null" ] }, "charge_status": { "type": [ "string", "null" ], "enum": [ "charged", "not_charged", "unknown" ] }, "retry_after": { "type": [ "number", "null" ] }, "unit_price": { "type": [ "number", "null", "string" ] }, "total_price": { "type": [ "number", "null", "string" ] }, "currency": { "type": [ "string", "null" ] }, "max_quantity": { "type": [ "integer", "null" ] }, "expiry": { "type": [ "integer", "null" ] } }, "required": [ "code", "message", "request_id" ], "additionalProperties": false } }, "required": [], "additionalProperties": false }, "TemporaryQuote": { "type": "object", "properties": { "id": { "type": [ "string", "null" ], "format": "uuid" }, "service": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false }, "country": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false }, "price": { "type": "object", "properties": { "amount": { "type": [ "number", "null" ] }, "currency": { "const": "USD" } }, "required": [], "additionalProperties": false }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [], "additionalProperties": false }, "TemporaryOrder": { "type": "object", "properties": { "id": { "type": [ "string", "null" ] }, "state": { "type": [ "string", "null" ], "enum": [ "processing", "waiting_sms", "sms_received", "cancel_pending", "refunded", "completed", "failed" ] }, "number": { "type": [ "string", "null" ] }, "sms_code": { "type": [ "string", "null" ] }, "sms_text": { "type": [ "string", "null" ] }, "expires_at": { "type": [ "string", "null" ] }, "cancel_available": { "type": "boolean" }, "cancel_available_at": { "type": [ "string", "null" ] }, "charge_status": { "type": [ "string", "null" ] }, "refund_pending": { "type": "boolean" }, "review_required": { "type": "boolean" }, "sms_received_at": { "type": [ "string", "null" ] }, "server_now": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "string", "null" ] }, "service": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false }, "country": { "type": "object", "properties": { "code": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false }, "price": { "type": "object", "properties": { "amount": { "type": [ "number", "null" ] }, "currency": { "const": "USD" } }, "required": [], "additionalProperties": false }, "failure_reason": { "type": [ "string", "null" ] }, "refund": { "type": "object", "properties": { "status": { "type": [ "string", "null" ], "enum": [ "none", "pending", "refunded" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "const": "USD" } }, "required": [], "additionalProperties": false } }, "required": [], "additionalProperties": false }, "Renewal": { "type": "object", "properties": { "operation_id": { "type": [ "string", "null" ] }, "item_id": { "type": [ "integer", "null" ] }, "state": { "type": [ "string", "null" ] }, "eligible": { "type": "boolean" }, "reason": { "type": [ "string", "null" ] }, "price_cents": { "type": [ "integer", "null", "string" ] }, "currency": { "type": [ "string", "null" ] }, "unit_months": { "type": [ "integer", "null" ] }, "quote_expires_at": { "type": [ "number", "null" ], "description": "Unix milliseconds" }, "payment_state": { "type": [ "string", "null" ] }, "end_time": { "type": [ "string", "null" ] }, "current_end_time": { "type": [ "string", "null" ] }, "telephone": { "type": [ "string", "null" ] }, "project_name": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false }, "SMS": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "item_id": { "type": [ "integer", "null" ] }, "tel": { "type": [ "string", "null" ] }, "content": { "type": [ "string", "null" ] }, "otp_code": { "type": [ "string", "null" ] }, "received_at": { "type": [ "string", "null" ] }, "recorded_at": { "type": [ "string", "null" ] }, "source_received_at": { "type": [ "string", "null" ] }, "app_name": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false }, "Transaction": { "type": "object", "properties": { "id": { "type": [ "integer", "null" ] }, "type": { "type": [ "string", "null" ] }, "amount": { "type": [ "string", "null" ] }, "balance_after": { "type": [ "string", "null" ] }, "order_reference": { "type": [ "string", "null" ] }, "renewal_operation_id": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ] }, "note": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false } } } }