{ "openapi": "3.1.0", "info": { "title": "SIM Bridge API for Moventis", "version": "7.1.24", "description": "Per-company Android SMS gateway. Company API keys are isolated from other companies. HTTP 202 means queued, not delivered. Webhook events carry X-Event-Id and X-SimBridge-Signature (sha256=HMAC of the raw body)." }, "servers": [ { "url": "https://simbridge.rentauto24.com" } ], "paths": { "/v1/workspaces": { "get": { "summary": "List accessible companies", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Workspace" } }, "operator": { "type": "boolean" }, "currentWorkspaceId": { "type": "string" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Create a client company", "description": "Requires workspaces:create.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80 }, "externalId": { "type": "string", "maxLength": 128, "description": "Stable Moventis company ID. Retries return the existing company (200)." }, "emails": { "type": "array", "maxItems": 50, "items": { "type": "string", "format": "email" } } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workspace" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/workspaces/{id}/members": { "put": { "summary": "Replace invited Google users", "description": "Requires members:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": { "type": "array", "maxItems": 50, "items": { "type": "string", "format": "email" } } }, "required": [ "emails" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workspace" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/keys": { "get": { "summary": "List company API keys", "description": "Requires keys:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey" } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Create a scoped company API key", "description": "Requires keys:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "scopes": { "type": "array", "items": { "enum": [ "sms:send", "sms:read", "devices:read", "devices:write", "keys:write", "webhook:write", "members:write", "audit:read", "workspaces:create", "workspaces:read" ] } }, "expiresInDays": { "type": "integer", "minimum": 1, "maximum": 365, "default": 90 } } } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/keys/{id}": { "delete": { "summary": "Revoke API key immediately", "description": "Requires keys:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/devices": { "get": { "summary": "List company phones and connectivity", "description": "Requires devices:read.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Device" } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/devices/pairings": { "post": { "summary": "Create a one-time phone pairing code and QR PNG (10 minutes)", "description": "Requires devices:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } } } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pairing" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/devices/{id}": { "get": { "summary": "Get a company phone", "description": "Requires devices:read.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "summary": "Rename phone or set minimum send interval", "description": "Requires devices:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 80 }, "sendIntervalSeconds": { "type": "integer", "minimum": 5, "maximum": 3600 } } } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Revoke phone token and fail its queued jobs", "description": "Requires devices:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/sms/send": { "post": { "summary": "Queue an SMS from a company phone", "description": "Requires sms:send.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "maxLength": 128 }, "description": "Use a stable unique value for each order notification. Repeating identical content in the same workspace returns the original message (200). Different content returns 409." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendSMS" } } } }, "responses": { "200": { "description": "Existing idempotent message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "202": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/messages": { "get": { "summary": "List messages with filters and cursor pagination", "description": "Requires sms:read.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "direction", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "deviceId", "in": "query", "schema": { "type": "string" } }, { "name": "externalId", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } }, "nextCursor": { "type": [ "string", "null" ] } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/messages/{id}": { "get": { "summary": "Get SMS status and order reference", "description": "Requires sms:read.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/messages/{id}/cancel": { "post": { "summary": "Cancel a queued SMS; claimed SMS cannot be cancelled", "description": "Requires sms:send.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Message" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/webhook": { "get": { "summary": "Get company webhook configuration (without secret)", "description": "Requires webhook:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Set/disable HTTPS webhook or rotate signing secret", "description": "Requires webhook:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "description": "Public HTTPS endpoint; empty string disables." }, "rotateSecret": { "type": "boolean" } }, "required": [ "url" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/events": { "get": { "summary": "List last 100 webhook attempts", "description": "Requires webhook:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/Event" } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/events/{id}/retry": { "post": { "summary": "Retry a failed or previously disabled event", "description": "Requires webhook:write.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/enterprise/apps": { "get": { "summary": "List enterprise applications and their keys", "description": "Service operator only.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/EnterpriseApp" } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Create enterprise access (key returned once)", "description": "Service operator only.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 120 }, "scopes": { "type": "array", "items": { "enum": [ "sms:send", "sms:read", "devices:read", "devices:write", "keys:write", "webhook:write", "members:write", "audit:read", "workspaces:create", "workspaces:read" ] } }, "expiresInDays": { "type": "integer", "minimum": 1, "maximum": 365, "default": 90 } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "key": { "$ref": "#/components/schemas/ApiKey" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/enterprise/apps/{id}/keys": { "post": { "summary": "Issue additional enterprise key; old keys remain valid until revoked", "description": "Service operator only.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 120 }, "scopes": { "type": "array", "items": { "enum": [ "sms:send", "sms:read", "devices:read", "devices:write", "keys:write", "webhook:write", "members:write", "audit:read", "workspaces:create", "workspaces:read" ] } }, "expiresInDays": { "type": "integer", "minimum": 1, "maximum": 365, "default": 90 } }, "required": [ "name" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiKey" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/enterprise/apps/{id}": { "delete": { "summary": "Revoke application, all company keys and devices", "description": "Service operator only.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/enterprise/apps/{id}/keys/{keyId}": { "delete": { "summary": "Revoke one enterprise key", "description": "Service operator only.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "keyId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/v1/audit": { "get": { "summary": "Last 100 company audit records", "description": "Requires audit:read.", "security": [ { "ApiKey": [] }, { "BearerKey": [] }, { "BrowserSession": [] } ], "parameters": [ { "name": "X-Workspace-Id", "in": "header", "required": false, "schema": { "type": "string" }, "description": "Required for company-scoped methods with enterprise keys. Operator/browser accounts may select a workspace. Company keys identify their workspace; another workspace is rejected." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "actor": { "type": "string" }, "action": { "type": "string" }, "resourceId": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" } } } } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/device/pair": { "post": { "summary": "Redeem a one-use code on an Android phone", "security": [], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string", "maxLength": 80 } }, "required": [ "code" ] } } } }, "responses": { "201": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "deviceId": { "type": "string" }, "workspaceId": { "type": "string" }, "workspaceName": { "type": "string" }, "token": { "type": "string" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/device/poll": { "post": { "summary": "Heartbeat and claim the next job; retry never returns the same claimed job", "security": [ { "PhoneToken": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "job": { "oneOf": [ { "$ref": "#/components/schemas/Message" }, { "type": "null" } ] } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/device/status": { "post": { "summary": "Report Android modem or delivery result", "security": [ { "PhoneToken": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "enum": [ "sent", "failed", "delivered" ] }, "error": { "type": "string", "maxLength": 300 } }, "required": [ "id", "status" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/device/inbound": { "post": { "summary": "Submit an inbound SMS, deduplicated by device and eventId", "security": [ { "PhoneToken": [] } ], "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "eventId": { "type": "string", "maxLength": 128 }, "phoneNumber": { "type": "string" }, "message": { "type": "string", "maxLength": 4000 } }, "required": [ "eventId", "phoneNumber", "message" ] } } } }, "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "type": "object", "properties": { "ok": { "type": "boolean" } } } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Authentication required or revoked key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Workspace/scope not permitted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Resource not found in this workspace", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflicting state or idempotency key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate/queue limit exceeded", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "securitySchemes": { "ApiKey": { "type": "apiKey", "in": "header", "name": "x-api-key" }, "BearerKey": { "type": "http", "scheme": "bearer" }, "BrowserSession": { "type": "apiKey", "in": "cookie", "name": "__Host-simbridge_session", "description": "Google browser session. Mutations additionally require the CSRF token from /auth/session and matching Origin." }, "PhoneToken": { "type": "http", "scheme": "bearer", "description": "Device token returned once by /device/pair" } }, "schemas": { "Error": { "type": "object", "properties": { "error": { "type": "string" } }, "required": [ "error" ] }, "Device": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "online": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "lastSeen": { "type": "string", "format": "date-time" }, "sendIntervalSeconds": { "type": "integer", "minimum": 5, "maximum": 3600 } } }, "Message": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "deviceId": { "type": "string" }, "direction": { "enum": [ "outbound", "inbound" ] }, "phoneNumber": { "type": "string" }, "message": { "type": "string" }, "status": { "enum": [ "queued", "claimed", "sent", "delivered", "failed", "unknown", "received", "cancelled" ] }, "externalId": { "type": [ "string", "null" ] }, "metadata": { "type": "object", "additionalProperties": true }, "createdAt": { "type": "string", "format": "date-time" }, "error": { "type": "string" } } }, "Workspace": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "members": { "type": "array", "items": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "role": { "const": "admin" } } } }, "webhook": { "$ref": "#/components/schemas/Webhook" }, "enterpriseAppId": { "type": [ "string", "null" ] }, "externalId": { "type": [ "string", "null" ] } } }, "ApiKey": { "type": "object", "properties": { "id": { "type": "string" }, "workspaceId": { "type": "string" }, "name": { "type": "string" }, "prefix": { "type": "string" }, "scopes": { "type": "array", "items": { "enum": [ "sms:send", "sms:read", "devices:read", "devices:write", "keys:write", "webhook:write", "members:write", "audit:read", "workspaces:create", "workspaces:read" ] } }, "createdAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": [ "string", "null" ] }, "apiKey": { "type": "string", "description": "Returned once, only when the key is created." }, "enterpriseAppId": { "type": [ "string", "null" ] }, "expiresAt": { "type": "string", "format": "date-time" } } }, "Pairing": { "type": "object", "properties": { "code": { "type": "string" }, "expires": { "type": "integer", "description": "Unix milliseconds" }, "workspaceId": { "type": "string" }, "serverUrl": { "type": "string", "format": "uri", "description": "Canonical HTTPS origin from APP_BASE_URL." }, "qrPayload": { "type": "string", "description": "JSON: type=simbridge-pairing, version=1, serverUrl, code, expires. Secret, expires after 10 minutes and is consumed once." }, "qrImageDataUrl": { "type": "string", "description": "PNG data URL. Use directly as an image src; no public QR endpoint or extra request needed." } } }, "Webhook": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "url": { "type": "string", "format": "uri" }, "secret": { "type": "string", "description": "Returned once on creation or secret rotation." } } }, "Event": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "enum": [ "sms.received", "sms.status" ] }, "workspaceId": { "type": "string" }, "payload": { "$ref": "#/components/schemas/Message" }, "status": { "enum": [ "pending", "processing", "delivered", "failed", "disabled" ] }, "attempts": { "type": "integer" }, "nextAt": { "type": "integer" }, "createdAt": { "type": "string", "format": "date-time" } } }, "SendSMS": { "type": "object", "properties": { "deviceId": { "type": "string" }, "phoneNumber": { "type": "string", "pattern": "^\\+[1-9]\\d{7,14}$" }, "message": { "type": "string", "minLength": 1, "maxLength": 1600 }, "externalId": { "type": "string", "maxLength": 128, "description": "Moventis order notification reference." }, "metadata": { "type": "object", "additionalProperties": true, "description": "Up to 2048 UTF-8 bytes; for example {orderId:\"123\"}." } }, "required": [ "deviceId", "phoneNumber", "message" ] }, "EnterpriseApp": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "revokedAt": { "type": [ "string", "null" ] }, "keys": { "type": "array", "items": { "$ref": "#/components/schemas/ApiKey" } } } } } } }