{ "components": { "schemas": { "_BandaDoBot": { "additionalProperties": false, "properties": { "atende": { "title": "Atende", "type": "boolean" }, "band": { "title": "Band", "type": "string" }, "is_default": { "title": "Is Default", "type": "boolean" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "stock": { "title": "Stock", "type": "integer" } }, "required": [ "price_cents", "band", "stock", "is_default", "atende" ], "title": "_BandaDoBot", "type": "object" }, "_CompraDoBot": { "additionalProperties": false, "properties": { "band": { "pattern": "^[0-9a-f]{16}$", "title": "Band", "type": "string" }, "expected_price_cents": { "minimum": 0.0, "title": "Expected Price Cents", "type": "integer" }, "quantity": { "default": 1, "minimum": 1.0, "title": "Quantity", "type": "integer" }, "service_slug": { "maxLength": 120, "minLength": 1, "title": "Service Slug", "type": "string" } }, "required": [ "service_slug", "expected_price_cents", "band" ], "title": "_CompraDoBot", "type": "object" }, "_ContagemDoBot": { "additionalProperties": false, "properties": { "cancelado": { "title": "Cancelado", "type": "integer" }, "com_codigo": { "title": "Com Codigo", "type": "integer" }, "esperando": { "title": "Esperando", "type": "integer" }, "estornado": { "title": "Estornado", "type": "integer" }, "expirado": { "title": "Expirado", "type": "integer" }, "recebido": { "title": "Recebido", "type": "integer" } }, "required": [ "com_codigo", "esperando", "recebido", "expirado", "estornado", "cancelado" ], "title": "_ContagemDoBot", "type": "object" }, "_CotacaoDoBot": { "additionalProperties": false, "properties": { "band": { "title": "Band", "type": "string" }, "bands": { "items": { "$ref": "#/components/schemas/_BandaDoBot" }, "title": "Bands", "type": "array" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "quantity": { "title": "Quantity", "type": "integer" }, "service_slug": { "title": "Service Slug", "type": "string" }, "total_cents": { "title": "Total Cents", "type": "integer" } }, "required": [ "service_slug", "quantity", "price_cents", "band", "total_cents", "bands" ], "title": "_CotacaoDoBot", "type": "object" }, "_FalhaDoBot": { "additionalProperties": false, "properties": { "code": { "title": "Code", "type": "string" }, "message": { "title": "Message", "type": "string" } }, "required": [ "code", "message" ], "title": "_FalhaDoBot", "type": "object" }, "_FiltroDoBot": { "additionalProperties": false, "properties": { "ate": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "Ate" }, "de": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "title": "De" }, "desfecho": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Desfecho" }, "q": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Q" } }, "required": [ "desfecho", "de", "ate", "q" ], "title": "_FiltroDoBot", "type": "object" }, "_PedidoDoBot": { "additionalProperties": false, "properties": { "batch_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Batch Id" }, "can_cancel_at": { "format": "date-time", "title": "Can Cancel At", "type": "string" }, "can_retry": { "title": "Can Retry", "type": "boolean" }, "code_times": { "items": { "format": "date-time", "type": "string" }, "title": "Code Times", "type": "array" }, "codes": { "items": { "type": "string" }, "title": "Codes", "type": "array" }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Country" }, "created_at": { "format": "date-time", "title": "Created At", "type": "string" }, "expires_at": { "format": "date-time", "title": "Expires At", "type": "string" }, "id": { "title": "Id", "type": "integer" }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Phone" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "service_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Name" }, "service_slug": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Service Slug" }, "status": { "enum": [ "pending", "active", "received", "completed", "cancelled", "expired", "refunded" ], "title": "Status", "type": "string" } }, "required": [ "id", "batch_id", "service_slug", "service_name", "country", "phone", "status", "codes", "code_times", "price_cents", "created_at", "expires_at", "can_cancel_at", "can_retry" ], "title": "_PedidoDoBot", "type": "object" }, "_PedidosDoBot": { "additionalProperties": false, "properties": { "contagem": { "$ref": "#/components/schemas/_ContagemDoBot" }, "filtro": { "$ref": "#/components/schemas/_FiltroDoBot" }, "orders": { "items": { "$ref": "#/components/schemas/_PedidoDoBot" }, "title": "Orders", "type": "array" }, "page": { "title": "Page", "type": "integer" }, "per_page": { "title": "Per Page", "type": "integer" }, "total": { "title": "Total", "type": "integer" } }, "required": [ "orders", "page", "per_page", "total", "contagem", "filtro" ], "title": "_PedidosDoBot", "type": "object" }, "_ResultadoDaCompraDoBot": { "additionalProperties": false, "properties": { "batch_id": { "anyOf": [ { "format": "uuid", "type": "string" }, { "type": "null" } ], "title": "Batch Id" }, "charged_cents": { "title": "Charged Cents", "type": "integer" }, "failures": { "items": { "$ref": "#/components/schemas/_FalhaDoBot" }, "title": "Failures", "type": "array" }, "orders": { "items": { "$ref": "#/components/schemas/_PedidoDoBot" }, "title": "Orders", "type": "array" }, "refunded_cents": { "title": "Refunded Cents", "type": "integer" } }, "required": [ "batch_id", "orders", "failures", "charged_cents", "refunded_cents" ], "title": "_ResultadoDaCompraDoBot", "type": "object" }, "_ServicoDoBot": { "additionalProperties": false, "properties": { "country": { "title": "Country", "type": "string" }, "name": { "title": "Name", "type": "string" }, "price_cents": { "title": "Price Cents", "type": "integer" }, "slug": { "title": "Slug", "type": "string" }, "stock": { "title": "Stock", "type": "integer" } }, "required": [ "slug", "name", "country", "price_cents", "stock" ], "title": "_ServicoDoBot", "type": "object" }, "_ServicosDoBot": { "additionalProperties": false, "properties": { "services": { "items": { "$ref": "#/components/schemas/_ServicoDoBot" }, "title": "Services", "type": "array" } }, "required": [ "services" ], "title": "_ServicosDoBot", "type": "object" } } }, "info": { "summary": "Venda de números virtuais para verificação por SMS", "title": "Plataforma SMS", "version": "0.1.0" }, "openapi": "3.1.0", "paths": { "/api/v1/integration/balance": { "get": { "operationId": "saldo_api_v1_integration_balance_get", "responses": { "200": { "content": { "application/json": { "schema": { "additionalProperties": { "type": "integer" }, "title": "Response 200 Saldo Api V1 Integration Balance Get", "type": "object" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "UNAUTHORIZED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` UNAUTHORIZED." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ACCOUNT_DISABLED", "EMAIL_NOT_VERIFIED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ACCOUNT_DISABLED, EMAIL_NOT_VERIFIED." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "RATE_LIMITED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` RATE_LIMITED.", "headers": { "Retry-After": { "description": "Segundos até a próxima chamada ser aceita.", "schema": { "type": "integer" } } } }, "500": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` INTERNAL_ERROR." } }, "summary": "O saldo da conta, para o bot", "tags": [ "integration" ] } }, "/api/v1/integration/orders": { "get": { "operationId": "listar_api_v1_integration_orders_get", "parameters": [ { "in": "query", "name": "page", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Page", "type": "integer" } }, { "in": "query", "name": "per_page", "required": false, "schema": { "default": 20, "maximum": 100, "minimum": 1, "title": "Per Page", "type": "integer" } }, { "in": "query", "name": "desfecho", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Desfecho" } }, { "in": "query", "name": "de", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "De" } }, { "in": "query", "name": "ate", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Ate" } }, { "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "maxLength": 120, "type": "string" }, { "type": "null" } ], "title": "Q" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_PedidosDoBot" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "UNAUTHORIZED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` UNAUTHORIZED." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ACCOUNT_DISABLED", "EMAIL_NOT_VERIFIED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ACCOUNT_DISABLED, EMAIL_NOT_VERIFIED." }, "422": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "VALIDATION_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` VALIDATION_ERROR." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "RATE_LIMITED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` RATE_LIMITED.", "headers": { "Retry-After": { "description": "Segundos até a próxima chamada ser aceita.", "schema": { "type": "integer" } } } }, "500": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` INTERNAL_ERROR." } }, "summary": "Os pedidos da conta, para o bot", "tags": [ "integration" ] }, "post": { "operationId": "comprar_api_v1_integration_orders_post", "parameters": [ { "in": "header", "name": "Idempotency-Key", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Idempotency-Key" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_CompraDoBot" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_ResultadoDaCompraDoBot" } } }, "description": "Successful Response", "headers": { "Idempotent-Replayed": { "description": "`true` só quando a resposta é a repetição de uma compra anterior com a mesma chave.", "schema": { "type": "string" } } } }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "UNAUTHORIZED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` UNAUTHORIZED." }, "402": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "INSUFFICIENT_BALANCE" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` INSUFFICIENT_BALANCE." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ACCOUNT_DISABLED", "EMAIL_NOT_VERIFIED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ACCOUNT_DISABLED, EMAIL_NOT_VERIFIED." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "NOT_FOUND" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` NOT_FOUND." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "BAND_GONE", "IDEMPOTENCY_IN_PROGRESS", "IDEMPOTENCY_KEY_REUSED", "LOW_CONFIRMATION_RATE", "PRICE_CHANGED", "TOO_MANY_OPEN_ORDERS" ], "type": "string" }, "message": { "type": "string" }, "refunded_cents": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` BAND_GONE, IDEMPOTENCY_IN_PROGRESS, IDEMPOTENCY_KEY_REUSED, LOW_CONFIRMATION_RATE, PRICE_CHANGED, TOO_MANY_OPEN_ORDERS." }, "422": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "IDEMPOTENCY_KEY_REQUIRED", "VALIDATION_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` IDEMPOTENCY_KEY_REQUIRED, VALIDATION_ERROR." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "RATE_LIMITED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` RATE_LIMITED.", "headers": { "Retry-After": { "description": "Segundos até a próxima chamada ser aceita.", "schema": { "type": "integer" } } } }, "500": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` INTERNAL_ERROR." }, "502": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "PROVIDER_ERROR", "PROVIDER_OUT_OF_FUNDS" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` PROVIDER_ERROR, PROVIDER_OUT_OF_FUNDS." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "SERVICE_UNAVAILABLE" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` SERVICE_UNAVAILABLE." } }, "summary": "Compra um ou mais números, para o bot", "tags": [ "integration" ] } }, "/api/v1/integration/orders/{order_id}": { "get": { "operationId": "detalhe_api_v1_integration_orders__order_id__get", "parameters": [ { "in": "path", "name": "order_id", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": -9223372036854775808, "title": "Order Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_PedidoDoBot" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "UNAUTHORIZED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` UNAUTHORIZED." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ACCOUNT_DISABLED", "EMAIL_NOT_VERIFIED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ACCOUNT_DISABLED, EMAIL_NOT_VERIFIED." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "NOT_FOUND" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` NOT_FOUND." }, "422": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "VALIDATION_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` VALIDATION_ERROR." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "RATE_LIMITED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` RATE_LIMITED.", "headers": { "Retry-After": { "description": "Segundos até a próxima chamada ser aceita.", "schema": { "type": "integer" } } } }, "500": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` INTERNAL_ERROR." } }, "summary": "Um pedido da conta, para o bot", "tags": [ "integration" ] } }, "/api/v1/integration/orders/{order_id}/cancel": { "post": { "operationId": "cancelar_api_v1_integration_orders__order_id__cancel_post", "parameters": [ { "in": "path", "name": "order_id", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": -9223372036854775808, "title": "Order Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_PedidoDoBot" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "UNAUTHORIZED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` UNAUTHORIZED." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ACCOUNT_DISABLED", "EMAIL_NOT_VERIFIED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ACCOUNT_DISABLED, EMAIL_NOT_VERIFIED." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "NOT_FOUND" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` NOT_FOUND." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ORDER_NOT_CANCELLABLE" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ORDER_NOT_CANCELLABLE." }, "422": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "CANCEL_TOO_EARLY", "VALIDATION_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` CANCEL_TOO_EARLY, VALIDATION_ERROR." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "RATE_LIMITED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` RATE_LIMITED.", "headers": { "Retry-After": { "description": "Segundos até a próxima chamada ser aceita.", "schema": { "type": "integer" } } } }, "500": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` INTERNAL_ERROR." }, "502": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "PROVIDER_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` PROVIDER_ERROR." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "SERVICE_UNAVAILABLE" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` SERVICE_UNAVAILABLE." } }, "summary": "Cancela e estorna, para o bot", "tags": [ "integration" ] } }, "/api/v1/integration/orders/{order_id}/confirm": { "post": { "operationId": "confirmar_api_v1_integration_orders__order_id__confirm_post", "parameters": [ { "in": "path", "name": "order_id", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": -9223372036854775808, "title": "Order Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_PedidoDoBot" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "UNAUTHORIZED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` UNAUTHORIZED." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ACCOUNT_DISABLED", "EMAIL_NOT_VERIFIED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ACCOUNT_DISABLED, EMAIL_NOT_VERIFIED." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "NOT_FOUND" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` NOT_FOUND." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ORDER_NOT_CONFIRMABLE" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ORDER_NOT_CONFIRMABLE." }, "422": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "VALIDATION_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` VALIDATION_ERROR." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "RATE_LIMITED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` RATE_LIMITED.", "headers": { "Retry-After": { "description": "Segundos até a próxima chamada ser aceita.", "schema": { "type": "integer" } } } }, "500": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` INTERNAL_ERROR." } }, "summary": "Conclui o pedido, para o bot", "tags": [ "integration" ] } }, "/api/v1/integration/orders/{order_id}/retry": { "post": { "operationId": "reenviar_api_v1_integration_orders__order_id__retry_post", "parameters": [ { "in": "path", "name": "order_id", "required": true, "schema": { "maximum": 9223372036854775807, "minimum": -9223372036854775808, "title": "Order Id", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_PedidoDoBot" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "UNAUTHORIZED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` UNAUTHORIZED." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ACCOUNT_DISABLED", "EMAIL_NOT_VERIFIED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ACCOUNT_DISABLED, EMAIL_NOT_VERIFIED." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "NOT_FOUND" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` NOT_FOUND." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ORDER_NOT_RETRIABLE" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ORDER_NOT_RETRIABLE." }, "422": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "RETRY_BEFORE_FIRST_CODE", "RETRY_WINDOW_CLOSED", "VALIDATION_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` RETRY_BEFORE_FIRST_CODE, RETRY_WINDOW_CLOSED, VALIDATION_ERROR." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "RATE_LIMITED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` RATE_LIMITED.", "headers": { "Retry-After": { "description": "Segundos até a próxima chamada ser aceita.", "schema": { "type": "integer" } } } }, "500": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` INTERNAL_ERROR." }, "502": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "PROVIDER_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` PROVIDER_ERROR." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "SERVICE_UNAVAILABLE" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` SERVICE_UNAVAILABLE." } }, "summary": "Pede outro SMS, para o bot", "tags": [ "integration" ] } }, "/api/v1/integration/quote": { "get": { "operationId": "cotar_api_v1_integration_quote_get", "parameters": [ { "in": "query", "name": "service_slug", "required": true, "schema": { "maxLength": 120, "minLength": 1, "title": "Service Slug", "type": "string" } }, { "in": "query", "name": "quantity", "required": false, "schema": { "default": 1, "minimum": 1, "title": "Quantity", "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_CotacaoDoBot" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "UNAUTHORIZED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` UNAUTHORIZED." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ACCOUNT_DISABLED", "EMAIL_NOT_VERIFIED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ACCOUNT_DISABLED, EMAIL_NOT_VERIFIED." }, "404": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "NOT_FOUND" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` NOT_FOUND." }, "409": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "BAND_GONE", "TOO_MANY_OPEN_ORDERS" ], "type": "string" }, "message": { "type": "string" }, "refunded_cents": { "type": "integer" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` BAND_GONE, TOO_MANY_OPEN_ORDERS." }, "422": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "VALIDATION_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` VALIDATION_ERROR." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "RATE_LIMITED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` RATE_LIMITED.", "headers": { "Retry-After": { "description": "Segundos até a próxima chamada ser aceita.", "schema": { "type": "integer" } } } }, "500": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` INTERNAL_ERROR." }, "502": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "PROVIDER_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` PROVIDER_ERROR." }, "503": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "SERVICE_UNAVAILABLE" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` SERVICE_UNAVAILABLE." } }, "summary": "Cota um serviço, para o bot", "tags": [ "integration" ] } }, "/api/v1/integration/services": { "get": { "operationId": "servicos_api_v1_integration_services_get", "parameters": [ { "in": "query", "name": "q", "required": false, "schema": { "anyOf": [ { "maxLength": 120, "type": "string" }, { "type": "null" } ], "title": "Q" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/_ServicosDoBot" } } }, "description": "Successful Response" }, "401": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "UNAUTHORIZED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` UNAUTHORIZED." }, "403": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "ACCOUNT_DISABLED", "EMAIL_NOT_VERIFIED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` ACCOUNT_DISABLED, EMAIL_NOT_VERIFIED." }, "422": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "VALIDATION_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` VALIDATION_ERROR." }, "429": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "RATE_LIMITED" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` RATE_LIMITED.", "headers": { "Retry-After": { "description": "Segundos até a próxima chamada ser aceita.", "schema": { "type": "integer" } } } }, "500": { "content": { "application/json": { "schema": { "properties": { "error": { "properties": { "code": { "enum": [ "INTERNAL_ERROR" ], "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "type": "object" } }, "required": [ "error" ], "type": "object" } } }, "description": "Recusa com `code` INTERNAL_ERROR." } }, "summary": "Os serviços à venda, para o bot", "tags": [ "integration" ] } } }, "servers": [ { "url": "https://api.smsvex.com" } ] }