Server definition
- Hash
- sha256:09ca7b43a14c477a6abd9bab998184dd17d43a7ba04550e36e4529e315530476
- What it is
- What a remote MCP server returned when asked what it offers: 122 tools
The blob, as servednamed by its sha256
{
"instructions": "The Wavix MCP Server provides tools and documentation for the Wavix telecom platform (SMS/MMS, voice calls, 2FA, SIP trunking, phone numbers, speech analytics).\n\nDocumentation guidance:\n 1. Before answering conceptual questions about Wavix features (how a feature works, what parameters mean, billing, limits, integration patterns), read the relevant documentation resource under wavix://docs/* first. Do not rely on prior assumptions about telecom APIs - Wavix-specific behavior may differ.\n 2. To discover available documentation, list MCP resources and match by URI/title (e.g. wavix://docs/numbers/number-validator, wavix://docs/messaging/send-sms). The full OpenAPI specification is available at wavix://api/openapi.yaml.\n 3. Quote behavior from documentation rather than inferring it.\n\nTool selection guidance:\n 1. Use '*_list' tools for paginated retrieval with basic filters (e.g. my_numbers_list, sms_and_mms_messages_list).\n 2. Use '*_get' tools for fetching a single entity by ID.\n 3. Use '*_create' / '*_update' / '*_delete' tools for mutations - confirm with the user before destructive actions (delete, return-to-stock, cancel).\n\nContext management:\n 1. Default to small page sizes (per_page=10-25) unless the user asks for more.\n 2. For bulk validation or large lists, prefer asynchronous operations where available (e.g. number_validator_create_bulk with async=true) and poll for results.\n\nAuthentication:\n 1. The MCP client forwards the user's Wavix API key as a Bearer token. Do not ask the user for credentials - tools authenticate automatically.\n",
"tools": [
{
"description": "Activates an API key. Once activated, the API key can be used for authentication again.",
"inputSchema": {
"properties": {
"id": {
"description": "API key ID.",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "api_keys_activate",
"outputSchema": {
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Creates an API key. Optional IP restrictions can be configured to limit access.",
"inputSchema": {
"properties": {
"account": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "View and update account profile information and timezone."
},
"billing": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "Access invoices, balance, payment methods, usage reports, and billing settings, including payment method updates."
},
"calls": {
"allOf": [
{
"description": "Permission level for the `calls` scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET requests, `POST /v1/cdr`\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests."
},
"campaigns": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links."
},
"embeddable": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "Manage widget tokens, including listing, viewing, creating, updating, and deleting them."
},
"is_active": {
"default": true,
"description": "Indicates whether the API key should be activated upon creation.",
"example": true,
"type": "boolean"
},
"is_restriction": {
"default": false,
"description": "Indicates whether to restrict API key access by IP address. When enabled, only requests from IP addresses listed in `permitted_ips` are allowed.",
"example": true,
"type": "boolean"
},
"is_scopes_enabled": {
"default": false,
"description": "When `true`, scope fields below are enforced. When `false` (default), the\nkey has full access. Omitted scope fields default to `{ allow: none }`,\nso with `is_scopes_enabled: true` and no scopes set the key has no access.",
"example": true,
"type": "boolean"
},
"label": {
"description": "API key label.",
"example": "My API key",
"type": "string"
},
"messages": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs."
},
"numbers": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "View, buy, release, and configure phone numbers, browse inventory, and manage the cart."
},
"permitted_ips": {
"description": "List of permitted IP addresses for this API key. Each must be a valid IPv4 address. Required when `is_restriction` is true.",
"example": [
"192.168.1.1",
"10.0.0.1"
],
"items": {
"type": "string"
},
"type": "array"
},
"recordings": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "List, download, and delete call recordings."
},
"subaccounts": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "Manage subaccounts: list and view them, create, update, and suspend them."
},
"trunks": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "View, create, update, and delete SIP trunks and their settings."
},
"two_fa": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes."
},
"validator": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "View number validation results and trigger single or bulk validation or HLR lookup requests."
},
"webhooks": {
"allOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
}
],
"description": "List, create, and delete webhooks."
}
},
"required": [],
"type": "object"
},
"name": "api_keys_create",
"outputSchema": {
"description": "API key details including IP restrictions and scope permissions.",
"properties": {
"account": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View and update account profile information and timezone."
},
"billing": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Access invoices, balance, payment methods, usage reports, and billing settings, including payment method updates."
},
"calls": {
"anyOf": [
{
"description": "Permission level for the `calls` scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET requests, `POST /v1/cdr`\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests."
},
"campaigns": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links."
},
"created_at": {
"description": "Creation date and time in ISO 8601 format.",
"example": "2024-01-15T10:30:00Z",
"format": "date-time",
"type": "string"
},
"embeddable": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Manage widget tokens, including listing, viewing, creating, updating, and deleting them."
},
"id": {
"description": "API key ID.",
"example": 123,
"type": "integer"
},
"is_active": {
"description": "Indicates whether the API key is active.",
"example": true,
"type": "boolean"
},
"is_restriction": {
"description": "Indicates whether IP restrictions are enabled. When enabled,\n the API key works only from IP addresses in `permitted_ips`.",
"example": true,
"type": "boolean"
},
"is_scopes_enabled": {
"description": "When `true`, the key is restricted to the permissions defined in the\nscope fields below. When `false`, the key has full access.",
"example": true,
"type": "boolean"
},
"label": {
"description": "API key label.",
"example": "Production API Key",
"type": "string"
},
"last_used_at": {
"description": "Timestamp of the most recent authenticated request made with this key.",
"example": "2026-04-20T15:42:11Z",
"format": "date-time",
"type": [
"string",
"null"
]
},
"messages": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs."
},
"numbers": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View, buy, release, and configure phone numbers, browse inventory, and manage the cart."
},
"permitted_ips": {
"description": "List of permitted IP addresses. If `is_restriction` is false,\n an empty list means no IP restrictions. If `is_restriction` is true,\n an empty list prevents all requests.",
"example": [
"192.168.1.1",
"10.0.0.1"
],
"items": {
"type": "string"
},
"type": "array"
},
"recordings": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "List, download, and delete call recordings."
},
"subaccounts": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Manage subaccounts: list and view them, create, update, and suspend them."
},
"trunks": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View, create, update, and delete SIP trunks and their settings."
},
"two_fa": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes."
},
"validator": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View number validation results and trigger single or bulk validation or HLR lookup requests."
},
"value": {
"description": "API key value.",
"example": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
"type": "string"
},
"webhooks": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "List, create, and delete webhooks."
}
},
"required": [
"id",
"label",
"value",
"is_active",
"is_restriction",
"permitted_ips",
"is_scopes_enabled",
"last_used_at",
"numbers",
"trunks",
"calls",
"messages",
"recordings",
"campaigns",
"two_fa",
"validator",
"webhooks",
"embeddable",
"billing",
"account",
"subaccounts",
"created_at"
],
"type": "object"
}
},
{
"description": "Deactivates an API key. Once deactivated, the API key cannot be used for authentication.",
"inputSchema": {
"properties": {
"id": {
"description": "API key ID.",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "api_keys_deactivate",
"outputSchema": {
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Deletes an API key. This action is permanent.",
"inputSchema": {
"properties": {
"id": {
"description": "API key ID.",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "api_keys_delete",
"outputSchema": {
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Returns a list of API keys.",
"inputSchema": {
"properties": {
"label": {
"description": "Label to filter API keys. Partial match supported.",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "api_keys_list",
"outputSchema": {
"properties": {
"result": {
"items": {
"description": "API key details including IP restrictions and scope permissions.",
"properties": {
"account": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View and update account profile information and timezone."
},
"billing": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Access invoices, balance, payment methods, usage reports, and billing settings, including payment method updates."
},
"calls": {
"anyOf": [
{
"description": "Permission level for the `calls` scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET requests, `POST /v1/cdr`\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests."
},
"campaigns": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links."
},
"created_at": {
"description": "Creation date and time in ISO 8601 format.",
"example": "2024-01-15T10:30:00Z",
"format": "date-time",
"type": "string"
},
"embeddable": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Manage widget tokens, including listing, viewing, creating, updating, and deleting them."
},
"id": {
"description": "API key ID.",
"example": 123,
"type": "integer"
},
"is_active": {
"description": "Indicates whether the API key is active.",
"example": true,
"type": "boolean"
},
"is_restriction": {
"description": "Indicates whether IP restrictions are enabled. When enabled,\n the API key works only from IP addresses in `permitted_ips`.",
"example": true,
"type": "boolean"
},
"is_scopes_enabled": {
"description": "When `true`, the key is restricted to the permissions defined in the\nscope fields below. When `false`, the key has full access.",
"example": true,
"type": "boolean"
},
"label": {
"description": "API key label.",
"example": "Production API Key",
"type": "string"
},
"last_used_at": {
"description": "Timestamp of the most recent authenticated request made with this key.",
"example": "2026-04-20T15:42:11Z",
"format": "date-time",
"type": [
"string",
"null"
]
},
"messages": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs."
},
"numbers": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View, buy, release, and configure phone numbers, browse inventory, and manage the cart."
},
"permitted_ips": {
"description": "List of permitted IP addresses. If `is_restriction` is false,\n an empty list means no IP restrictions. If `is_restriction` is true,\n an empty list prevents all requests.",
"example": [
"192.168.1.1",
"10.0.0.1"
],
"items": {
"type": "string"
},
"type": "array"
},
"recordings": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "List, download, and delete call recordings."
},
"subaccounts": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "Manage subaccounts: list and view them, create, update, and suspend them."
},
"trunks": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View, create, update, and delete SIP trunks and their settings."
},
"two_fa": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes."
},
"validator": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "View number validation results and trigger single or bulk validation or HLR lookup requests."
},
"value": {
"description": "API key value.",
"example": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
"type": "string"
},
"webhooks": {
"anyOf": [
{
"description": "Permission level for an API key scope group.",
"properties": {
"allow": {
"default": "none",
"description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)",
"enum": [
"none",
"read",
"write"
],
"example": "read",
"type": "string"
}
},
"type": "object"
},
{
"type": "null"
}
],
"description": "List, create, and delete webhooks."
}
},
"required": [
"id",
"label",
"value",
"is_active",
"is_restriction",
"permitted_ips",
"is_scopes_enabled",
"last_used_at",
"numbers",
"trunks",
"calls",
"messages",
"recordings",
"campaigns",
"two_fa",
"validator",
"webhooks",
"embeddable",
"billing",
"account",
"subaccounts",
"created_at"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Get a download URL for a billing invoice PDF.\n\nReturns ``{download_url, content_type, status_code, note}`` instead of the\nbinary PDF stream. Fetch ``download_url`` to obtain the file.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"id": {
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "billing_invoices_download",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Returns a paginated list of financial statements.",
"inputSchema": {
"properties": {
"page": {
"description": "Page number to retrieve.",
"example": 1,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
}
},
"required": [],
"type": "object"
},
"name": "billing_invoices_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"invoices": {
"items": {
"additionalProperties": false,
"description": "An account financial statement",
"properties": {
"amount": {
"description": "Statement amount",
"example": "7.72",
"type": "string"
},
"from_date": {
"description": "Start of the billing period",
"example": "2023-07-01",
"format": "date",
"type": "string"
},
"id": {
"description": "Unique identifier of the statement",
"example": 43209,
"format": "int32",
"type": "integer"
},
"to_date": {
"description": "End of the billing period",
"example": "2023-07-31",
"format": "date",
"type": "string"
}
},
"required": [
"id",
"amount",
"from_date",
"to_date"
],
"title": "Invoice",
"type": "object"
},
"type": "array"
},
"is_empty": {
"description": "Indicates an empty invoice list",
"example": false,
"type": "boolean"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
}
},
"required": [
"is_empty",
"invoices",
"pagination"
],
"title": "InvoiceListResponse",
"type": "object"
},
{
"example": {
"invoices": [
{
"amount": "25.00",
"from_date": "2023-08-01",
"id": 1,
"to_date": "2023-08-31"
}
],
"is_empty": false,
"pagination": {
"current_page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
}
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a paginated list of financial transactions.",
"inputSchema": {
"properties": {
"details_contains": {
"description": "Transaction details for filtering.",
"example": "monthly",
"type": "string"
},
"from_date": {
"description": "Start date in `YYYY-MM-DD` format.",
"example": "2023-08-01",
"type": "string"
},
"page": {
"description": "Page number to retrieve.",
"example": 1,
"format": "int32",
"type": "integer"
},
"payments": {
"description": "Indicates whether to include account top-ups only.",
"example": true,
"type": "boolean"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"to_date": {
"description": "End date in `YYYY-MM-DD` format.",
"example": "2023-08-31",
"type": "string"
},
"type": {
"allOf": [
{
"description": "Transaction type:\n * 0 - Payment adjustment\n * 2 - DID activation fee\n * 3 - DID monthly fees\n * 6 - DID forwarding\n * 11 - PSTN forwarding fee\n * 14 - Outbound call\n * 15 - Outbound SMS\n * 19 - Credit card payment\n * 20 - Payment fee\n * 23 - Porting fee\n * 24 - Inbound SMS\n * 25 - Admin payment\n * 26 - Subscription payment\n * 29 - Number validator\n * 30 - Call recording\n * 31 - Storage charge\n * 32 - Campaign builder\n * 33 - Voicemail detection\n * 34 - Sender ID registration\n * 35 - Sender ID monthly fee\n * 36 - 2FA\n * 37 - IVR\n * 38 - E911 activation\n * 39 - Outbound MMS\n * 40 - Inbound MMS\n * 41 - Call transcription\n * 42 - 10DLC Brand registration\n * 43 - 10DLC Campaign registration\n * 44 - DID order\n * 45 - Adjustment in\n * 46 - URL shortener\n * 47 - 10DLC Brand update\n * 48 - 10DLC Brand appeal\n * 49 - Audio transcription\n * 50 - 10DLC Brand vetting\n * 51 - 10DLC Brand vetting appeal\n * 52 - Outbound SMS carrier fee\n * 53 - Inbound SMS carrier fee\n * 54 - Outbound MMS carrier fee\n * 55 - Inbound MMS carrier fee\n * 57 - Outbound SMS segment\n * 58 - Inbound SMS segment\n * 59 - Outbound MMS segment\n * 60 - Inbound MMS segment",
"enum": [
0,
2,
3,
6,
11,
14,
15,
19,
20,
23,
24,
25,
26,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60
],
"title": "TransactionType",
"type": "integer"
}
],
"description": "Filter by transaction type."
}
},
"required": [
"from_date",
"to_date"
],
"type": "object"
},
"name": "billing_transactions_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"is_empty": {
"description": "Indicates whether there are no transactions.",
"example": false,
"type": "boolean"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
},
"transactions": {
"description": "List of transactions.",
"example": [
{
"amount": -0.99,
"balance_after": 309.0601,
"date": "2023-08-29T14:48:38.000Z",
"details": "Monthly fee for 16419252149",
"id": 24789389,
"show_invoice": false,
"status": "Committed",
"type": 3
}
],
"items": {
"additionalProperties": false,
"description": "Financial transaction.",
"example": {
"amount": -0.99,
"balance_after": 309.0601,
"date": "2023-08-29T14:48:38.000Z",
"details": "Monthly fee for 16419252149",
"id": 24789389,
"show_invoice": false,
"status": "Committed",
"type": 3
},
"properties": {
"amount": {
"description": "Transaction amount. Negative values decrease balance.",
"example": -0.99,
"format": "float",
"type": "number"
},
"balance_after": {
"description": "Account balance after the transaction.",
"example": 309.0601,
"format": "float",
"type": "number"
},
"date": {
"description": "Creation date and time in ISO 8601 format.",
"example": "2023-08-29T14:48:38.000Z",
"format": "date-time",
"type": "string"
},
"details": {
"description": "Transaction details.",
"example": "Monthly fee for 16419252149",
"type": "string"
},
"id": {
"description": "Transaction ID.",
"example": 24789389,
"format": "int64",
"type": "integer"
},
"show_invoice": {
"description": "Indicates whether a transaction receipt is available. Receipts\n are available only for transaction types 0, 8, 9, 19, 23, and 25.",
"example": false,
"type": "boolean"
},
"status": {
"description": "Transaction status.",
"enum": [
"Created",
"Pending",
"Committed",
"Reverted"
],
"title": "TransactionStatus",
"type": "string"
},
"type": {
"description": "Transaction type:\n * 0 - Payment adjustment\n * 2 - DID activation fee\n * 3 - DID monthly fees\n * 6 - DID forwarding\n * 11 - PSTN forwarding fee\n * 14 - Outbound call\n * 15 - Outbound SMS\n * 19 - Credit card payment\n * 20 - Payment fee\n * 23 - Porting fee\n * 24 - Inbound SMS\n * 25 - Admin payment\n * 26 - Subscription payment\n * 29 - Number validator\n * 30 - Call recording\n * 31 - Storage charge\n * 32 - Campaign builder\n * 33 - Voicemail detection\n * 34 - Sender ID registration\n * 35 - Sender ID monthly fee\n * 36 - 2FA\n * 37 - IVR\n * 38 - E911 activation\n * 39 - Outbound MMS\n * 40 - Inbound MMS\n * 41 - Call transcription\n * 42 - 10DLC Brand registration\n * 43 - 10DLC Campaign registration\n * 44 - DID order\n * 45 - Adjustment in\n * 46 - URL shortener\n * 47 - 10DLC Brand update\n * 48 - 10DLC Brand appeal\n * 49 - Audio transcription\n * 50 - 10DLC Brand vetting\n * 51 - 10DLC Brand vetting appeal\n * 52 - Outbound SMS carrier fee\n * 53 - Inbound SMS carrier fee\n * 54 - Outbound MMS carrier fee\n * 55 - Inbound MMS carrier fee\n * 57 - Outbound SMS segment\n * 58 - Inbound SMS segment\n * 59 - Outbound MMS segment\n * 60 - Inbound MMS segment",
"enum": [
0,
2,
3,
6,
11,
14,
15,
19,
20,
23,
24,
25,
26,
29,
30,
31,
32,
33,
34,
35,
36,
37,
38,
39,
40,
41,
42,
43,
44,
45,
46,
47,
48,
49,
50,
51,
52,
53,
54,
55,
56,
57,
58,
59,
60
],
"title": "TransactionType",
"type": "integer"
}
},
"required": [
"id",
"date",
"amount",
"balance_after",
"details",
"status",
"type",
"show_invoice"
],
"title": "FinancialTransaction",
"type": "object"
},
"type": "array"
}
},
"required": [
"is_empty",
"transactions",
"pagination"
],
"title": "BillingTransactionListResponse",
"type": "object"
},
{
"example": {
"is_empty": false,
"pagination": {
"current_page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
},
"transactions": [
{
"amount": -0.99,
"balance_after": 309.0601,
"date": "2023-08-29T14:48:38.000Z",
"details": "Monthly fee for 16419252149",
"id": 24789389,
"show_invoice": false,
"status": "Committed",
"type": 3
}
]
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of cities for countries where\n `has_provinces_or_states` is `false`.",
"inputSchema": {
"properties": {
"country": {
"description": "Country ID.",
"example": 1891,
"format": "int32",
"type": "integer"
},
"text_enabled_only": {
"description": "Indicates whether to return only cities with text-enabled numbers.",
"type": "boolean"
}
},
"required": [
"country"
],
"type": "object"
},
"name": "buy_cities_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"cities": {
"items": {
"additionalProperties": false,
"properties": {
"area_code": {
"description": "Rate center.",
"type": "number"
},
"id": {
"description": "City ID.",
"example": 3213,
"format": "int32",
"type": "integer"
},
"name": {
"description": "City name.",
"example": "Paris",
"type": "string"
}
},
"required": [
"id",
"name",
"area_code"
],
"title": "City",
"type": "object"
},
"type": "array"
}
},
"required": [
"cities"
],
"title": "CityListResponse",
"type": "object"
},
{
"example": {
"cities": [
{
"area_code": 113,
"id": 128791,
"name": "Buenos Aires"
},
{
"area_code": 341,
"id": 132655,
"name": "Rosario"
},
{
"area_code": 351,
"id": 132656,
"name": "Cordoba"
},
{
"area_code": 381,
"id": 141803,
"name": "Tucuman"
},
{
"area_code": 387,
"id": 141986,
"name": "Salta"
}
]
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of countries where phone numbers are available.",
"inputSchema": {
"properties": {
"text_enabled_only": {
"description": "Indicates whether to return only countries with text-enabled phone numbers.",
"type": "boolean"
}
},
"required": [],
"type": "object"
},
"name": "buy_countries_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"countries": {
"items": {
"additionalProperties": false,
"properties": {
"has_provinces_or_states": {
"description": "Indicates whether the country has regions.",
"example": false,
"type": "boolean"
},
"id": {
"description": "Country ID.",
"example": 8148,
"format": "int32",
"type": "integer"
},
"name": {
"description": "Country name.",
"example": "France",
"type": "string"
}
},
"required": [
"id",
"name",
"has_provinces_or_states"
],
"title": "Country",
"type": "object"
},
"type": "array"
}
},
"required": [
"countries"
],
"title": "CountryListResponse",
"type": "object"
},
{
"example": {
"countries": [
{
"has_provinces_or_states": false,
"id": 8669,
"name": "Argentina"
},
{
"has_provinces_or_states": true,
"id": 8650,
"name": "Australia"
}
]
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a paginated list of phone numbers available for purchase.",
"inputSchema": {
"properties": {
"city": {
"description": "City ID.",
"format": "int32",
"type": "integer"
},
"country": {
"description": "Country ID.",
"format": "int32",
"type": "integer"
},
"page": {
"description": "Page number to retrieve.",
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"format": "int32",
"type": "integer"
},
"text_enabled_only": {
"description": "Indicates whether to return only text-enabled phone numbers.",
"type": "boolean"
}
},
"required": [
"country",
"city"
],
"type": "object"
},
"name": "buy_numbers_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"dids": {
"items": {
"additionalProperties": false,
"description": "Phone number available for purchase.",
"properties": {
"activation_fee": {
"description": "One-time activation fee in USD.",
"example": "15.0",
"type": "string"
},
"channels": {
"description": "Maximum number of concurrent inbound calls.",
"example": "4",
"format": "int32",
"type": "string"
},
"city": {
"description": "City where the phone number originates.",
"example": "Buenos Aires",
"type": "string"
},
"cnam": {
"description": "Indicates whether CNAM can be activated.",
"example": false,
"type": [
"boolean",
"null"
]
},
"country": {
"description": "Country where the phone number originates.",
"example": "Argentina",
"type": "string"
},
"country_short_name": {
"description": "Two-letter ISO country code.",
"example": "AR",
"type": "string"
},
"domestic_cli": {
"description": "Indicates whether the number can be used as the Caller ID for local calls.",
"example": true,
"type": "boolean"
},
"free_min": {
"description": "Number of free inbound minutes.",
"example": 0,
"format": "int32",
"type": "integer"
},
"id": {
"description": "Phone number ID.",
"example": 541139862174,
"format": "int64",
"type": "integer"
},
"monthly_fee": {
"description": "Monthly fee in USD.",
"example": "10.0",
"type": "string"
},
"number": {
"description": "Phone number in E.164 format.",
"example": "541139862174",
"type": "string"
},
"per_min": {
"description": "Price per inbound minute in USD.",
"example": "0.01",
"type": "string"
},
"require_docs": {
"description": "Documents required to activate the phone number.",
"example": [
1,
3
],
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"sms_enabled": {
"description": "Indicates whether the phone number can receive inbound\n SMS and MMS messages.",
"example": false,
"type": "boolean"
},
"sms_price": {
"description": "Price per inbound SMS segment in USD.",
"example": 0,
"format": "float",
"type": "number"
}
},
"required": [
"id",
"activation_fee",
"monthly_fee",
"per_min",
"channels",
"city",
"country",
"country_short_name",
"cnam",
"free_min",
"number",
"require_docs",
"sms_enabled",
"sms_price"
],
"title": "AvailableNumber",
"type": "object"
},
"type": "array"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
}
},
"required": [
"dids",
"pagination"
],
"title": "AvailableNumberListResponse",
"type": "object"
},
{
"example": {
"dids": [
{
"activation_fee": "15.0",
"channels": "4",
"city": "Buenos Aires",
"cnam": false,
"country": "Argentina",
"country_short_name": "AR",
"domestic_cli": false,
"free_min": 0,
"id": 541139862174,
"monthly_fee": "10.0",
"number": "541139862174",
"per_min": "0.01",
"require_docs": [],
"sms_enabled": false,
"sms_price": 0
}
],
"pagination": {
"current_page": 1,
"per_page": 50,
"total": 1,
"total_pages": 1
}
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of cities in the specified region for countries where `has_provinces_or_states` is `true`.",
"inputSchema": {
"properties": {
"country": {
"description": "Country ID.",
"example": 1891,
"format": "int32",
"type": "integer"
},
"region": {
"description": "Region ID.",
"example": 821,
"format": "int32",
"type": "integer"
},
"text_enabled_only": {
"description": "Indicates whether to return only cities with text-enabled numbers.",
"type": "boolean"
}
},
"required": [
"country",
"region"
],
"type": "object"
},
"name": "buy_region_cities_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"cities": {
"items": {
"additionalProperties": false,
"properties": {
"area_code": {
"description": "Rate center.",
"type": "number"
},
"id": {
"description": "City ID.",
"example": 3213,
"format": "int32",
"type": "integer"
},
"name": {
"description": "City name.",
"example": "Paris",
"type": "string"
}
},
"required": [
"id",
"name",
"area_code"
],
"title": "City",
"type": "object"
},
"type": "array"
}
},
"required": [
"cities"
],
"title": "CityListResponse",
"type": "object"
},
{
"example": {
"cities": [
{
"area_code": 113,
"id": 128791,
"name": "Buenos Aires"
},
{
"area_code": 341,
"id": 132655,
"name": "Rosario"
},
{
"area_code": 351,
"id": 132656,
"name": "Cordoba"
},
{
"area_code": 381,
"id": 141803,
"name": "Tucuman"
},
{
"area_code": 387,
"id": 141986,
"name": "Salta"
}
]
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of regions (states or provinces) for countries where `has_provinces_or_states` is `true`.",
"inputSchema": {
"properties": {
"country": {
"description": "Country ID.",
"example": 1892,
"format": "int32",
"type": "integer"
},
"text_enabled_only": {
"description": "Indicates whether to return only regions with text-enabled numbers.",
"type": "boolean"
}
},
"required": [
"country"
],
"type": "object"
},
"name": "buy_regions_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"regions": {
"items": {
"additionalProperties": false,
"description": "State or province of the country, if applicable.",
"properties": {
"id": {
"description": "Region ID.",
"example": 17,
"format": "int32",
"type": "integer"
},
"name": {
"description": "Region name.",
"example": "California",
"type": "string"
}
},
"required": [
"id",
"name"
],
"title": "Region",
"type": "object"
},
"type": "array"
}
},
"required": [
"regions"
],
"title": "RegionListResponse",
"type": "object"
},
{
"example": {
"regions": [
{
"id": 13,
"name": "Alabama"
},
{
"id": 15,
"name": "Arizona"
},
{
"id": 16,
"name": "Arkansas"
},
{
"id": 17,
"name": "California"
}
]
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Answers an inbound call. Optionally initiate media streaming upon answering.",
"inputSchema": {
"properties": {
"call_recording": {
"default": false,
"description": "Indicates whether the call should be recorded.",
"type": "boolean"
},
"call_transcription": {
"default": false,
"description": "Indicates whether the call should be transcribed after it ends.",
"type": "boolean"
},
"stream_channel": {
"allOf": [
{
"description": "Specifies which audio channel to stream. Use `inbound` to stream the incoming channel (to Wavix), `outbound` for the outbound channel (from Wavix), or `both` to stream both. For bidirectional call streaming, this setting is ignored and the inbound channel is only streamed.",
"enum": [
"inbound",
"outbound",
"both"
],
"type": "string"
}
],
"example": "inbound"
},
"stream_type": {
"allOf": [
{
"description": "Specifies the streaming type. Can be either `oneway` for unidirectional or `twoway` for bidirectional streaming.",
"enum": [
"oneway",
"twoway"
],
"type": "string"
}
],
"example": "twoway"
},
"stream_url": {
"description": "WebSocket URL to stream the call.",
"example": "wss://examples.com/stream",
"format": "uri",
"type": "string"
},
"uuid": {
"description": "Call ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "call_control_answer",
"outputSchema": {
"properties": {
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Plays audio in an active call.",
"inputSchema": {
"properties": {
"audio_file": {
"description": "URL of the audio file to play",
"example": "https://examples.com/audio.wav",
"type": "string"
},
"uuid": {
"description": "Call ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid",
"audio_file"
],
"type": "object"
},
"name": "call_control_audio_play",
"outputSchema": {
"properties": {
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Stops audio playback in an active call.",
"inputSchema": {
"properties": {
"uuid": {
"description": "Call ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "call_control_audio_stop",
"outputSchema": {
"properties": {
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Collects DTMF input in an active call.",
"inputSchema": {
"properties": {
"max_attempts": {
"description": "Maximum number of attempts.",
"example": 3,
"type": "integer"
},
"max_digits": {
"description": "Maximum number of digits to collect.",
"example": 5,
"maximum": 20,
"minimum": 1,
"type": "integer"
},
"prompt": {
"description": "Prompt to play before collecting digits.\n Play a prerecorded audio file or use Wavix Text-To-Speech.",
"properties": {
"play": {
"description": "Audio file URL.",
"example": "https://examples.com/prompt.wav",
"type": "string"
},
"say": {
"description": "Text to speak and voice to use.",
"properties": {
"language": {
"description": "Language",
"enum": [
"ru",
"en",
"sp",
"ge"
],
"type": "string"
},
"text": {
"description": "Text to speak.",
"example": "Please enter your PIN",
"type": "string"
},
"voice": {
"description": "Voice",
"enum": [
"Ivy",
"Joanna",
"Kendra",
"Kimberly",
"Salli",
"Joey",
"Justin",
"Matthew",
"Conchita",
"Lucia",
"Enrique",
"Marlene",
"Vicki",
"Hans",
"Tatyana",
"Maxim"
],
"type": "string"
}
},
"required": [
"text",
"voice"
],
"type": "object"
}
},
"type": "object"
},
"termination_character": {
"description": "DTMF character that ends input collection.",
"example": "#",
"type": "string"
},
"timeout": {
"description": "Timeout for digit collection in seconds.",
"example": 10,
"maximum": 60,
"minimum": 1,
"type": "integer"
},
"uuid": {
"description": "Call ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "call_control_collect",
"outputSchema": {
"properties": {
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Starts an outbound call.",
"inputSchema": {
"properties": {
"callback_url": {
"description": "The callback URL where Wavix sends the call status updates",
"example": "https://examples.com/callback",
"type": "string"
},
"from": {
"description": "Caller ID. Must be an active or verified phone number in your account.",
"example": "+1234567890",
"type": "string"
},
"recording": {
"default": false,
"description": "Specifies whether to record the call",
"type": "boolean"
},
"tag": {
"description": "Call metadata",
"example": "marketing-campaign",
"type": "string"
},
"timeout": {
"description": "The ring timeout, in seconds, before the call is considered unanswered.",
"example": 60,
"type": "integer"
},
"to": {
"description": "Destination number in E.164 format",
"example": "+1987654321",
"type": "string"
},
"voicemail_detection": {
"default": false,
"description": "Specifies whether the AMD is turned on for the call",
"type": "boolean"
}
},
"required": [
"from",
"to",
"callback_url"
],
"type": "object"
},
"name": "call_control_create",
"outputSchema": {
"additionalProperties": false,
"properties": {
"call_answered": {
"description": "Date and time when the call was answered",
"format": "date-time",
"type": [
"string",
"null"
]
},
"call_completed": {
"description": "Date and time when the call ended",
"format": "date-time",
"type": [
"string",
"null"
]
},
"call_started": {
"description": "Date and time when the call started",
"example": "2025-09-22T12:56:38.547Z",
"format": "date-time",
"type": "string"
},
"direction": {
"description": "Call direction - inbound or outbound",
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"event_payload": {
"anyOf": [
{
"description": "Payload for the `on_call_event` event type.",
"properties": {
"payload": {
"description": "Sub-event-specific data. Structure depends on the `type` field:\n- `audio`: `{ \"status\": \"started\" | \"completed\", \"playback_id\": \"<uuid>\" }`\n- `collect`: `{ \"digits\": \"<digits>\", \"status\": \"started\" | \"completed\" | \"failed\" }`",
"example": {
"playback_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "completed"
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type of the on-call sub-event",
"enum": [
"audio",
"collect"
],
"example": "audio",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Event-specific data",
"example": {
"payload": {
"playback_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "completed"
},
"type": "audio"
}
},
"event_time": {
"description": "Date and time of the latest event",
"example": "2025-09-22T12:56:38.547Z",
"format": "date-time",
"type": "string"
},
"event_type": {
"description": "The latest call event",
"enum": [
"call_setup",
"ringing",
"early_media",
"answered",
"completed",
"busy",
"cancelled",
"rejected",
"on_call_event"
],
"example": "call_setup",
"type": "string"
},
"from": {
"description": "Caller ID",
"example": "+18045961058",
"type": "string"
},
"machine_detected": {
"description": "Indicates whether the call was answered by an answering machine",
"example": false,
"type": "boolean"
},
"tag": {
"description": "Call metadata",
"example": "",
"type": "string"
},
"to": {
"description": "Destination number",
"example": "17653889567",
"type": "string"
},
"uuid": {
"description": "Call ID",
"example": "5dccb6b0-f35c-488c-867b-86fb012c4415",
"format": "uuid",
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Ends an active call.",
"inputSchema": {
"properties": {
"uuid": {
"description": "Call ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "call_control_delete",
"outputSchema": {
"properties": {
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Returns a call.",
"inputSchema": {
"properties": {
"uuid": {
"description": "Call ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "call_control_get",
"outputSchema": {
"properties": {
"call": {
"additionalProperties": false,
"properties": {
"call_answered": {
"description": "Date and time when the call was answered in ISO 8601 format.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"call_completed": {
"description": "Date and time when the call ended in ISO 8601 format.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"call_started": {
"description": "Date and time when the call started in ISO 8601 format.",
"example": "2025-09-22T12:56:38.547Z",
"format": "date-time",
"type": "string"
},
"direction": {
"description": "Call direction - inbound or outbound",
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"event_payload": {
"anyOf": [
{
"description": "Payload for the `on_call_event` event type.",
"properties": {
"payload": {
"description": "Sub-event-specific data. Structure depends on the `type` field:\n- `audio`: `{ \"status\": \"started\" | \"completed\", \"playback_id\": \"<uuid>\" }`\n- `collect`: `{ \"digits\": \"<digits>\", \"status\": \"started\" | \"completed\" | \"failed\" }`",
"example": {
"playback_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "completed"
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type of the on-call sub-event",
"enum": [
"audio",
"collect"
],
"example": "audio",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Event-specific metadata.",
"example": {
"payload": {
"playback_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "completed"
},
"type": "audio"
}
},
"event_time": {
"description": "Date and time of the latest event in ISO 8601 format.",
"example": "2025-09-22T12:56:38.547Z",
"format": "date-time",
"type": "string"
},
"event_type": {
"description": "Latest call event.",
"enum": [
"call_setup",
"ringing",
"early_media",
"answered",
"completed",
"busy",
"cancelled",
"rejected",
"on_call_event"
],
"example": "call_setup",
"type": "string"
},
"from": {
"description": "Caller ID.",
"example": "+18045961058",
"type": "string"
},
"machine_detected": {
"description": "Indicates whether the call was answered by a machine.",
"example": false,
"type": "boolean"
},
"tag": {
"description": "Call metadata",
"example": "marketing-campaign",
"type": "string"
},
"to": {
"description": "Destination number.",
"example": "17653889567",
"type": "string"
},
"uuid": {
"description": "Call ID.",
"example": "5dccb6b0-f35c-488c-867b-86fb012c4415",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid",
"event_type",
"event_time",
"event_payload",
"from",
"to",
"call_started",
"call_answered",
"call_completed",
"machine_detected",
"tag"
],
"type": "object"
},
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"required": [
"call",
"success"
],
"type": "object"
}
},
{
"description": "Returns a list of active calls.",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "call_control_list",
"outputSchema": {
"properties": {
"calls": {
"description": "List of calls",
"items": {
"additionalProperties": false,
"properties": {
"call_answered": {
"description": "Date and time when the call was answered in ISO 8601 format.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"call_completed": {
"description": "Date and time when the call ended in ISO 8601 format.",
"format": "date-time",
"type": [
"string",
"null"
]
},
"call_started": {
"description": "Date and time when the call started in ISO 8601 format.",
"example": "2025-09-22T12:56:38.547Z",
"format": "date-time",
"type": "string"
},
"direction": {
"description": "Call direction - inbound or outbound",
"enum": [
"inbound",
"outbound"
],
"type": "string"
},
"event_payload": {
"anyOf": [
{
"description": "Payload for the `on_call_event` event type.",
"properties": {
"payload": {
"description": "Sub-event-specific data. Structure depends on the `type` field:\n- `audio`: `{ \"status\": \"started\" | \"completed\", \"playback_id\": \"<uuid>\" }`\n- `collect`: `{ \"digits\": \"<digits>\", \"status\": \"started\" | \"completed\" | \"failed\" }`",
"example": {
"playback_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "completed"
},
"type": [
"object",
"null"
]
},
"type": {
"description": "Type of the on-call sub-event",
"enum": [
"audio",
"collect"
],
"example": "audio",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
{
"type": "null"
}
],
"description": "Event-specific metadata.",
"example": {
"payload": {
"playback_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "completed"
},
"type": "audio"
}
},
"event_time": {
"description": "Date and time of the latest event in ISO 8601 format.",
"example": "2025-09-22T12:56:38.547Z",
"format": "date-time",
"type": "string"
},
"event_type": {
"description": "Latest call event.",
"enum": [
"call_setup",
"ringing",
"early_media",
"answered",
"completed",
"busy",
"cancelled",
"rejected",
"on_call_event"
],
"example": "call_setup",
"type": "string"
},
"from": {
"description": "Caller ID.",
"example": "+18045961058",
"type": "string"
},
"machine_detected": {
"description": "Indicates whether the call was answered by a machine.",
"example": false,
"type": "boolean"
},
"tag": {
"description": "Call metadata",
"example": "marketing-campaign",
"type": "string"
},
"to": {
"description": "Destination number.",
"example": "17653889567",
"type": "string"
},
"uuid": {
"description": "Call ID.",
"example": "5dccb6b0-f35c-488c-867b-86fb012c4415",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid",
"event_type",
"event_time",
"event_payload",
"from",
"to",
"call_started",
"call_answered",
"call_completed",
"machine_detected",
"tag"
],
"type": "object"
},
"type": "array"
},
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"required": [
"calls",
"success"
],
"type": "object"
}
},
{
"description": "Starts call media streaming.",
"inputSchema": {
"properties": {
"stream_channel": {
"allOf": [
{
"description": "Specifies which audio channel to stream. Use `inbound` to stream the incoming channel (to Wavix), `outbound` for the outbound channel (from Wavix), or `both` to stream both. For bidirectional call streaming, this setting is ignored and the inbound channel is only streamed.",
"enum": [
"inbound",
"outbound",
"both"
],
"type": "string"
}
],
"example": "inbound"
},
"stream_type": {
"allOf": [
{
"description": "Specifies the streaming type. Can be either `oneway` for unidirectional or `twoway` for bidirectional streaming.",
"enum": [
"oneway",
"twoway"
],
"type": "string"
}
],
"example": "twoway"
},
"stream_url": {
"description": "WebSocket URL for call streaming",
"example": "wss://examples.com/stream",
"format": "uri",
"type": "string"
},
"uuid": {
"description": "Call ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid",
"stream_url",
"stream_type",
"stream_channel"
],
"type": "object"
},
"name": "call_control_streams_create",
"outputSchema": {
"properties": {
"stream_id": {
"description": "Stream ID",
"example": "123e4567-e89b-12d3-a456-426614174000",
"format": "uuid",
"type": "string"
},
"success": {
"description": "Indicates that the request was successful",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Stops call media streaming.",
"inputSchema": {
"properties": {
"stream_uuid": {
"description": "Stream ID.",
"format": "uuid",
"type": "string"
},
"uuid": {
"description": "Call ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid",
"stream_uuid"
],
"type": "object"
},
"name": "call_control_streams_delete",
"outputSchema": {
"properties": {
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Updates an active call. Only the `tag` field can be modified.",
"inputSchema": {
"properties": {
"tag": {
"description": "Call metadata.",
"example": "marketing-campaign",
"type": "string"
},
"uuid": {
"description": "Call ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid",
"tag"
],
"type": "object"
},
"name": "call_control_update",
"outputSchema": {
"properties": {
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
}
},
{
"description": "Deletes a call recording.",
"inputSchema": {
"properties": {
"id": {
"description": "Recording ID.",
"example": 123,
"format": "int32",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "call_recording_delete",
"outputSchema": {
"properties": {
"success": {
"description": "Indicates whether the request succeeded.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Get a download URL for a call recording audio file.\n\nReturns ``{download_url, content_type, status_code, note}`` instead of the\nbinary audio stream. Fetch ``download_url`` to obtain the MP3.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"call_uuid": {
"type": "string"
}
},
"required": [
"call_uuid"
],
"type": "object"
},
"name": "call_recording_get",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Returns a paginated list of call recordings.",
"inputSchema": {
"properties": {
"call_uuid": {
"description": "Call ID for filtering.",
"example": "aa566501-c591-4a8b-b3b9-cc1295398b72",
"type": "string"
},
"from": {
"description": "Originating phone number for filtering. Full or partial input accepted.",
"example": "123456",
"type": "string"
},
"from_date": {
"description": "Start date in `YYYY-MM-DD` format.",
"example": "2023-01-01",
"format": "date",
"type": "string"
},
"page": {
"description": "Page number to retrieve.",
"example": 1,
"format": "int32",
"type": "integer"
},
"per_page": {
"default": 25,
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"sip_trunks": {
"description": "List of SIP trunk logins to filter outbound calls.",
"example": [
"123",
"456"
],
"items": {
"type": "string"
},
"type": "array"
},
"to": {
"description": "Destination phone number for filtering. Full or partial input accepted.",
"example": "1987654321",
"type": "string"
},
"to_date": {
"description": "End date in `YYYY-MM-DD` format.",
"example": "2023-12-31",
"format": "date",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "call_recording_list",
"outputSchema": {
"additionalProperties": false,
"properties": {
"invalid": {
"additionalProperties": false,
"description": "An invalid recording filter response",
"properties": {
"dids": {
"description": "Invalid DID IDs",
"example": [
"invalid_did_1",
"invalid_did_2"
],
"items": {
"type": "string"
},
"type": "array"
},
"sip_trunks": {
"description": "Invalid SIP trunk IDs",
"example": [
"invalid_trunk_1",
"invalid_trunk_2"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"title": "InvalidRecording",
"type": "object"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
},
"recordings": {
"items": {
"additionalProperties": false,
"description": "A call recording response",
"properties": {
"call_uuid": {
"description": "Call ID.",
"example": "aa566501-c591-4a8b-b3b9-cc1295398b72",
"type": "string"
},
"created_at": {
"description": "Date and time when the recording was created in ISO 8601 format.",
"example": "2023-06-15T10:30:00Z",
"format": "date-time",
"type": "string"
},
"duration": {
"description": "Recording duration in seconds.",
"example": 120,
"format": "int32",
"type": "integer"
},
"from": {
"description": "Originating phone number.",
"example": "1234567890",
"type": "string"
},
"id": {
"description": "Recording ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"to": {
"description": "Destination phone number.",
"example": "0987654321",
"type": "string"
},
"url": {
"description": "Recording file URL.",
"example": "https://api.wavix.com/v1/recordings/uuid",
"type": "string"
}
},
"required": [
"id",
"created_at",
"duration",
"from",
"to",
"call_uuid",
"url"
],
"title": "Recording",
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Creates a call webhook. Wavix sends POST callbacks for `on-call` and `post-call` events.",
"inputSchema": {
"properties": {
"event_type": {
"description": "Allowed values: `on-call`, `post-call`.\n - `on-call`: Sends real-time status updates\n when a call starts, is answered, and ends.\n\n - `post-call`: Sends a callback after the call ends\n with disposition, duration, and cost.",
"enum": [
"post-call",
"on-call"
],
"type": "string"
},
"url": {
"description": "Webhook URL to send call events to.",
"example": "https://you-site.com/webhook",
"format": "uri",
"type": "string"
}
},
"required": [
"url",
"event_type"
],
"type": "object"
},
"name": "call_webhooks_create",
"outputSchema": {
"additionalProperties": false,
"description": "A call webhook response",
"properties": {
"event_type": {
"description": "Type of call events",
"enum": [
"post-call",
"on-call"
],
"example": "post-call",
"type": "string"
},
"success": {
"example": true,
"type": "boolean"
},
"url": {
"description": "Webhook URL",
"example": "https://you-site.com/webhook",
"format": "uri",
"type": "string"
}
},
"required": [
"success",
"event_type",
"url"
],
"title": "CallWebhook",
"type": "object"
}
},
{
"description": "Deletes a call webhook.",
"inputSchema": {
"properties": {
"event_type": {
"description": "Use `post-call` to stop receiving post-call callbacks.\nUse `on-call` to stop receiving real-time call status updates.",
"enum": [
"post-call",
"on-call"
],
"example": "post-call",
"type": "string"
}
},
"required": [
"event_type"
],
"type": "object"
},
"name": "call_webhooks_delete",
"outputSchema": {
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Returns a list of configured call webhooks. Wavix sends POST callbacks for `on-call` and `post-call` events.",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "call_webhooks_list",
"outputSchema": {
"properties": {
"result": {
"description": "List of call webhooks configured for the phone number.",
"items": {
"additionalProperties": false,
"properties": {
"event_type": {
"description": "Call event type.",
"enum": [
"post-call",
"on-call"
],
"example": "post-call",
"type": "string"
},
"url": {
"description": "Webhook URL",
"example": "https://your-site.com/webhook",
"format": "uri",
"type": "string"
}
},
"required": [
"event_type",
"url"
],
"type": "object"
},
"title": "CallWebhookListResponse",
"type": "array"
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Adds phone numbers to the cart.",
"inputSchema": {
"properties": {
"ids": {
"description": "List of phone numbers to add to the cart.",
"example": [
"541139862174",
"541139862175"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"ids"
],
"type": "object"
},
"name": "cart_add",
"outputSchema": {
"properties": {
"result": {
"additionalProperties": false,
"example": [
{
"activation_fee": "15.0",
"channels": "4",
"city": "Buenos Aires",
"cnam": false,
"country": "Argentina",
"country_short_name": "AR",
"domestic_cli": false,
"free_min": 0,
"id": 541139862174,
"monthly_fee": "10.0",
"number": "541139862174",
"per_min": "0.01",
"require_docs": [],
"sms_enabled": false,
"sms_price": 0
}
],
"type": "array"
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Checks out the cart. Activation and monthly fees are deducted from the account balance.",
"inputSchema": {
"properties": {
"ids": {
"description": "List of phone numbers to check out from the cart.",
"example": [
"541139862174",
"541139862175"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"ids"
],
"type": "object"
},
"name": "cart_checkout",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns the cart.",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "cart_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"dids": {
"description": "List of phone numbers in the cart.",
"items": {
"additionalProperties": false,
"description": "Phone number available for purchase.",
"properties": {
"activation_fee": {
"description": "One-time activation fee in USD.",
"example": "15.0",
"type": "string"
},
"channels": {
"description": "Maximum number of concurrent inbound calls.",
"example": "4",
"format": "int32",
"type": "string"
},
"city": {
"description": "City where the phone number originates.",
"example": "Buenos Aires",
"type": "string"
},
"cnam": {
"description": "Indicates whether CNAM can be activated.",
"example": false,
"type": [
"boolean",
"null"
]
},
"country": {
"description": "Country where the phone number originates.",
"example": "Argentina",
"type": "string"
},
"country_short_name": {
"description": "Two-letter ISO country code.",
"example": "AR",
"type": "string"
},
"domestic_cli": {
"description": "Indicates whether the number can be used as the Caller ID for local calls.",
"example": true,
"type": "boolean"
},
"free_min": {
"description": "Number of free inbound minutes.",
"example": 0,
"format": "int32",
"type": "integer"
},
"id": {
"description": "Phone number ID.",
"example": 541139862174,
"format": "int64",
"type": "integer"
},
"monthly_fee": {
"description": "Monthly fee in USD.",
"example": "10.0",
"type": "string"
},
"number": {
"description": "Phone number in E.164 format.",
"example": "541139862174",
"type": "string"
},
"per_min": {
"description": "Price per inbound minute in USD.",
"example": "0.01",
"type": "string"
},
"require_docs": {
"description": "Documents required to activate the phone number.",
"example": [
1,
3
],
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"sms_enabled": {
"description": "Indicates whether the phone number can receive inbound\n SMS and MMS messages.",
"example": false,
"type": "boolean"
},
"sms_price": {
"description": "Price per inbound SMS segment in USD.",
"example": 0,
"format": "float",
"type": "number"
}
},
"required": [
"id",
"activation_fee",
"monthly_fee",
"per_min",
"channels",
"city",
"country",
"country_short_name",
"cnam",
"free_min",
"number",
"require_docs",
"sms_enabled",
"sms_price"
],
"title": "AvailableNumber",
"type": "object"
},
"type": "array"
},
"doc_types": {
"description": "Document types required to activate phone numbers.",
"items": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Document type ID.",
"example": 2,
"format": "int32",
"type": "integer"
},
"name": {
"description": "Document type name.",
"example": "address",
"type": "string"
},
"title": {
"description": "Human-readable document type name.",
"example": "Proof of address",
"type": "string"
}
},
"required": [
"id",
"name",
"title"
],
"title": "DocumentType",
"type": "object"
},
"type": "array"
}
},
"required": [
"dids",
"doc_types"
],
"title": "CartResponse",
"type": "object"
},
{
"example": {
"dids": [
{
"activation_fee": "15.0",
"channels": "4",
"city": "Buenos Aires",
"cnam": false,
"country": "Argentina",
"country_short_name": "AR",
"domestic_cli": false,
"free_min": 0,
"id": 541139862174,
"monthly_fee": "10.0",
"number": "541139862174",
"per_min": "0.01",
"require_docs": [],
"sms_enabled": false,
"sms_price": 0
}
],
"doc_types": [
{
"id": 1,
"name": "id",
"title": "Any form of ID"
},
{
"id": 2,
"name": "address",
"title": "Proof of address"
},
{
"id": 3,
"name": "localaddress",
"title": "Proof of local address"
}
]
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Removes phone numbers from the cart.",
"inputSchema": {
"properties": {
"ids": {
"description": "List of phone numbers to remove.",
"example": [
"541139862174",
"541139862175"
],
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"ids"
],
"type": "object"
},
"name": "cart_remove",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns call details.",
"inputSchema": {
"properties": {
"show_transcription": {
"description": "Indicates whether to include transcription.",
"example": true,
"type": "boolean"
},
"uuid": {
"description": "Call ID.",
"example": "aa566501-c591-4a8b-b3b9-cc1295398b72",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "cdrs_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"answered_by": {
"description": "Who answered the call. Possible values are `human`, `machine`.",
"example": "human",
"type": [
"string",
"null"
]
},
"charge": {
"description": "Total charge for the call in USD.",
"example": "0.162",
"type": [
"string",
"null"
]
},
"date": {
"description": "Call date and time in ISO 8601 format.",
"example": "2023-08-21T06:43:36.000Z",
"format": "date-time",
"type": [
"string",
"null"
]
},
"destination": {
"description": "Destination of the call. For outbound calls,\n contains the country name and, optionally, a mobile carrier\n or city name. For inbound calls, includes the SIP trunk name,\n SIP URI, or PSTN number the call is forwarded to.",
"example": "France",
"type": [
"string",
"null"
]
},
"disposition": {
"description": "Call disposition.",
"enum": [
"answered",
"noanswer",
"busy",
"failed",
"all"
],
"title": "CallDisposition",
"type": "string"
},
"duration": {
"description": "Call duration in seconds.",
"example": 6,
"format": "int32",
"type": "integer"
},
"forward_fee": {
"description": "PSTN forwarding price in USD. For inbound calls only\n when forwarded to PSTN.",
"example": "0.0",
"type": "string"
},
"from": {
"description": "Caller ID (ANI).",
"example": "14302287001",
"type": "string"
},
"parent_uuid": {
"description": "Parent call ID.",
"example": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
"type": [
"string",
"null"
]
},
"per_minute": {
"description": "Price per minute in USD.",
"example": "0.027",
"type": [
"string",
"null"
]
},
"recording_url": {
"description": "URL of the recorded call file. Call recording can be enabled\n on a SIP trunk for outbound calls and on\n a phone number for inbound calls.",
"example": "https://api.wavix.com/v1/recordings/recording_id",
"type": [
"string",
"null"
]
},
"sip_trunk": {
"description": "System-generated SIP trunk login. For outbound calls only.",
"example": "32882",
"type": [
"string",
"null"
]
},
"to": {
"description": "Dialed number (DNIS).",
"example": "33170363950",
"type": "string"
},
"uuid": {
"description": "Call ID.",
"example": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
"type": "string"
}
},
"required": [
"date",
"from",
"to",
"disposition",
"duration",
"destination",
"per_minute",
"charge",
"uuid"
],
"title": "CdrResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a paginated list of CDRs.",
"inputSchema": {
"properties": {
"disposition": {
"allOf": [
{
"description": "Call disposition.",
"enum": [
"answered",
"noanswer",
"busy",
"failed",
"all"
],
"title": "CallDisposition",
"type": "string"
}
],
"description": "Call disposition to filter results. Allowed values: `answered`, `busy`, `rejected`,\n `failed`, `all`."
},
"from": {
"description": "Start date in `YYYY-MM-DD` format.",
"example": "2023-01-01",
"format": "date",
"type": "string"
},
"from_search": {
"description": "Originating phone number for filtering. Full or partial input accepted.",
"example": "13524815863",
"type": "string"
},
"page": {
"description": "Page number to retrieve.",
"example": 1,
"format": "int32",
"type": "integer"
},
"per_page": {
"default": 25,
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"sip_trunk": {
"description": "SIP trunk login to filter outbound calls. Ignored for inbound calls.",
"example": "12321",
"type": "string"
},
"to": {
"description": "End date in `YYYY-MM-DD` format.",
"example": "2023-09-01",
"format": "date",
"type": "string"
},
"to_search": {
"description": "Destination phone number for filtering. Full or partial input accepted.",
"example": "12565378257",
"type": "string"
},
"type": {
"description": "Call direction to filter results. Allowed values: `placed`, `received`.",
"example": "received",
"type": "string"
},
"uuid": {
"description": "Call ID to filter results.",
"example": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
"type": "string"
}
},
"required": [
"from",
"to",
"type"
],
"type": "object"
},
"name": "cdrs_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"items": {
"description": "List of CDRs",
"items": {
"additionalProperties": false,
"description": "Call detail record (CDR) for an individual call.",
"properties": {
"answered_by": {
"description": "Who answered the call. Possible values are `human`, `machine`.",
"example": "human",
"type": [
"string",
"null"
]
},
"charge": {
"description": "Total charge for the call in USD.",
"example": "0.822",
"type": "string"
},
"date": {
"description": "Date and time of the call in ISO 8601 format.",
"example": "2023-08-21T06:43:36.000Z",
"format": "date-time",
"type": "string"
},
"destination": {
"description": "Destination of the call. For outbound calls,\n contains the country name and, optionally, a mobile carrier\n or city name. For inbound calls, includes the SIP trunk name,\n SIP URI, or PSTN number the call is forwarded to.",
"example": "France",
"type": "string"
},
"disposition": {
"description": "Call disposition.",
"enum": [
"answered",
"noanswer",
"busy",
"failed",
"all"
],
"title": "CallDisposition",
"type": "string"
},
"duration": {
"description": "Call duration in seconds.",
"example": 6,
"format": "int32",
"type": "integer"
},
"forward_fee": {
"description": "PSTN forwarding price in USD. For inbound calls only when forwarded to PSTN.",
"example": "0.0",
"type": "string"
},
"from": {
"description": "Originating phone number (ANI).",
"example": "14302287001",
"type": "string"
},
"parent_uuid": {
"description": "Parent call ID.",
"example": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
"type": [
"string",
"null"
]
},
"per_minute": {
"description": "Price per minute in USD.",
"example": "0.027",
"type": "string"
},
"sip_trunk": {
"description": "System-generated SIP trunk login. For outbound calls only.",
"example": "32882",
"type": [
"string",
"null"
]
},
"to": {
"description": "Destination phone number (DNIS).",
"example": "33170363950",
"type": "string"
},
"uuid": {
"description": "Call ID.",
"example": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
"type": "string"
}
},
"required": [
"date",
"from",
"to",
"disposition",
"duration",
"destination",
"per_minute",
"charge",
"uuid"
],
"title": "Cdr",
"type": "object"
},
"type": "array"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
}
},
"required": [
"items",
"pagination"
],
"title": "CdrListResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns CDRs in NDJSON format for bulk export.",
"inputSchema": {
"properties": {
"disposition": {
"allOf": [
{
"description": "Call disposition.",
"enum": [
"answered",
"noanswer",
"busy",
"failed",
"all"
],
"title": "CallDisposition",
"type": "string"
}
],
"description": "Call disposition to filter results. Allowed values: `answered`, `busy`, `rejected`,\n `failed`, `all`."
},
"from": {
"description": "Start date in `YYYY-MM-DD` format.",
"example": "2023-01-01",
"format": "date",
"type": "string"
},
"from_search": {
"description": "Originating phone number for filtering. Full or partial input accepted.",
"example": "13524815863",
"type": "string"
},
"page": {
"description": "Page number to retrieve.",
"example": 1,
"format": "int32",
"type": "integer"
},
"per_page": {
"default": 25,
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"sip_trunk": {
"description": "SIP trunk login to filter outbound calls. Ignored for inbound calls.",
"example": "12321",
"type": "string"
},
"to": {
"description": "End date in `YYYY-MM-DD` format.",
"example": "2023-09-01",
"format": "date",
"type": "string"
},
"to_search": {
"description": "Destination phone number for filtering. Full or partial input accepted.",
"example": "12565378257",
"type": "string"
},
"type": {
"description": "Call direction to filter results. Allowed values: `placed`, `received`.",
"example": "received",
"type": "string"
},
"uuid": {
"description": "Call ID to filter results.",
"example": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
"type": "string"
}
},
"required": [
"from",
"to",
"type"
],
"type": "object"
},
"name": "cdrs_list_all",
"outputSchema": null
},
{
"description": "Transcribes a recorded call.",
"inputSchema": {
"properties": {
"language": {
"description": "Language.",
"enum": [
"en",
"de",
"es",
"fr",
"it",
null
],
"title": "TranscriptionLanguage",
"type": [
"string",
"null"
]
},
"uuid": {
"description": "Call ID.",
"example": "bbaa37bf-430a-46da-ade3-c248e407016",
"type": "string"
},
"webhook_url": {
"description": "Webhook URL to receive status updates.",
"example": "https://site.webhook",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "cdrs_retranscribe",
"outputSchema": {
"additionalProperties": false,
"properties": {
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"type": "object"
}
},
{
"description": "Searches call transcriptions for specific keywords or phrases.",
"inputSchema": {
"properties": {
"disposition": {
"allOf": [
{
"description": "Call disposition.",
"enum": [
"answered",
"noanswer",
"busy",
"failed",
"all"
],
"title": "CallDisposition",
"type": "string"
},
{
"description": "Call disposition to filter results. If omitted, returns only answered\n calls. Allowed values: `answered`, `busy`, `rejected`,\n `failed`, `all`. Use `all` to return calls\n regardless of their disposition.\n"
}
]
},
"from": {
"description": "Start date for call search in `YYYY-MM-DD` format.",
"example": "2023-08-01",
"format": "date",
"type": "string"
},
"from_search": {
"description": "Originating phone number to filter results. Accepts full or partial number.",
"example": "4478012",
"type": "string"
},
"min_duration": {
"description": "Minimum call duration in seconds.",
"example": 10,
"format": "int32",
"type": "integer"
},
"page": {
"description": "Page number to retrieve.",
"example": 1,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 50,
"format": "int32",
"type": "integer"
},
"sip_trunk": {
"description": "SIP trunk login to filter outbound calls. Ignored for inbound calls.",
"example": "87095",
"type": "string"
},
"to": {
"description": "End date for call search in `YYYY-MM-DD` format.",
"example": "2023-08-31",
"format": "date",
"type": "string"
},
"to_search": {
"description": "Destination phone number to filter results. Accepts full or partial number.",
"example": "44206723",
"type": "string"
},
"transcription": {
"additionalProperties": false,
"properties": {
"agent": {
"description": "Search in an agent's spoken words and phrases",
"properties": {
"exclude": {
"description": "Only calls with transcription that does not include any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR",
"example": [
"Richard",
"Issue resolved"
],
"items": {
"example": "Richard",
"type": "string"
},
"type": "array"
},
"match": {
"description": "Only calls with transcription that includes any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR",
"example": [
"Nope",
"Maybe"
],
"items": {
"example": "Nope",
"type": "string"
},
"type": "array"
},
"must": {
"description": "Only calls with transcription that includes all of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical AND",
"example": [
"Hello",
"Thank you"
],
"items": {
"example": "Hello",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"any": {
"description": "Search in both speakers' spoken words and phrases",
"properties": {
"exclude": {
"description": "Only calls with transcription that does not include any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR",
"example": [
"Richard",
"Issue resolved"
],
"items": {
"example": "Richard",
"type": "string"
},
"type": "array"
},
"match": {
"description": "Only calls with transcription that includes any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR",
"example": [
"Nope",
"Maybe"
],
"items": {
"example": "Nope",
"type": "string"
},
"type": "array"
},
"must": {
"description": "Only calls with transcription that includes all of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical AND",
"example": [
"Hello",
"Thank you"
],
"items": {
"example": "Hello",
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"client": {
"description": "Search in an customer's spoken words and phrases",
"properties": {
"exclude": {
"description": "Only calls with transcription that does not include any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR",
"example": [
"Richard",
"Issue resolved"
],
"items": {
"example": "Richard",
"type": "string"
},
"type": "array"
},
"match": {
"description": "Only calls with transcription that includes any of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical OR",
"example": [
"Nope",
"Maybe"
],
"items": {
"example": "Nope",
"type": "string"
},
"type": "array"
},
"must": {
"description": "Only calls with transcription that includes all of the specified keywords and phrases are returned. The listed keywords and phrases are combined using logical AND",
"example": [
"Hello",
"Thank you"
],
"items": {
"example": "Hello",
"type": "string"
},
"type": "array"
}
},
"type": "object"
}
},
"required": [
"agent",
"client",
"any"
],
"title": "TranscriptionFilter",
"type": "object"
},
"type": {
"description": "Search transcriptions by call type.",
"enum": [
"placed",
"received"
],
"example": "placed",
"type": "string"
},
"uuid": {
"description": "Call ID.",
"example": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
"type": "string"
}
},
"required": [
"type",
"from",
"to",
"page",
"per_page"
],
"type": "object"
},
"name": "cdrs_search",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"items": {
"description": "List of CDRs with transcription links.",
"items": {
"additionalProperties": false,
"description": "A CDR of a single call with call transcription",
"properties": {
"answered_by": {
"description": "Who answered the call. Allowed values are `human`, `machine`.",
"example": "human",
"type": [
"string",
"null"
]
},
"charge": {
"description": "Total charge for the call, in USD",
"type": "string"
},
"date": {
"description": "Date and time of the call",
"example": "2023-08-21T06:43:36.000Z",
"format": "date-time",
"type": "string"
},
"destination": {
"description": "Destination of the call. For outbound calls, it contains the country name and, optionally, a mobile carrier or city name. For inbound calls, the destination includes the user-defined SIP trunk name, SIP URI, or PSTN number that the call is forwarded to.",
"example": "France",
"type": "string"
},
"disposition": {
"description": "Call disposition.",
"enum": [
"answered",
"noanswer",
"busy",
"failed",
"all"
],
"title": "CallDisposition",
"type": "string"
},
"duration": {
"description": "Duration of the call, in seconds",
"example": 6,
"format": "int32",
"type": "integer"
},
"forward_fee": {
"description": "PSTN forwarding price, in USD. For `received` calls only when forwarded to PSTN.",
"example": "0.0",
"type": "string"
},
"from": {
"description": "ANI/From attribute of the call",
"example": "14302287001",
"type": "string"
},
"parent_uuid": {
"description": "Parent UUID",
"example": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
"type": [
"string",
"null"
]
},
"per_minute": {
"description": "Price per minute, in USD",
"example": "0.027",
"type": "string"
},
"sip_trunk": {
"description": "System-generated login of a SIP trunk. For `placed` calls only.",
"example": "32882",
"type": [
"string",
"null"
]
},
"to": {
"description": "DNIS/To attribute of the call",
"example": "33170363950",
"type": "string"
},
"transcription": {
"additionalProperties": false,
"properties": {
"url": {
"description": "The URL to query the call transcription",
"example": "https://api.wavix.com/v1/cdr/40d6f322-048d-490b-95c7-4fc5c76a74db/transcription?appid=secret",
"type": "string"
},
"uuid": {
"description": "Unique identifier of the call transcription",
"example": "40d6f322-048d-490b-95c7-4fc5c76a74db",
"type": "string"
}
},
"required": [
"uuid",
"url"
],
"title": "TranscriptionReference",
"type": [
"object",
"null"
]
},
"uuid": {
"description": "Call ID",
"example": "99df5ffd-962a-410f-bcce-d08f1f7f328c",
"type": "string"
}
},
"required": [
"date",
"from",
"to",
"disposition",
"duration",
"destination",
"per_minute",
"charge",
"uuid",
"transcription"
],
"title": "CdrWithTranscription",
"type": "object"
},
"type": "array"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
}
},
"required": [
"items",
"pagination"
],
"title": "CdrTranscriptionSearchResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a recorded call transcription.",
"inputSchema": {
"properties": {
"uuid": {
"description": "Call ID.",
"example": "bbaa37bf-430a-46da-ade3-c248e407016",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "cdrs_transcription_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"call_date": {
"description": "Date and time when the call was placed or received in ISO 8601 format.",
"example": "2023-01-09T10:01:13.394Z",
"format": "date-time",
"type": "string"
},
"call_score": {
"description": "Call sentiment score. Indicates negative (1.0-3.0), neutral,\n or positive (4.0-5.0).",
"example": "3.8",
"type": "string"
},
"call_summary": {
"description": "One- or two-sentence call summary.",
"example": "The agent and client discussed billing issues.",
"type": "string"
},
"call_uuid": {
"description": "Associated call ID.",
"example": "bbaa37bf-430a-46da-ade3-c248e4070161",
"type": "string"
},
"charge": {
"description": "Total charge for the transcription in USD.",
"example": "0.01",
"type": "string"
},
"duration": {
"description": "Call duration in seconds.",
"example": 102,
"format": "int32",
"type": "integer"
},
"language": {
"description": "Language.",
"enum": [
"en",
"de",
"es",
"fr",
"it",
null
],
"title": "TranscriptionLanguage",
"type": [
"string",
"null"
]
},
"status": {
"description": "Transcription status.",
"enum": [
"completed",
"failed"
],
"title": "TranscriptionStatus",
"type": "string"
},
"transcript": {
"additionalProperties": {
"type": "string"
},
"description": "Mapping of phone numbers in the call to transcript text.",
"example": {
"16465292513": "",
"16572026750": ""
},
"type": "object"
},
"transcription_date": {
"description": "Date and time when the transcription was processed in ISO 8601 format.",
"example": "2023-01-09T10:04:39.734Z",
"format": "date-time",
"type": "string"
},
"turns": {
"description": "List of speaker turns with text and start/end times.",
"example": [
{
"e": 7280,
"s": 160,
"text": "Hello, how can I help you?",
"type": "46844685344"
},
{
"e": 3280,
"s": 2400,
"text": "Hello, I have a question about my bill.",
"type": "+16572026750"
}
],
"items": {
"additionalProperties": false,
"description": "Each Turn object contains text attributed to a particular speaker, along with the start and end times for that text.",
"properties": {
"e": {
"description": "End of the `turn`, in milliseconds. The end time is calculated from the moment the call was answered.",
"example": 18000,
"format": "int32",
"type": "integer"
},
"s": {
"description": "Start of the `turn`, in milliseconds. The start time is calculated from the moment the call was answered.",
"example": 3000,
"format": "int32",
"type": "integer"
},
"sentiment": {
"example": "neutral",
"type": "string"
},
"text": {
"description": "The text attributed to the speaker",
"example": "Hi there, how are you?",
"type": "string"
},
"type": {
"description": "A speaker's phone number",
"example": "13132847320",
"type": "string"
}
},
"title": "TranscriptTurn",
"type": "object"
},
"type": "array"
},
"uuid": {
"description": "Transcription ID.",
"example": "e84f350f-6da7-4b56-80eb-41dec572626b",
"type": "string"
}
},
"required": [
"transcript",
"turns",
"uuid",
"language",
"duration",
"charge",
"status",
"transcription_date",
"call_date",
"call_uuid",
"call_score",
"call_summary"
],
"title": "CdrTranscriptionResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Creates a short link.",
"inputSchema": {
"properties": {
"expiration_time": {
"description": "Expiration date and time in ISO 8601 format.",
"example": "2023-07-19T18:18:34.235Z",
"format": "date-time",
"type": "string"
},
"fallback_url": {
"description": "Fallback URL for expired or invalid links.",
"example": "https://examples.com/fallback",
"type": "string"
},
"link": {
"description": "Target URL to shorten.",
"example": "https://your-site.com/long-url",
"type": "string"
},
"phone": {
"description": "Phone number for the short link.",
"example": "15155982927",
"type": "string"
},
"utm_campaign": {
"description": "UTM campaign name for tracking insights.",
"example": "summer_promo",
"type": "string"
}
},
"required": [
"link"
],
"type": "object"
},
"name": "link_shortener_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"short_link": {
"description": "Generated short URL.",
"example": "https://wx.com/hd82Jhs21",
"type": "string"
}
},
"required": [
"short_link"
],
"title": "ShortLinkResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns short link metrics.",
"inputSchema": {
"properties": {
"from": {
"description": "Start date in `YYYY-MM-DD` format.",
"example": "2023-05-01",
"format": "date",
"type": "string"
},
"page": {
"description": "Page number to retrieve.",
"example": 1,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"phone": {
"description": "Phone number for filtering.",
"example": "1872025555",
"type": "string"
},
"to": {
"description": "End date in `YYYY-MM-DD` format.",
"example": "2023-05-31",
"format": "date",
"type": "string"
},
"utm_campaign": {
"description": "UTM campaign name for filtering.",
"example": "summer",
"type": "string"
}
},
"required": [
"from",
"to"
],
"type": "object"
},
"name": "link_shortener_metrics_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"metrics": {
"description": "List of short link metrics matching search criteria.",
"items": {
"additionalProperties": false,
"properties": {
"browser": {
"description": "Browser used to open the short link.",
"example": "Firefox",
"type": [
"string",
"null"
]
},
"created_at": {
"description": "Date and time when short link was opened.",
"example": "2023-07-19 18:23:42.120Z",
"type": "string"
},
"language": {
"description": "Browser language preference.",
"example": "English",
"type": [
"string",
"null"
]
},
"latitude": {
"description": "Latitude of the location derived from the IP address\n used to open the short link.",
"example": 59.3247,
"type": [
"number",
"null"
]
},
"link_hash": {
"description": "Hash of the short link.",
"example": "hd82Jhs21",
"type": "string"
},
"longitude": {
"description": "Longitude of the location derived from the IP address\n used to open the short link.",
"example": 18.056,
"type": [
"number",
"null"
]
},
"operating_system": {
"description": "Operating system of the device that opened the short link.",
"example": "Mac OS X 10.15",
"type": [
"string",
"null"
]
},
"phone": {
"description": "Phone number associated with the short link.",
"example": "12762025555",
"type": [
"string",
"null"
]
},
"user_id": {
"description": "Account ID.",
"example": 100017,
"type": "integer"
},
"utm_campaign": {
"description": "UTM campaign name associated with the short link.",
"example": "summer",
"type": [
"string",
"null"
]
}
},
"required": [
"latitude",
"longitude",
"operating_system",
"browser",
"language",
"phone",
"utm_campaign",
"created_at",
"user_id",
"link_hash"
],
"title": "ShortLinkMetricsItem",
"type": "object"
},
"type": "array"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
}
},
"required": [
"metrics",
"pagination"
],
"title": "ShortLinkMetricsResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Releases phone numbers back to stock.",
"inputSchema": {
"properties": {
"dids": {
"description": "List of phone numbers to release.",
"example": "47832123321,47832123324,478321233215",
"type": "string"
},
"ids": {
"description": "List of phone number IDs to release.",
"example": [
47832123321,
47832123324,
478321233215
],
"items": {
"type": "integer"
},
"type": "array"
}
},
"required": [],
"type": "object"
},
"name": "my_numbers_delete",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Updates inbound call routing for phone numbers.",
"inputSchema": {
"properties": {
"destinations": {
"description": "Inbound call destinations to apply.",
"items": {
"additionalProperties": false,
"description": "Inbound call destination",
"example": {
"destination": "32882",
"priority": 1,
"transport": 5,
"trunk_id": 3107
},
"properties": {
"destination": {
"description": "SIP URI, PSTN number, or SIP trunk login for inbound call routing.",
"example": "[did]@sipuri.com",
"type": "string"
},
"priority": {
"description": "Destination priority (lower is higher priority).",
"example": 1,
"format": "int32",
"type": "integer"
},
"transport": {
"description": "Inbound call transport",
"enum": [
1,
4,
5
],
"title": "InboundCallTransport",
"type": "integer"
},
"trunk_id": {
"description": "SIP trunk ID when `transport` is 5, otherwise null.",
"example": 23123,
"format": "int32",
"type": [
"integer",
"null"
]
}
},
"required": [
"destination",
"priority",
"transport"
],
"title": "NumberDestination",
"type": "object"
},
"type": "array"
},
"ids": {
"description": "List of phone number IDs to update.",
"example": [
1,
2,
3
],
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
},
"sms_relay_url": {
"description": "Callback URL for inbound SMS and MMS messages.",
"example": "https://examples.com/sms-webhook",
"format": "uri",
"type": "string"
}
},
"required": [
"ids",
"destinations",
"sms_relay_url"
],
"type": "object"
},
"name": "my_numbers_destinations_update",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a phone number.",
"inputSchema": {
"properties": {
"id": {
"description": "Phone number ID.",
"example": 123,
"format": "int32",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "my_numbers_get",
"outputSchema": {
"additionalProperties": false,
"properties": {
"activation_fee": {
"description": "One-time activation fee in USD.",
"example": "0.99",
"type": "string"
},
"added": {
"description": "Date and time the phone number was purchased in ISO 8601 format.",
"example": "2023-04-10T06:42:59.000Z",
"format": "date-time",
"type": "string"
},
"call_recording_enabled": {
"description": "Indicates whether call recording is enabled.",
"example": true,
"type": "boolean"
},
"call_status_url": {
"description": "Callback URL for call status updates.",
"example": "https://example.com",
"type": [
"string",
"null"
]
},
"channels": {
"description": "Maximum number of concurrent inbound calls.",
"example": 24,
"format": "int32",
"type": "integer"
},
"city": {
"description": "City or rate center where the phone number originates.",
"example": "DETROIT, MI",
"type": "string"
},
"cnam": {
"description": "Indicates whether CNAM is enabled.",
"example": true,
"type": [
"boolean",
"null"
]
},
"country": {
"description": "Country where the phone number originates.",
"example": "United States",
"type": "string"
},
"country_short_name": {
"description": "Two-letter ISO country code.",
"example": "US",
"type": "string"
},
"destination": {
"description": "Inbound call destinations set for the phone number.",
"items": {
"additionalProperties": false,
"description": "Inbound call destination",
"properties": {
"destination": {
"description": "The destination for inbound call routing. Can be either a SIP URI, a PSTN phone number or system-generated login of a SIP trunk on the platform.",
"example": "[did]@sipuri.com",
"type": "string"
},
"id": {
"description": "Unique identifier of the inbound call destination",
"example": 1,
"format": "int32",
"type": "integer"
},
"priority": {
"description": "For DIDs with several destinations, sets the order of the destination the platform routes inbound calls to. The lesser the value, the higher the priority is.",
"example": 1,
"format": "int32",
"type": "integer"
},
"srtp": {
"example": false,
"type": "boolean"
},
"transport": {
"description": "Inbound call transport",
"enum": [
1,
4,
5
],
"title": "InboundCallTransport",
"type": "integer"
},
"trunk_id": {
"description": "Unique identified of a SIP trunk on the platform. In cases when `transport:5`, otherwise, `null`",
"example": 23123,
"format": "int32",
"type": [
"integer",
"null"
]
},
"trunk_label": {
"description": "A user-defined name of a SIP trunk on the platform. In cases when `transport:5`, otherwise, `null`",
"example": "My trunk",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"destination",
"priority",
"transport",
"trunk_id",
"trunk_label"
],
"title": "InboundCallDestination",
"type": "object"
},
"type": "array"
},
"documents": {
"description": "Uploaded documents for the phone number.",
"items": {
"additionalProperties": false,
"description": "A document uploaded for a phone number",
"example": {
"allow_replace": false,
"did_number": "12565378257",
"doc_content_type": "image/png",
"doc_file_name": "Copy of ID.png",
"doc_type_id": 1,
"id": 423,
"status": "approved",
"url": "https://api.wavix.com/v1/mydids/24882/papers/1"
},
"properties": {
"allow_replace": {
"description": "Indicates if the document can be replaced. You can only replace documents with `rejected` status.",
"example": false,
"type": "boolean"
},
"did_number": {
"description": "The phone number the document was uploaded for",
"example": "12565378257",
"type": "string"
},
"doc_content_type": {
"description": "The uploaded content type identified by the platform",
"example": "image/png",
"type": "string"
},
"doc_file_name": {
"description": "The uploaded document name",
"example": "Copy of ID.png",
"type": "string"
},
"doc_type_id": {
"description": "Specifies the type of document required to activate the phone number.\nPossible values are: `1` - Proof of identity, `2` - Proof of address, `3` - Proof of business registration.",
"enum": [
1,
2,
3
],
"title": "DocumentTypeId",
"type": "integer"
},
"id": {
"description": "Unique identifier of the uploaded document",
"example": 1,
"format": "int32",
"type": "integer"
},
"status": {
"description": "Status of the uploaded document. Can be either `approved`, `pending`, or `rejected`",
"type": "string"
},
"url": {
"description": "A link to the uploaded document",
"example": "https://api.wavix.com/v1/mydids/24882/papers/1\"",
"type": "string"
}
},
"required": [
"id",
"allow_replace",
"did_number",
"doc_content_type",
"doc_file_name",
"doc_type_id",
"status",
"url"
],
"title": "NumberDocument",
"type": "object"
},
"type": "array"
},
"domestic_cli": {
"description": "Indicates whether the number can be used as the Caller ID for local calls.",
"type": "boolean"
},
"free_min": {
"description": "Number of free inbound minutes.",
"type": "integer"
},
"id": {
"description": "Phone number ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"label": {
"description": "Label assigned to the phone number.",
"type": [
"string",
"null"
]
},
"monthly_fee": {
"description": "Monthly fee in USD.",
"example": "0.99",
"type": "string"
},
"number": {
"description": "Phone number.",
"example": "12565378257",
"type": "string"
},
"paid_until": {
"description": "Date until which the number is paid.",
"example": "2023-12-07",
"format": "date",
"type": "string"
},
"per_min": {
"description": "Price per inbound minute in USD.",
"example": "0.01",
"type": "string"
},
"require_docs": {
"description": "Documents required to activate the phone number.",
"example": [
"1"
],
"items": {
"type": "string"
},
"type": "array"
},
"seconds": {
"description": "Total inbound call duration in seconds for current month.",
"type": "string"
},
"sms_enabled": {
"description": "Indicates whether SMS is enabled.",
"example": false,
"type": "boolean"
},
"sms_relay_url": {
"description": "Callback URL for inbound SMS and MMS messages.",
"example": "https://your-website.com/webhook",
"type": [
"string",
"null"
]
},
"state": {
"description": "State where the phone number originates. For non-US numbers, this field may be null.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Phone number status. `active` means the number can receive and place calls; `inactive` means it cannot.",
"type": "string"
},
"transcription_enabled": {
"description": "Indicates whether transcription is enabled.",
"example": true,
"type": "boolean"
},
"transcription_threshold": {
"description": "Minimum call duration in seconds to trigger transcription.",
"example": 6,
"format": "int32",
"type": "integer"
},
"unlimited": {
"description": "Indicates whether usage is unlimited.",
"type": "boolean"
}
},
"required": [
"id",
"number",
"activation_fee",
"monthly_fee",
"per_min",
"city",
"country",
"country_short_name",
"destination",
"channels",
"require_docs",
"documents",
"label",
"status",
"seconds",
"added",
"paid_until",
"sms_enabled",
"sms_relay_url",
"cnam",
"call_recording_enabled",
"transcription_enabled",
"transcription_threshold",
"domestic_cli"
],
"title": "Number",
"type": "object"
}
},
{
"description": "Returns a paginated list of phone numbers on the account. Results are limited to 25 records per page by default. Use `page` and `per_page` to navigate results.",
"inputSchema": {
"properties": {
"city_id": {
"description": "City or rate center for filtering.",
"example": 123,
"format": "int32",
"type": "integer"
},
"label": {
"description": "Label for filtering.",
"example": "ALEX",
"type": "string"
},
"label_present": {
"description": "Indicates whether to return only numbers with or without labels.",
"example": true,
"type": "boolean"
},
"page": {
"description": "Page number to retrieve.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 50,
"format": "int32",
"type": "integer"
},
"search": {
"description": "Phone number or partial number for filtering.",
"example": "256537",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "my_numbers_list",
"outputSchema": {
"additionalProperties": false,
"properties": {
"doc_types": {
"description": "Documents required to activate phone numbers.",
"items": {
"additionalProperties": false,
"properties": {
"id": {
"description": "Document type ID.",
"example": 2,
"format": "int32",
"type": "integer"
},
"name": {
"description": "Document type name.",
"example": "address",
"type": "string"
},
"title": {
"description": "Human-readable document type name.",
"example": "Proof of address",
"type": "string"
}
},
"required": [
"id",
"name",
"title"
],
"title": "DocumentType",
"type": "object"
},
"type": "array"
},
"items": {
"description": "List of phone numbers on the account.",
"items": {
"additionalProperties": false,
"properties": {
"activation_fee": {
"description": "One-time activation fee in USD.",
"example": "0.99",
"type": "string"
},
"added": {
"description": "Date and time the phone number was purchased in ISO 8601 format.",
"example": "2023-04-10T06:42:59.000Z",
"format": "date-time",
"type": "string"
},
"call_recording_enabled": {
"description": "Indicates whether call recording is enabled.",
"example": true,
"type": "boolean"
},
"call_status_url": {
"description": "Callback URL for call status updates.",
"example": "https://example.com",
"type": [
"string",
"null"
]
},
"channels": {
"description": "Maximum number of concurrent inbound calls.",
"example": 24,
"format": "int32",
"type": "integer"
},
"city": {
"description": "City or rate center where the phone number originates.",
"example": "DETROIT, MI",
"type": "string"
},
"cnam": {
"description": "Indicates whether CNAM is enabled.",
"example": true,
"type": [
"boolean",
"null"
]
},
"country": {
"description": "Country where the phone number originates.",
"example": "United States",
"type": "string"
},
"country_short_name": {
"description": "Two-letter ISO country code.",
"example": "US",
"type": "string"
},
"destination": {
"description": "Inbound call destinations set for the phone number.",
"items": {
"additionalProperties": false,
"description": "Inbound call destination",
"properties": {
"destination": {
"description": "The destination for inbound call routing. Can be either a SIP URI, a PSTN phone number or system-generated login of a SIP trunk on the platform.",
"example": "[did]@sipuri.com",
"type": "string"
},
"id": {
"description": "Unique identifier of the inbound call destination",
"example": 1,
"format": "int32",
"type": "integer"
},
"priority": {
"description": "For DIDs with several destinations, sets the order of the destination the platform routes inbound calls to. The lesser the value, the higher the priority is.",
"example": 1,
"format": "int32",
"type": "integer"
},
"srtp": {
"example": false,
"type": "boolean"
},
"transport": {
"description": "Inbound call transport",
"enum": [
1,
4,
5
],
"title": "InboundCallTransport",
"type": "integer"
},
"trunk_id": {
"description": "Unique identified of a SIP trunk on the platform. In cases when `transport:5`, otherwise, `null`",
"example": 23123,
"format": "int32",
"type": [
"integer",
"null"
]
},
"trunk_label": {
"description": "A user-defined name of a SIP trunk on the platform. In cases when `transport:5`, otherwise, `null`",
"example": "My trunk",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"destination",
"priority",
"transport",
"trunk_id",
"trunk_label"
],
"title": "InboundCallDestination",
"type": "object"
},
"type": "array"
},
"documents": {
"description": "Uploaded documents for the phone number.",
"items": {
"additionalProperties": false,
"description": "A document uploaded for a phone number",
"example": {
"allow_replace": false,
"did_number": "12565378257",
"doc_content_type": "image/png",
"doc_file_name": "Copy of ID.png",
"doc_type_id": 1,
"id": 423,
"status": "approved",
"url": "https://api.wavix.com/v1/mydids/24882/papers/1"
},
"properties": {
"allow_replace": {
"description": "Indicates if the document can be replaced. You can only replace documents with `rejected` status.",
"example": false,
"type": "boolean"
},
"did_number": {
"description": "The phone number the document was uploaded for",
"example": "12565378257",
"type": "string"
},
"doc_content_type": {
"description": "The uploaded content type identified by the platform",
"example": "image/png",
"type": "string"
},
"doc_file_name": {
"description": "The uploaded document name",
"example": "Copy of ID.png",
"type": "string"
},
"doc_type_id": {
"description": "Specifies the type of document required to activate the phone number.\nPossible values are: `1` - Proof of identity, `2` - Proof of address, `3` - Proof of business registration.",
"enum": [
1,
2,
3
],
"title": "DocumentTypeId",
"type": "integer"
},
"id": {
"description": "Unique identifier of the uploaded document",
"example": 1,
"format": "int32",
"type": "integer"
},
"status": {
"description": "Status of the uploaded document. Can be either `approved`, `pending`, or `rejected`",
"type": "string"
},
"url": {
"description": "A link to the uploaded document",
"example": "https://api.wavix.com/v1/mydids/24882/papers/1\"",
"type": "string"
}
},
"required": [
"id",
"allow_replace",
"did_number",
"doc_content_type",
"doc_file_name",
"doc_type_id",
"status",
"url"
],
"title": "NumberDocument",
"type": "object"
},
"type": "array"
},
"domestic_cli": {
"description": "Indicates whether the number can be used as the Caller ID for local calls.",
"type": "boolean"
},
"free_min": {
"description": "Number of free inbound minutes.",
"type": "integer"
},
"id": {
"description": "Phone number ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"label": {
"description": "Label assigned to the phone number.",
"type": [
"string",
"null"
]
},
"monthly_fee": {
"description": "Monthly fee in USD.",
"example": "0.99",
"type": "string"
},
"number": {
"description": "Phone number.",
"example": "12565378257",
"type": "string"
},
"paid_until": {
"description": "Date until which the number is paid.",
"example": "2023-12-07",
"format": "date",
"type": "string"
},
"per_min": {
"description": "Price per inbound minute in USD.",
"example": "0.01",
"type": "string"
},
"require_docs": {
"description": "Documents required to activate the phone number.",
"example": [
"1"
],
"items": {
"type": "string"
},
"type": "array"
},
"seconds": {
"description": "Total inbound call duration in seconds for current month.",
"type": "string"
},
"sms_enabled": {
"description": "Indicates whether SMS is enabled.",
"example": false,
"type": "boolean"
},
"sms_relay_url": {
"description": "Callback URL for inbound SMS and MMS messages.",
"example": "https://your-website.com/webhook",
"type": [
"string",
"null"
]
},
"state": {
"description": "State where the phone number originates. For non-US numbers, this field may be null.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Phone number status. `active` means the number can receive and place calls; `inactive` means it cannot.",
"type": "string"
},
"transcription_enabled": {
"description": "Indicates whether transcription is enabled.",
"example": true,
"type": "boolean"
},
"transcription_threshold": {
"description": "Minimum call duration in seconds to trigger transcription.",
"example": 6,
"format": "int32",
"type": "integer"
},
"unlimited": {
"description": "Indicates whether usage is unlimited.",
"type": "boolean"
}
},
"required": [
"id",
"number",
"activation_fee",
"monthly_fee",
"per_min",
"city",
"country",
"country_short_name",
"destination",
"channels",
"require_docs",
"documents",
"label",
"status",
"seconds",
"added",
"paid_until",
"sms_enabled",
"sms_relay_url",
"cnam",
"call_recording_enabled",
"transcription_enabled",
"transcription_threshold",
"domestic_cli"
],
"title": "Number",
"type": "object"
},
"type": "array"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
}
},
"required": [
"items",
"doc_types",
"pagination"
],
"title": "NumberListResponse",
"type": "object"
}
},
{
"description": "Uploads a document for one or more phone numbers.\nUploaded files must meet the following requirements:\n- Allowed formats: PNG, JPG, JPEG, TIFF, BMP, or PDF\n- Maximum file size: 10 MB\n- Files can't be password protected\n- PDF files must not contain digital signatures",
"inputSchema": {
"properties": {
"did_ids": {
"description": "List of phone number IDs.",
"example": "2321",
"type": "string"
},
"doc_attachment": {
"description": "Document file to upload.",
"format": "binary",
"type": "string"
},
"doc_id": {
"description": "Specifies the type of document required to activate the phone number.\nPossible values are: `1` - Proof of identity, `2` - Proof of address, `3` - Proof of business registration.",
"enum": [
1,
2,
3
],
"title": "DocumentTypeId",
"type": "integer"
}
},
"required": [],
"type": "object"
},
"name": "my_numbers_papers_upload",
"outputSchema": {
"properties": {
"result": {
"items": {
"additionalProperties": false,
"properties": {
"allow_replace": {
"description": "Indicates whether the document can be replaced.",
"example": false,
"type": "boolean"
},
"did_number": {
"description": "Phone number the document applies to.",
"example": "+14062355770",
"type": "string"
},
"doc_content_type": {
"description": "MIME type of the document.",
"example": "image/png",
"type": "string"
},
"doc_file_name": {
"description": "Document file name.",
"example": "user-id-card.png",
"type": "string"
},
"doc_type_id": {
"description": "Specifies the type of document required to activate the phone number.\nPossible values are: `1` - Proof of identity, `2` - Proof of address, `3` - Proof of business registration.",
"enum": [
1,
2,
3
],
"title": "DocumentTypeId",
"type": "integer"
},
"id": {
"description": "Document ID.",
"example": 101,
"type": "integer"
},
"status": {
"description": "Document review status.",
"example": "pending",
"type": "string"
},
"url": {
"description": "URL to access the document.",
"example": "https://api.wavix.com/v1/mydids/1001/papers/101",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Enables or disables inbound SMS support for a phone number.",
"inputSchema": {
"properties": {
"id": {
"description": "Phone number ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"sms_enabled": {
"description": "Indicates whether inbound SMS is enabled.",
"example": true,
"type": "boolean"
}
},
"required": [],
"type": "object"
},
"name": "my_numbers_sms_update",
"outputSchema": {
"properties": {
"success": {
"description": "Indicates whether the request succeeded.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Updates a phone number.",
"inputSchema": {
"properties": {
"call_recording_enabled": {
"description": "Indicates whether call recording is enabled.",
"example": true,
"type": "boolean"
},
"call_status_url": {
"description": "Callback URL for call status updates.",
"example": "https://your-site.com/calls",
"type": "string"
},
"id": {
"description": "Phone number ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"sms_relay_url": {
"description": "Callback URL for inbound messages. Set to `null`\n to remove routing.",
"example": "https://you-site.com/sms",
"type": "string"
},
"transcription_enabled": {
"description": "Indicates whether transcription is enabled.",
"example": true,
"type": "boolean"
},
"transcription_threshold": {
"description": "Transcription threshold in seconds.",
"example": 30,
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "my_numbers_update",
"outputSchema": {
"additionalProperties": false,
"properties": {
"activation_fee": {
"description": "One-time activation fee in USD.",
"example": "0.99",
"type": "string"
},
"added": {
"description": "Date and time the phone number was purchased in ISO 8601 format.",
"example": "2023-04-10T06:42:59.000Z",
"format": "date-time",
"type": "string"
},
"call_recording_enabled": {
"description": "Indicates whether call recording is enabled.",
"example": true,
"type": "boolean"
},
"call_status_url": {
"description": "Callback URL for call status updates.",
"example": "https://example.com",
"type": [
"string",
"null"
]
},
"channels": {
"description": "Maximum number of concurrent inbound calls.",
"example": 24,
"format": "int32",
"type": "integer"
},
"city": {
"description": "City or rate center where the phone number originates.",
"example": "DETROIT, MI",
"type": "string"
},
"cnam": {
"description": "Indicates whether CNAM is enabled.",
"example": true,
"type": [
"boolean",
"null"
]
},
"country": {
"description": "Country where the phone number originates.",
"example": "United States",
"type": "string"
},
"country_short_name": {
"description": "Two-letter ISO country code.",
"example": "US",
"type": "string"
},
"destination": {
"description": "Inbound call destinations set for the phone number.",
"items": {
"additionalProperties": false,
"description": "Inbound call destination",
"properties": {
"destination": {
"description": "The destination for inbound call routing. Can be either a SIP URI, a PSTN phone number or system-generated login of a SIP trunk on the platform.",
"example": "[did]@sipuri.com",
"type": "string"
},
"id": {
"description": "Unique identifier of the inbound call destination",
"example": 1,
"format": "int32",
"type": "integer"
},
"priority": {
"description": "For DIDs with several destinations, sets the order of the destination the platform routes inbound calls to. The lesser the value, the higher the priority is.",
"example": 1,
"format": "int32",
"type": "integer"
},
"srtp": {
"example": false,
"type": "boolean"
},
"transport": {
"description": "Inbound call transport",
"enum": [
1,
4,
5
],
"title": "InboundCallTransport",
"type": "integer"
},
"trunk_id": {
"description": "Unique identified of a SIP trunk on the platform. In cases when `transport:5`, otherwise, `null`",
"example": 23123,
"format": "int32",
"type": [
"integer",
"null"
]
},
"trunk_label": {
"description": "A user-defined name of a SIP trunk on the platform. In cases when `transport:5`, otherwise, `null`",
"example": "My trunk",
"type": [
"string",
"null"
]
}
},
"required": [
"id",
"destination",
"priority",
"transport",
"trunk_id",
"trunk_label"
],
"title": "InboundCallDestination",
"type": "object"
},
"type": "array"
},
"documents": {
"description": "Uploaded documents for the phone number.",
"items": {
"additionalProperties": false,
"description": "A document uploaded for a phone number",
"example": {
"allow_replace": false,
"did_number": "12565378257",
"doc_content_type": "image/png",
"doc_file_name": "Copy of ID.png",
"doc_type_id": 1,
"id": 423,
"status": "approved",
"url": "https://api.wavix.com/v1/mydids/24882/papers/1"
},
"properties": {
"allow_replace": {
"description": "Indicates if the document can be replaced. You can only replace documents with `rejected` status.",
"example": false,
"type": "boolean"
},
"did_number": {
"description": "The phone number the document was uploaded for",
"example": "12565378257",
"type": "string"
},
"doc_content_type": {
"description": "The uploaded content type identified by the platform",
"example": "image/png",
"type": "string"
},
"doc_file_name": {
"description": "The uploaded document name",
"example": "Copy of ID.png",
"type": "string"
},
"doc_type_id": {
"description": "Specifies the type of document required to activate the phone number.\nPossible values are: `1` - Proof of identity, `2` - Proof of address, `3` - Proof of business registration.",
"enum": [
1,
2,
3
],
"title": "DocumentTypeId",
"type": "integer"
},
"id": {
"description": "Unique identifier of the uploaded document",
"example": 1,
"format": "int32",
"type": "integer"
},
"status": {
"description": "Status of the uploaded document. Can be either `approved`, `pending`, or `rejected`",
"type": "string"
},
"url": {
"description": "A link to the uploaded document",
"example": "https://api.wavix.com/v1/mydids/24882/papers/1\"",
"type": "string"
}
},
"required": [
"id",
"allow_replace",
"did_number",
"doc_content_type",
"doc_file_name",
"doc_type_id",
"status",
"url"
],
"title": "NumberDocument",
"type": "object"
},
"type": "array"
},
"domestic_cli": {
"description": "Indicates whether the number can be used as the Caller ID for local calls.",
"type": "boolean"
},
"free_min": {
"description": "Number of free inbound minutes.",
"type": "integer"
},
"id": {
"description": "Phone number ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"label": {
"description": "Label assigned to the phone number.",
"type": [
"string",
"null"
]
},
"monthly_fee": {
"description": "Monthly fee in USD.",
"example": "0.99",
"type": "string"
},
"number": {
"description": "Phone number.",
"example": "12565378257",
"type": "string"
},
"paid_until": {
"description": "Date until which the number is paid.",
"example": "2023-12-07",
"format": "date",
"type": "string"
},
"per_min": {
"description": "Price per inbound minute in USD.",
"example": "0.01",
"type": "string"
},
"require_docs": {
"description": "Documents required to activate the phone number.",
"example": [
"1"
],
"items": {
"type": "string"
},
"type": "array"
},
"seconds": {
"description": "Total inbound call duration in seconds for current month.",
"type": "string"
},
"sms_enabled": {
"description": "Indicates whether SMS is enabled.",
"example": false,
"type": "boolean"
},
"sms_relay_url": {
"description": "Callback URL for inbound SMS and MMS messages.",
"example": "https://your-website.com/webhook",
"type": [
"string",
"null"
]
},
"state": {
"description": "State where the phone number originates. For non-US numbers, this field may be null.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Phone number status. `active` means the number can receive and place calls; `inactive` means it cannot.",
"type": "string"
},
"transcription_enabled": {
"description": "Indicates whether transcription is enabled.",
"example": true,
"type": "boolean"
},
"transcription_threshold": {
"description": "Minimum call duration in seconds to trigger transcription.",
"example": 6,
"format": "int32",
"type": "integer"
},
"unlimited": {
"description": "Indicates whether usage is unlimited.",
"type": "boolean"
}
},
"required": [
"id",
"number",
"activation_fee",
"monthly_fee",
"per_min",
"city",
"country",
"country_short_name",
"destination",
"channels",
"require_docs",
"documents",
"label",
"status",
"seconds",
"added",
"paid_until",
"sms_enabled",
"sms_relay_url",
"cnam",
"call_recording_enabled",
"transcription_enabled",
"transcription_threshold",
"domestic_cli"
],
"title": "Number",
"type": "object"
}
},
{
"description": "Returns details for multiple phone numbers. If `async` is true, returns a token to poll for results.",
"inputSchema": {
"properties": {
"async": {
"description": "Indicates whether the request should be executed asynchronously. If `true`, the response will include a `request_uuid` that can be used to poll for results. If `false`, the response will include validation results directly.",
"example": true,
"type": "boolean"
},
"force": {
"description": "Force",
"example": true,
"type": "boolean"
},
"phone_numbers": {
"description": "List of phone numbers to get detailed information about.",
"example": [
"971501390098",
"971504359195"
],
"items": {
"type": "string"
},
"type": "array"
},
"type": {
"enum": [
"format",
"analysis",
"validation"
],
"title": "PhoneNumberValidationType",
"type": "string"
}
},
"required": [
"phone_numbers",
"type",
"async",
"force"
],
"type": "object"
},
"name": "number_validator_create_bulk",
"outputSchema": {
"properties": {
"result": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"description": "Total number of phone numbers in the request.",
"example": 1000,
"format": "int32",
"type": "integer"
},
"items": {
"description": "List of validation results for each phone number.",
"items": {
"additionalProperties": false,
"description": "Number validator response details.",
"properties": {
"carrier_name": {
"description": "Carrier name. `null` if the phone number is invalid.",
"example": "Etisalat",
"type": [
"string",
"null"
]
},
"charge": {
"description": "Charge for the validation.",
"example": "0.015",
"type": "string"
},
"country_code": {
"description": "Phone number country code in ISO 3166-1 alpha-2 format. `null` if the number is invalid.",
"example": "AE",
"type": [
"string",
"null"
]
},
"e164_format": {
"description": "Phone number in international E.164 format.",
"example": "+971569483322",
"type": "string"
},
"error_code": {
"description": "Error code. ",
"example": "000",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code (MCC). Applies to mobile numbers only. `null` if the phone number is invalid.",
"example": "424",
"type": [
"string",
"null"
]
},
"mnc": {
"description": "Mobile Network Code (MNC). Applies to mobile numbers only. `null` if the phone number is invalid.",
"example": "004",
"type": [
"string",
"null"
]
},
"national_format": {
"description": "Phone number in the national format of the identified country.",
"example": "056 948 3322",
"type": "string"
},
"number_type": {
"description": "Phone number type. Allowed values: `mobile`, `landline`, `toll-free`. `null` if the phone number is invalid.",
"example": "mobile",
"type": [
"string",
"null"
]
},
"phone_number": {
"description": "Phone number.",
"example": "971569483322",
"type": "string"
},
"ported": {
"description": "Indicates whether the phone number is ported. `null` if the phone number is invalid.",
"example": false,
"type": [
"boolean",
"null"
]
},
"reachable": {
"description": "Indicates whether the number is registered in a mobile network. Applies to mobile numbers only. `null` if the phone number is invalid.",
"example": true,
"type": [
"boolean",
"null"
]
},
"risky_destination": {
"description": "Indicates whether the phone number belongs to a range associated with traffic pumping. `null` if the phone number is invalid.",
"example": false,
"type": [
"boolean",
"null"
]
},
"roaming": {
"description": "Indicates whether the number is roaming. Applies to mobile numbers only.\n `null` if the phone number is invalid.",
"example": false,
"type": [
"boolean",
"null"
]
},
"timezone": {
"description": "Time zone identified based on the country and area code. `null` if the phone number is invalid.",
"example": "UTC+04:00",
"type": [
"string",
"null"
]
},
"unallocated_range": {
"description": "Indicates whether the phone number belongs to an unallocated range.\n `null` if the phone number is invalid.",
"example": false,
"type": [
"boolean",
"null"
]
},
"valid": {
"description": "Indicates whether the phone number is valid.",
"example": true,
"type": "boolean"
}
},
"required": [
"phone_number",
"valid",
"country_code",
"e164_format",
"national_format",
"charge",
"error_code"
],
"title": "PhoneValidationResultResponse",
"type": "object"
},
"type": "array"
},
"pending": {
"description": "Number of validations still in progress.",
"example": 0,
"type": "integer"
},
"status": {
"description": "Validation request status.",
"example": "success",
"type": "string"
}
},
"required": [
"count",
"items",
"status",
"pending"
],
"title": "PhoneValidationBatchResponse",
"type": "object"
},
{
"properties": {
"request_id": {
"description": "Request ID. Use to poll validation results when `async` is `true`.",
"example": "15323ba4-80c1-41be-b8e7-07bb435c7445",
"type": "string"
}
},
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns details for a phone number.",
"inputSchema": {
"properties": {
"phone_number": {
"description": "Phone number in E.164 format or without \"+\".",
"example": "971569483322",
"type": "string"
},
"type": {
"allOf": [
{
"enum": [
"format",
"analysis",
"validation"
],
"title": "PhoneNumberValidationType",
"type": "string"
}
],
"description": "Validation type."
}
},
"required": [
"phone_number",
"type"
],
"type": "object"
},
"name": "number_validator_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"carrier_name": {
"description": "Name of the phone number carrier. `null` if the phone number is invalid.",
"example": "Etisalat",
"type": [
"string",
"null"
]
},
"charge": {
"description": "Charge for the validation.",
"example": "0.015",
"type": "string"
},
"country_code": {
"description": "ISO 3166-1 alpha-2 country code of the phone number.\n `null` if the number is invalid.",
"example": "AE",
"type": [
"string",
"null"
]
},
"e164_format": {
"description": "Phone number in international E.164 format.",
"example": "+971569483322",
"type": "string"
},
"error_code": {
"description": "Error code for the request. `000` indicates success.\nPossible values:\n- `013`: — Internal service error\n- `021`: — Invalid phone number length or format\n- `041`: — Request timeout\n- `042`: — Request failed\n- `091`: — Insufficient funds",
"example": "000",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code of the phone number carrier. For mobile phone numbers only. `null` if the phone number is invalid.",
"example": "424",
"type": [
"string",
"null"
]
},
"mnc": {
"description": "Mobile Network Code of the phone number carrier. For mobile phone numbers only. `null` if the phone number is invalid",
"example": "004",
"type": [
"string",
"null"
]
},
"national_format": {
"description": "Phone number in the national format of the identified country.",
"example": "056 948 3322",
"type": "string"
},
"number_type": {
"description": "Number type. Possible values are `mobile`, `landline`, or `toll-free`. `null` if the phone number is invalid.",
"example": "mobile",
"type": [
"string",
"null"
]
},
"phone_number": {
"description": "Phone number.",
"example": "971569483322",
"type": "string"
},
"ported": {
"description": "Indicates whether the phone number was ported or not. `null` if the phone number is invalid.",
"example": false,
"type": [
"boolean",
"null"
]
},
"reachable": {
"description": "Indicates whether the number is registered in a mobile network. For mobile phone numbers only. `null` if the number is invalid",
"example": true,
"type": [
"boolean",
"null"
]
},
"risky_destination": {
"description": "Indicates whether the phone number belongs to a number range associated with traffic pumping. `null` if the number is invalid.",
"example": false,
"type": [
"boolean",
"null"
]
},
"roaming": {
"description": "Indicates whether the number is roaming. For mobile phone numbers only. `null` if the number is invalid",
"example": false,
"type": [
"boolean",
"null"
]
},
"timezone": {
"description": "Time zone based on the phone number's country and area code.\n `null` if the number is invalid.",
"example": "UTC+04:00",
"type": [
"string",
"null"
]
},
"unallocated_range": {
"description": "Indicates whether the phone number belongs to an unallocated number range. `null` if the number is invalid",
"example": false,
"type": [
"boolean",
"null"
]
},
"valid": {
"description": "Indicates whether the phone number is valid.",
"example": true,
"type": "boolean"
}
},
"required": [
"phone_number",
"valid",
"country_code",
"e164_format",
"national_format",
"charge",
"error_code"
],
"title": "PhoneValidationResponse",
"type": "object"
},
{
"example": {
"carrier_name": "Etisalat",
"charge": "0.015",
"country_code": "AE",
"e164_format": "+971569483322",
"error_code": "000",
"mcc": "424",
"mnc": "02",
"national_format": "056 948 3322",
"number_type": "mobile",
"phone_number": "971569483322",
"ported": false,
"reachable": true,
"risky_destination": false,
"roaming": false,
"timezone": "UTC+04:00",
"unallocated_range": false,
"valid": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns asynchronous validation results.",
"inputSchema": {
"properties": {
"request_id": {
"description": "Request ID.",
"example": "12542c5c-1a17-4d12-a163-5b68543e75f6",
"type": "string"
}
},
"required": [
"request_id"
],
"type": "object"
},
"name": "number_validator_results_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"count": {
"description": "The quantity of phone numbers passed in the request.",
"example": 1000,
"format": "int32",
"type": "integer"
},
"items": {
"description": "Array of objects containing details for each phone number.\n The returned fields depend on the `type` parameter.",
"example": [
{
"carrier_name": "Etisalat",
"charge": "0.015",
"country_code": "AE",
"e164_format": "+971501390098",
"error_code": "000",
"mcc": "424",
"mnc": "02",
"national_format": "050 139 0098",
"number_type": "mobile",
"phone_number": "971501390098",
"ported": false,
"reachable": true,
"risky_destination": false,
"roaming": false,
"timezone": "UTC+04:00",
"unallocated_range": false,
"valid": true
},
{
"carrier_name": "Etisalat",
"charge": "0.015",
"country_code": "AE",
"e164_format": "+971504359195",
"error_code": "000",
"mcc": "424",
"mnc": "02",
"national_format": "050 435 9195",
"number_type": "mobile",
"phone_number": "971504359195",
"ported": false,
"reachable": true,
"risky_destination": false,
"roaming": false,
"timezone": "UTC+04:00",
"unallocated_range": false,
"valid": true
}
],
"items": {
"additionalProperties": false,
"description": "Number validator response details.",
"properties": {
"carrier_name": {
"description": "Carrier name. `null` if the phone number is invalid.",
"example": "Etisalat",
"type": [
"string",
"null"
]
},
"charge": {
"description": "Charge for the validation.",
"example": "0.015",
"type": "string"
},
"country_code": {
"description": "Phone number country code in ISO 3166-1 alpha-2 format. `null` if the number is invalid.",
"example": "AE",
"type": [
"string",
"null"
]
},
"e164_format": {
"description": "Phone number in international E.164 format.",
"example": "+971569483322",
"type": "string"
},
"error_code": {
"description": "Error code. ",
"example": "000",
"type": "string"
},
"mcc": {
"description": "Mobile Country Code (MCC). Applies to mobile numbers only. `null` if the phone number is invalid.",
"example": "424",
"type": [
"string",
"null"
]
},
"mnc": {
"description": "Mobile Network Code (MNC). Applies to mobile numbers only. `null` if the phone number is invalid.",
"example": "004",
"type": [
"string",
"null"
]
},
"national_format": {
"description": "Phone number in the national format of the identified country.",
"example": "056 948 3322",
"type": "string"
},
"number_type": {
"description": "Phone number type. Allowed values: `mobile`, `landline`, `toll-free`. `null` if the phone number is invalid.",
"example": "mobile",
"type": [
"string",
"null"
]
},
"phone_number": {
"description": "Phone number.",
"example": "971569483322",
"type": "string"
},
"ported": {
"description": "Indicates whether the phone number is ported. `null` if the phone number is invalid.",
"example": false,
"type": [
"boolean",
"null"
]
},
"reachable": {
"description": "Indicates whether the number is registered in a mobile network. Applies to mobile numbers only. `null` if the phone number is invalid.",
"example": true,
"type": [
"boolean",
"null"
]
},
"risky_destination": {
"description": "Indicates whether the phone number belongs to a range associated with traffic pumping. `null` if the phone number is invalid.",
"example": false,
"type": [
"boolean",
"null"
]
},
"roaming": {
"description": "Indicates whether the number is roaming. Applies to mobile numbers only.\n `null` if the phone number is invalid.",
"example": false,
"type": [
"boolean",
"null"
]
},
"timezone": {
"description": "Time zone identified based on the country and area code. `null` if the phone number is invalid.",
"example": "UTC+04:00",
"type": [
"string",
"null"
]
},
"unallocated_range": {
"description": "Indicates whether the phone number belongs to an unallocated range.\n `null` if the phone number is invalid.",
"example": false,
"type": [
"boolean",
"null"
]
},
"valid": {
"description": "Indicates whether the phone number is valid.",
"example": true,
"type": "boolean"
}
},
"required": [
"phone_number",
"valid",
"country_code",
"e164_format",
"national_format",
"charge",
"error_code"
],
"title": "PhoneValidationResultResponse",
"type": "object"
},
"type": "array"
},
"pending": {
"description": "The quantity of phone numbers that are pending to be processed.",
"example": 10,
"format": "int32",
"type": "integer"
},
"status": {
"description": "Request status. Possible values are `success` and `in progress`.\n\n- `success`: All numbers were processed. - `in progress`: Several numbers are pending validation.",
"example": "success",
"type": "string"
}
},
"required": [
"status",
"pending",
"count",
"items"
],
"title": "PhoneValidationBatchResultResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns the account balance and configuration details.",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "profile_config_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"balance": {
"description": "Funds available on the account balance, in USD",
"example": "100",
"type": "string"
},
"global_limits": {
"additionalProperties": false,
"properties": {
"max_call_duration": {
"description": "Maximum outbound call duration, in seconds",
"example": 3600,
"format": "int32",
"type": "integer"
},
"max_call_rate": {
"description": "Maximum outbound call rate, in cents",
"example": "0.18",
"type": "string"
},
"max_sip_channels": {
"description": "Maximum number of concurrent outbound calls.",
"example": 2,
"format": "int32",
"type": "integer"
}
},
"required": [
"max_call_duration",
"max_sip_channels",
"max_call_rate"
],
"title": "AccountLimits",
"type": "object"
}
},
"required": [
"balance",
"global_limits"
],
"title": "ProfileConfigResponse",
"type": "object"
},
{
"example": {
"balance": "309.06",
"global_limits": {
"max_call_duration": 3600,
"max_call_rate": "99.0",
"max_sip_channels": 8
}
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns the account profile and billing details.",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "profile_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"additional_info": {
"description": "Additional info associated with the account.",
"example": "Additional info",
"type": [
"string",
"null"
]
},
"company_info": {
"additionalProperties": false,
"description": "Company details.",
"properties": {
"address": {
"description": "Company address.",
"example": "Baker street",
"type": [
"string",
"null"
]
},
"attn_contact_name": {
"description": "Billing contact name.",
"example": "James Scott",
"type": [
"string",
"null"
]
},
"country": {
"additionalProperties": false,
"description": "Country.",
"properties": {
"country_id": {
"description": "Country ID.",
"example": 1,
"type": [
"integer",
"null"
]
},
"country_name": {
"description": "Country name.",
"example": "United States",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"industry": {
"description": "Company industry.",
"enum": [
"telecommunications",
"information technology and services",
"fintech and finance",
"healthcare and pharmaceuticals",
"ecommerce and retail",
"education and research",
"pickup and delivery",
"transportation and logistics",
"media and entertainment",
"travel and hospitality",
"non-profit and charity organizations",
"manufacturing and industrial goods",
"other",
null
],
"example": "telecommunications",
"type": [
"string",
"null"
]
},
"name": {
"description": "Company name.",
"example": "Awesome company",
"type": [
"string",
"null"
]
},
"vat_number": {
"description": "VAT number.",
"example": "VAT123456789",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"contact_email": {
"description": "Additional email address for billing notifications.",
"example": "[email protected]",
"type": [
"string",
"null"
]
},
"default_destinations": {
"description": "Default destinations configured for the account.",
"example": [
{
"transport": "sms",
"value": "https://webhook.address.com/inboundSMS"
}
],
"items": {
"additionalProperties": false,
"properties": {
"transport": {
"description": "Transport type.",
"example": "sms",
"type": "string"
},
"value": {
"description": "Destination value",
"example": "https://webhook.address.com/inboundSMS",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"default_short_link_endpoint": {
"description": "Default short link endpoint.",
"example": "https://short.examples.com",
"type": [
"string",
"null"
]
},
"email": {
"description": "Email associated with the account.",
"example": "[email protected]",
"type": "string"
},
"first_name": {
"description": "Account owner's first name.",
"example": "Jason",
"type": [
"string",
"null"
]
},
"id": {
"description": "Account ID.",
"example": 1,
"format": "int32",
"type": "integer"
},
"job_title": {
"description": "Account owner's job title.",
"example": "Manager",
"type": [
"string",
"null"
]
},
"last_name": {
"description": "Account owner's last name.",
"example": "Androux",
"type": [
"string",
"null"
]
},
"phone": {
"description": "Account owner's phone number.",
"example": "13291019312",
"type": [
"string",
"null"
]
},
"timezone": {
"description": "Timezone configured on the account.",
"example": "Pacific/Wallis",
"type": "string"
}
},
"required": [
"id",
"email",
"first_name",
"last_name",
"phone",
"additional_info",
"contact_email",
"timezone",
"job_title",
"default_short_link_endpoint",
"default_destinations",
"company_info"
],
"title": "ProfileResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Updates the account profile and billing details.",
"inputSchema": {
"properties": {
"additional_info": {
"description": "Additional information associated with the account.",
"type": "string"
},
"company_info": {
"additionalProperties": false,
"properties": {
"attn_contact_name": {
"description": "Billing contact name.",
"type": "string"
},
"billing_address": {
"description": "Billing address.",
"type": "string"
},
"country_code": {
"description": "Country code.",
"type": "string"
},
"industry": {
"description": "Industry.",
"enum": [
"telecommunications",
"information technology and services",
"fintech and finance",
"healthcare and pharmaceuticals",
"ecommerce and retail",
"education and research",
"pickup and delivery",
"transportation and logistics",
"media and entertainment",
"travel and hospitality",
"non-profit and charity organizations",
"manufacturing and industrial goods",
"other"
],
"example": "telecommunications",
"type": "string"
},
"name": {
"description": "Company name.",
"type": "string"
},
"vat_number": {
"description": "VAT number.",
"type": "string"
}
},
"type": "object"
},
"contacts": {
"description": "Email associated with the account.",
"type": "string"
},
"default_short_link_endpoint": {
"description": "Default short link endpoint.",
"type": "string"
},
"dlr_relay_url": {
"description": "Callback URL to forward message delivery reports (DLRs) to.",
"type": "string"
},
"first_name": {
"description": "Account owner's first name.",
"type": "string"
},
"job_title": {
"description": "Account owner's job title.",
"type": "string"
},
"last_name": {
"description": "Account owner's last name.",
"type": "string"
},
"phone": {
"description": "Account owner's phone number",
"type": "string"
},
"sms_relay_url": {
"description": "Callback URL to forward inbound SMS to.",
"type": "string"
},
"time_zone": {
"description": "Timezone configured on the account.",
"example": "UTC",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "profile_update",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"additional_info": {
"description": "Additional info associated with the account.",
"example": "Additional info",
"type": [
"string",
"null"
]
},
"company_info": {
"additionalProperties": false,
"description": "Company details.",
"properties": {
"address": {
"description": "Company address.",
"example": "Baker street",
"type": [
"string",
"null"
]
},
"attn_contact_name": {
"description": "Billing contact name.",
"example": "James Scott",
"type": [
"string",
"null"
]
},
"country": {
"additionalProperties": false,
"description": "Country.",
"properties": {
"country_id": {
"description": "Country ID.",
"example": 1,
"type": [
"integer",
"null"
]
},
"country_name": {
"description": "Country name.",
"example": "United States",
"type": [
"string",
"null"
]
}
},
"type": "object"
},
"industry": {
"description": "Company industry.",
"enum": [
"telecommunications",
"information technology and services",
"fintech and finance",
"healthcare and pharmaceuticals",
"ecommerce and retail",
"education and research",
"pickup and delivery",
"transportation and logistics",
"media and entertainment",
"travel and hospitality",
"non-profit and charity organizations",
"manufacturing and industrial goods",
"other",
null
],
"example": "telecommunications",
"type": [
"string",
"null"
]
},
"name": {
"description": "Company name.",
"example": "Awesome company",
"type": [
"string",
"null"
]
},
"vat_number": {
"description": "VAT number.",
"example": "VAT123456789",
"type": [
"string",
"null"
]
}
},
"type": [
"object",
"null"
]
},
"contact_email": {
"description": "Additional email address for billing notifications.",
"example": "[email protected]",
"type": [
"string",
"null"
]
},
"default_destinations": {
"description": "Default destinations configured for the account.",
"example": [
{
"transport": "sms",
"value": "https://webhook.address.com/inboundSMS"
}
],
"items": {
"additionalProperties": false,
"properties": {
"transport": {
"description": "Transport type.",
"example": "sms",
"type": "string"
},
"value": {
"description": "Destination value",
"example": "https://webhook.address.com/inboundSMS",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"default_short_link_endpoint": {
"description": "Default short link endpoint.",
"example": "https://short.examples.com",
"type": [
"string",
"null"
]
},
"email": {
"description": "Email associated with the account.",
"example": "[email protected]",
"type": "string"
},
"first_name": {
"description": "Account owner's first name.",
"example": "Jason",
"type": [
"string",
"null"
]
},
"id": {
"description": "Account ID.",
"example": 1,
"format": "int32",
"type": "integer"
},
"job_title": {
"description": "Account owner's job title.",
"example": "Manager",
"type": [
"string",
"null"
]
},
"last_name": {
"description": "Account owner's last name.",
"example": "Androux",
"type": [
"string",
"null"
]
},
"phone": {
"description": "Account owner's phone number.",
"example": "13291019312",
"type": [
"string",
"null"
]
},
"timezone": {
"description": "Timezone configured on the account.",
"example": "Pacific/Wallis",
"type": "string"
}
},
"required": [
"id",
"email",
"first_name",
"last_name",
"phone",
"additional_info",
"contact_email",
"timezone",
"job_title",
"default_short_link_endpoint",
"default_destinations",
"company_info"
],
"title": "ProfileResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Creates a SIP trunk.",
"inputSchema": {
"properties": {
"allowed_ips": {
"description": "A list of public static IP addresses allowed to register with the SIP trunk",
"items": {
"additionalProperties": false,
"properties": {
"ip": {
"example": "127.0.0.1",
"type": "string"
}
},
"required": [
"ip"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"call_limit": {
"description": "A maximum call duration for the SIP trunk, in seconds. Must not exceed the maximum duration set for your account. Ignored when call_restrict is `false`.",
"example": 3600,
"format": "int32",
"type": "integer"
},
"call_recording_enabled": {
"description": "Indicates whether outbound call recording is enabled for the SIP trunk",
"example": true,
"type": "boolean"
},
"call_restrict": {
"description": "Indicates whether a maximum call duration limit is enforced for the SIP trunk",
"example": true,
"type": "boolean"
},
"callerid": {
"description": "Caller ID associated with the SIP trunk. Must be an active or verified number on your account.",
"example": "13132847320",
"type": "string"
},
"channels_restrict": {
"description": "Indicates whether a limit on the number of concurrent outbound calls is enforced for the SIP trunk",
"example": false,
"type": "boolean"
},
"cost_limit": {
"default": false,
"description": "Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.",
"example": true,
"type": "boolean"
},
"didinfo_enabled": {
"description": "Indicates whether inbound calls include dialed number information in the `To` header of SIP INVITE requests",
"example": true,
"type": "boolean"
},
"encrypted_media": {
"example": true,
"type": "boolean"
},
"host_request": {
"additionalProperties": false,
"description": "For SIP trunks with IP authentication, includes the SIP endpoint public static IP address and the status of the authentication request. Wavix authenticates all SIP traffic originating from this IP address.",
"properties": {
"host": {
"description": "SIP endpoint public static IP address",
"example": "127.0.0.1",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"ip_restrict": {
"description": "Indicates whether SIP trunk registration is allowed from only specific public static IP addresses. When set to `true`, the `allowed_ips` parameter must be provided.",
"example": false,
"type": "boolean"
},
"label": {
"description": "User-defined name of the SIP trunk",
"example": "My trunk",
"type": "string"
},
"machine_detection_enabled": {
"description": "Indicates whether automatic voicemail detection is enabled for the SIP trunk.\nAvailable for `Flex Pro` customers only.",
"example": true,
"type": "boolean"
},
"max_call_cost": {
"description": "Maximum cost for an outbound call, in USD",
"example": 0.18,
"format": "decimal",
"type": "number"
},
"max_channels": {
"description": "Maximum number of concurrent outbound calls for the SIP trunk. Must not exceed the outbound channel capacity set for your account. Ignored when channels_restrict is `false`.",
"example": 2,
"format": "int32",
"type": "integer"
},
"multiple_numbers": {
"description": "Indicates whether any active or verified phone number in your account can be used as the Caller ID for the SIP trunk",
"type": "boolean"
},
"password": {
"description": "Password set for the SIP trunk. Use a strong password to help keep your SIP trunk secure.",
"example": "4r=h;EaCB85QNtr2",
"type": "string"
},
"rewrite_cond": {
"description": "Number of leading digits to automatically remove from each dialed phone number",
"type": "string"
},
"rewrite_enabled": {
"description": "Indicates whether a custom dial plan is activated for the SIP trunk",
"example": true,
"type": "boolean"
},
"rewrite_prefix": {
"description": "Digits to automatically prepend to each dialed phone number",
"example": "1",
"type": "string"
},
"transcription_enabled": {
"description": "Indicates whether automatic call transcription is enabled for the SIP trunk.\nAvailable for `Flex Pro` customers only.",
"example": true,
"type": "boolean"
},
"transcription_threshold": {
"description": "Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds.\nAvailable for `Flex Pro` customers only.",
"example": 10,
"format": "int32",
"type": "integer"
}
},
"required": [
"label",
"password",
"callerid",
"ip_restrict",
"didinfo_enabled",
"call_restrict",
"cost_limit",
"channels_restrict",
"rewrite_enabled",
"transcription_enabled",
"transcription_threshold"
],
"type": "object"
},
"name": "sip_trunks_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"access_token": {
"description": "Static authentication token for the SIP trunk.",
"example": "123easwqe321132",
"type": [
"string",
"null"
]
},
"allowed_ips": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"description": "IP address ID.",
"example": 6712,
"format": "int32",
"type": "integer"
},
"ip": {
"description": "Public static IP address.",
"example": "127.0.0.1",
"type": "string"
}
},
"required": [
"id",
"ip"
],
"type": "object"
},
"title": "AllowedIPs",
"type": "array"
},
"call_limit": {
"description": "A maximum call duration for the SIP trunk, in seconds. Cannot be higher than the max call duration set for the account.",
"example": 3600,
"format": "int32",
"type": [
"integer",
"null"
]
},
"call_recording_enabled": {
"default": false,
"description": "Indicates if outbound call recording is enabled on the SIP trunk. Available for `Flex Pro` customers only.",
"example": true,
"type": "boolean"
},
"call_restrict": {
"default": false,
"description": "Indicates if maximum call duration limit is activated for the SIP trunk.",
"example": false,
"type": [
"boolean",
"null"
]
},
"callerid": {
"description": "Caller ID configured on the SIP trunk. Contains `null` if no Caller ID is set, or an empty string if multiple Caller IDs are allowed.",
"example": "12345678900",
"type": [
"string",
"null"
]
},
"channels_restrict": {
"default": false,
"description": "Indicates if the max number of concurrent outbound calls limit is activated for the SIP trunk.",
"example": false,
"type": "boolean"
},
"cost_limit": {
"default": false,
"description": "Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.",
"example": true,
"type": "boolean"
},
"created_at": {
"description": "Date and time the SIP trunk was created",
"example": "2023-05-16T17:13:25.000Z",
"format": "date-time",
"type": "string"
},
"didinfo_enabled": {
"default": true,
"description": "Indicates if inbound calls carry dialed number information in the 'To' header of SIP Invites",
"example": true,
"type": "boolean"
},
"encrypted_media": {
"description": "Encrypted media",
"example": true,
"type": "boolean"
},
"host": {
"description": "Host of siptrunk",
"example": "dynamic",
"type": "string"
},
"id": {
"description": "Unique identifier of the SIP trunk on the platform",
"example": 293,
"format": "int32",
"type": "integer"
},
"ip_restrict": {
"default": false,
"description": "Indicates whether IP restriction must be enabled on the SIP trunk",
"example": false,
"type": "boolean"
},
"label": {
"description": "User-defined name of the SIP trunk",
"example": "My trunk",
"type": "string"
},
"machine_detection_enabled": {
"default": false,
"description": "Indicates if automatic voicemail detection is enabled on the SIP trunk. Available for `Flex Pro` customers only.",
"example": true,
"type": "boolean"
},
"max_call_cost": {
"description": "A maximum cost of an outbound call, in USD.",
"example": "0.18",
"type": [
"string",
"null"
]
},
"max_channels": {
"description": "A maximum number of concurrent outbound calls placed via the SIP trunk. Cannot be higher than the outbound channel capacity configured on the account.",
"example": 2,
"format": "int32",
"type": [
"integer",
"null"
]
},
"multiple_numbers": {
"description": "Multiple numbers",
"example": true,
"type": "boolean"
},
"name": {
"description": "System-generated login name of the SIP trunk",
"example": "67758",
"type": "string"
},
"passthrough": {
"description": "Indicates whether Caller ID passthrough is enabled.",
"example": true,
"type": "boolean"
},
"rewrite_cond": {
"description": "Leading digits to be deleted from the dialed phone numbers.",
"type": "string"
},
"rewrite_enabled": {
"default": false,
"description": "Indicates if a custom dial plan is activated for the SIP trunk.",
"example": true,
"type": "boolean"
},
"rewrite_prefix": {
"description": "Leading digits to be added before the dialed phone numbers.",
"example": "1",
"type": "string"
},
"transcription_enabled": {
"default": false,
"description": "Indicates if automatic call transcription is enabled on the SIP trunk. Available for `Flex Pro` customers only.",
"example": false,
"type": "boolean"
},
"transcription_threshold": {
"default": 6,
"description": "Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds",
"example": 10,
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"name",
"callerid",
"label",
"allowed_ips",
"created_at"
],
"title": "SipTrunkResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Deletes a SIP trunk.",
"inputSchema": {
"properties": {
"id": {
"description": "SIP trunk ID.",
"example": 3107,
"format": "int32",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "sip_trunks_delete",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a SIP trunk configuration.",
"inputSchema": {
"properties": {
"id": {
"description": "SIP trunk ID.",
"example": 3107,
"format": "int32",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "sip_trunks_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"access_token": {
"description": "Static authentication token for the SIP trunk.",
"example": "123easwqe321132",
"type": [
"string",
"null"
]
},
"allowed_ips": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"description": "IP address ID.",
"example": 6712,
"format": "int32",
"type": "integer"
},
"ip": {
"description": "Public static IP address.",
"example": "127.0.0.1",
"type": "string"
}
},
"required": [
"id",
"ip"
],
"type": "object"
},
"title": "AllowedIPs",
"type": "array"
},
"call_limit": {
"description": "A maximum call duration for the SIP trunk, in seconds. Cannot be higher than the max call duration set for the account.",
"example": 3600,
"format": "int32",
"type": [
"integer",
"null"
]
},
"call_recording_enabled": {
"default": false,
"description": "Indicates if outbound call recording is enabled on the SIP trunk. Available for `Flex Pro` customers only.",
"example": true,
"type": "boolean"
},
"call_restrict": {
"default": false,
"description": "Indicates if maximum call duration limit is activated for the SIP trunk.",
"example": false,
"type": [
"boolean",
"null"
]
},
"callerid": {
"description": "Caller ID configured on the SIP trunk. Contains `null` if no Caller ID is set, or an empty string if multiple Caller IDs are allowed.",
"example": "12345678900",
"type": [
"string",
"null"
]
},
"channels_restrict": {
"default": false,
"description": "Indicates if the max number of concurrent outbound calls limit is activated for the SIP trunk.",
"example": false,
"type": "boolean"
},
"cost_limit": {
"default": false,
"description": "Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.",
"example": true,
"type": "boolean"
},
"created_at": {
"description": "Date and time the SIP trunk was created",
"example": "2023-05-16T17:13:25.000Z",
"format": "date-time",
"type": "string"
},
"didinfo_enabled": {
"default": true,
"description": "Indicates if inbound calls carry dialed number information in the 'To' header of SIP Invites",
"example": true,
"type": "boolean"
},
"encrypted_media": {
"description": "Encrypted media",
"example": true,
"type": "boolean"
},
"host": {
"description": "Host of siptrunk",
"example": "dynamic",
"type": "string"
},
"id": {
"description": "Unique identifier of the SIP trunk on the platform",
"example": 293,
"format": "int32",
"type": "integer"
},
"ip_restrict": {
"default": false,
"description": "Indicates whether IP restriction must be enabled on the SIP trunk",
"example": false,
"type": "boolean"
},
"label": {
"description": "User-defined name of the SIP trunk",
"example": "My trunk",
"type": "string"
},
"machine_detection_enabled": {
"default": false,
"description": "Indicates if automatic voicemail detection is enabled on the SIP trunk. Available for `Flex Pro` customers only.",
"example": true,
"type": "boolean"
},
"max_call_cost": {
"description": "A maximum cost of an outbound call, in USD.",
"example": "0.18",
"type": [
"string",
"null"
]
},
"max_channels": {
"description": "A maximum number of concurrent outbound calls placed via the SIP trunk. Cannot be higher than the outbound channel capacity configured on the account.",
"example": 2,
"format": "int32",
"type": [
"integer",
"null"
]
},
"multiple_numbers": {
"description": "Multiple numbers",
"example": true,
"type": "boolean"
},
"name": {
"description": "System-generated login name of the SIP trunk",
"example": "67758",
"type": "string"
},
"passthrough": {
"description": "Indicates whether Caller ID passthrough is enabled.",
"example": true,
"type": "boolean"
},
"rewrite_cond": {
"description": "Leading digits to be deleted from the dialed phone numbers.",
"type": "string"
},
"rewrite_enabled": {
"default": false,
"description": "Indicates if a custom dial plan is activated for the SIP trunk.",
"example": true,
"type": "boolean"
},
"rewrite_prefix": {
"description": "Leading digits to be added before the dialed phone numbers.",
"example": "1",
"type": "string"
},
"transcription_enabled": {
"default": false,
"description": "Indicates if automatic call transcription is enabled on the SIP trunk. Available for `Flex Pro` customers only.",
"example": false,
"type": "boolean"
},
"transcription_threshold": {
"default": 6,
"description": "Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds",
"example": 10,
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"name",
"callerid",
"label",
"allowed_ips",
"created_at"
],
"title": "SipTrunkResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a paginated list of SIP trunks. Results are limited to 25 records per page by default. Use `page` and `per_page` to navigate results.",
"inputSchema": {
"properties": {
"page": {
"description": "Page number to retrieve.",
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"format": "int32",
"type": "integer"
}
},
"required": [],
"type": "object"
},
"name": "sip_trunks_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"example": {
"pagination": {
"current_page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
},
"sip_trunks": [
{
"access_token": "siped7a3f5c1b9e042d6f8a4c2e7b9d1f3a5c8e0b2d4f6a8c0e2d4b6f8a1c3e5d7",
"auth_method": "IP auth",
"call_recording_enabled": true,
"callerid": "14302287001",
"charge": "24.637",
"encrypted_media": false,
"host_request": {
"host": "127.0.0.1",
"status": "pending"
},
"id": 3107,
"label": "My trunk",
"machine_detection_enabled": true,
"multiple_numbers": true,
"name": "32882",
"passthrough": false,
"status": "pending",
"talk_time": 65,
"transcription_enabled": true,
"transcription_threshold": 6
}
]
},
"properties": {
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
},
"sip_trunks": {
"description": "A list of SIP trunks associated with your account",
"items": {
"additionalProperties": false,
"description": "A SIP trunk associated with your account",
"example": {
"access_token": "siped7a3f5c1b9e042d6f8a4c2e7b9d1f3a5c8e0b2d4f6a8c0e2d4b6f8a1c3e5d7",
"auth_method": "Digest",
"call_recording_enabled": true,
"callerid": "14302287001",
"charge": "24.637",
"host_request": null,
"id": 3107,
"label": "My trunk",
"machine_detection_enabled": true,
"multiple_numbers": false,
"name": "32882",
"passthrough": false,
"status": "active",
"talk_time": 65,
"transcription_enabled": true,
"transcription_threshold": 6
},
"properties": {
"access_token": {
"description": "Static authentication token for the SIP trunk.",
"example": "siped7a3f5c1b9e042d6f8a4c2e7b9d1f3a5c8e0b2d4f6a8c0e2d4b6f8a1c3e5d7",
"type": [
"string",
"null"
]
},
"auth_method": {
"description": "SIP trunk authentication method. Can be either `Digest` or `IP auth`.",
"type": "string"
},
"call_recording_enabled": {
"default": false,
"description": "Indicates whether outbound call recording is enabled for the SIP trunk",
"type": "boolean"
},
"callerid": {
"description": "Caller ID associated with the SIP trunk. Contains `null` if no Caller ID is set, or an empty string if multiple Caller IDs are allowed.",
"example": "12345678900",
"type": [
"string",
"null"
]
},
"charge": {
"description": "Total cost of all outbound calls placed through the SIP trunk in the current month, in USD. Automatically resets at the beginning of each month.",
"example": "24.637",
"type": "string"
},
"encrypted_media": {
"description": "Indicates whether media enecryption (SRTP) is enabled for the SIP trunk",
"example": true,
"type": "boolean"
},
"host_request": {
"description": "For SIP trunks with IP-based authentication, contains the status of the IP authentication request.",
"properties": {
"host": {
"description": "The IP address submitted for authentication",
"example": "127.0.0.1",
"type": "string"
},
"status": {
"description": "Status of the IP authentication request",
"example": "pending",
"type": "string"
}
},
"type": [
"object",
"null"
]
},
"id": {
"description": "Unique identifier of the SIP trunk on the platform",
"example": 293,
"format": "int32",
"type": "integer"
},
"label": {
"description": "User-defined name of the SIP trunk",
"example": "My trunk",
"type": "string"
},
"machine_detection_enabled": {
"default": false,
"description": "Indicates whether automatic voicemail detection is enabled for the SIP trunk.\nAvailable for `Flex Pro` customers only.",
"type": "boolean"
},
"multiple_numbers": {
"description": "Indicates whether multiple Caller IDs are enabled for the SIP trunk",
"example": false,
"type": "boolean"
},
"name": {
"description": "System-generated login name of the SIP trunk",
"example": "67758",
"type": "string"
},
"passthrough": {
"description": "Indicates whether Caller ID passthrough is enabled for the SIP trunk",
"example": false,
"type": "boolean"
},
"status": {
"description": "Status of the SIP trunk. Possible values are:\n`active` - The SIP trunk is active and can be used to place outbound calls.\n`pending` - The IP authentication request is under review by the Wavix team.\n`rejected` - The IP authentication request was rejected by the Wavix team.\nSIP trunks with a `pending` or `rejected` status can't be used to place calls.",
"type": "string"
},
"talk_time": {
"description": "Total duration of all outbound calls placed through the SIP trunk the current month, in seconds. Automatically resets at the beginning of each month.",
"example": 65,
"format": "int32",
"type": "integer"
},
"transcription_enabled": {
"default": false,
"description": "Indicates whether automatic call transcription is enabled for the SIP trunk.\nAvailable for `Flex Pro` customers only.",
"type": "boolean"
},
"transcription_threshold": {
"default": 6,
"description": "Minimum call duration (in seconds) required to automatically generate a transcription. Transcriptions are created for calls that meet or exceed this value.\nAvailable to `Flex Pro` customers only.",
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"name",
"callerid",
"multiple_numbers",
"label",
"auth_method",
"host_request",
"status",
"talk_time",
"charge",
"access_token"
],
"title": "SipTrunkSummary",
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"required": [
"sip_trunks",
"pagination"
],
"title": "SipTrunkListResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Updates a SIP trunk configuration.",
"inputSchema": {
"properties": {
"allowed_ips": {
"description": "A list of public static IP addresses allowed to register with the SIP trunk",
"items": {
"additionalProperties": false,
"properties": {
"ip": {
"example": "127.0.0.1",
"type": "string"
}
},
"required": [
"ip"
],
"type": "object"
},
"type": [
"array",
"null"
]
},
"call_limit": {
"description": "A maximum call duration for the SIP trunk, in seconds. Must not exceed the maximum duration set for your account. Ignored when call_restrict is `false`.",
"example": 3600,
"format": "int32",
"type": "integer"
},
"call_recording_enabled": {
"description": "Indicates whether outbound call recording is enabled for the SIP trunk",
"example": true,
"type": "boolean"
},
"call_restrict": {
"description": "Indicates whether a maximum call duration limit is enforced for the SIP trunk",
"example": true,
"type": "boolean"
},
"callerid": {
"description": "Caller ID associated with the SIP trunk. Must be an active or verified number on your account.",
"example": "13132847320",
"type": "string"
},
"channels_restrict": {
"description": "Indicates whether a limit on the number of concurrent outbound calls is enforced for the SIP trunk",
"example": false,
"type": "boolean"
},
"cost_limit": {
"default": false,
"description": "Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.",
"example": true,
"type": "boolean"
},
"didinfo_enabled": {
"description": "Indicates whether inbound calls include dialed number information in the `To` header of SIP INVITE requests",
"example": true,
"type": "boolean"
},
"encrypted_media": {
"example": true,
"type": "boolean"
},
"host_request": {
"additionalProperties": false,
"description": "For SIP trunks with IP authentication, includes the SIP endpoint public static IP address and the status of the authentication request. Wavix authenticates all SIP traffic originating from this IP address.",
"properties": {
"host": {
"description": "SIP endpoint public static IP address",
"example": "127.0.0.1",
"type": "string"
}
},
"required": [
"host"
],
"type": "object"
},
"id": {
"description": "SIP trunk ID.",
"example": 3107,
"format": "int32",
"type": "integer"
},
"ip_restrict": {
"description": "Indicates whether SIP trunk registration is allowed from only specific public static IP addresses. When set to `true`, the `allowed_ips` parameter must be provided.",
"example": false,
"type": "boolean"
},
"label": {
"description": "User-defined name of the SIP trunk",
"example": "My trunk",
"type": "string"
},
"machine_detection_enabled": {
"description": "Indicates whether automatic voicemail detection is enabled for the SIP trunk.\nAvailable for `Flex Pro` customers only.",
"example": true,
"type": "boolean"
},
"max_call_cost": {
"description": "Maximum cost for an outbound call, in USD",
"example": 0.18,
"format": "decimal",
"type": "number"
},
"max_channels": {
"description": "Maximum number of concurrent outbound calls for the SIP trunk. Must not exceed the outbound channel capacity set for your account. Ignored when channels_restrict is `false`.",
"example": 2,
"format": "int32",
"type": "integer"
},
"multiple_numbers": {
"description": "Indicates whether any active or verified phone number in your account can be used as the Caller ID for the SIP trunk",
"type": "boolean"
},
"password": {
"description": "Password set for the SIP trunk. Use a strong password to help keep your SIP trunk secure.",
"example": "4r=h;EaCB85QNtr2",
"type": "string"
},
"rewrite_cond": {
"description": "Number of leading digits to automatically remove from each dialed phone number",
"type": "string"
},
"rewrite_enabled": {
"description": "Indicates whether a custom dial plan is activated for the SIP trunk",
"example": true,
"type": "boolean"
},
"rewrite_prefix": {
"description": "Digits to automatically prepend to each dialed phone number",
"example": "1",
"type": "string"
},
"transcription_enabled": {
"description": "Indicates whether automatic call transcription is enabled for the SIP trunk.\nAvailable for `Flex Pro` customers only.",
"example": true,
"type": "boolean"
},
"transcription_threshold": {
"description": "Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds.\nAvailable for `Flex Pro` customers only.",
"example": 10,
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"label",
"password",
"callerid",
"ip_restrict",
"didinfo_enabled",
"call_restrict",
"cost_limit",
"channels_restrict",
"rewrite_enabled",
"transcription_enabled",
"transcription_threshold"
],
"type": "object"
},
"name": "sip_trunks_update",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"access_token": {
"description": "Static authentication token for the SIP trunk.",
"example": "123easwqe321132",
"type": [
"string",
"null"
]
},
"allowed_ips": {
"items": {
"additionalProperties": false,
"properties": {
"id": {
"description": "IP address ID.",
"example": 6712,
"format": "int32",
"type": "integer"
},
"ip": {
"description": "Public static IP address.",
"example": "127.0.0.1",
"type": "string"
}
},
"required": [
"id",
"ip"
],
"type": "object"
},
"title": "AllowedIPs",
"type": "array"
},
"call_limit": {
"description": "A maximum call duration for the SIP trunk, in seconds. Cannot be higher than the max call duration set for the account.",
"example": 3600,
"format": "int32",
"type": [
"integer",
"null"
]
},
"call_recording_enabled": {
"default": false,
"description": "Indicates if outbound call recording is enabled on the SIP trunk. Available for `Flex Pro` customers only.",
"example": true,
"type": "boolean"
},
"call_restrict": {
"default": false,
"description": "Indicates if maximum call duration limit is activated for the SIP trunk.",
"example": false,
"type": [
"boolean",
"null"
]
},
"callerid": {
"description": "Caller ID configured on the SIP trunk. Contains `null` if no Caller ID is set, or an empty string if multiple Caller IDs are allowed.",
"example": "12345678900",
"type": [
"string",
"null"
]
},
"channels_restrict": {
"default": false,
"description": "Indicates if the max number of concurrent outbound calls limit is activated for the SIP trunk.",
"example": false,
"type": "boolean"
},
"cost_limit": {
"default": false,
"description": "Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.",
"example": true,
"type": "boolean"
},
"created_at": {
"description": "Date and time the SIP trunk was created",
"example": "2023-05-16T17:13:25.000Z",
"format": "date-time",
"type": "string"
},
"didinfo_enabled": {
"default": true,
"description": "Indicates if inbound calls carry dialed number information in the 'To' header of SIP Invites",
"example": true,
"type": "boolean"
},
"encrypted_media": {
"description": "Encrypted media",
"example": true,
"type": "boolean"
},
"host": {
"description": "Host of siptrunk",
"example": "dynamic",
"type": "string"
},
"id": {
"description": "Unique identifier of the SIP trunk on the platform",
"example": 293,
"format": "int32",
"type": "integer"
},
"ip_restrict": {
"default": false,
"description": "Indicates whether IP restriction must be enabled on the SIP trunk",
"example": false,
"type": "boolean"
},
"label": {
"description": "User-defined name of the SIP trunk",
"example": "My trunk",
"type": "string"
},
"machine_detection_enabled": {
"default": false,
"description": "Indicates if automatic voicemail detection is enabled on the SIP trunk. Available for `Flex Pro` customers only.",
"example": true,
"type": "boolean"
},
"max_call_cost": {
"description": "A maximum cost of an outbound call, in USD.",
"example": "0.18",
"type": [
"string",
"null"
]
},
"max_channels": {
"description": "A maximum number of concurrent outbound calls placed via the SIP trunk. Cannot be higher than the outbound channel capacity configured on the account.",
"example": 2,
"format": "int32",
"type": [
"integer",
"null"
]
},
"multiple_numbers": {
"description": "Multiple numbers",
"example": true,
"type": "boolean"
},
"name": {
"description": "System-generated login name of the SIP trunk",
"example": "67758",
"type": "string"
},
"passthrough": {
"description": "Indicates whether Caller ID passthrough is enabled.",
"example": true,
"type": "boolean"
},
"rewrite_cond": {
"description": "Leading digits to be deleted from the dialed phone numbers.",
"type": "string"
},
"rewrite_enabled": {
"default": false,
"description": "Indicates if a custom dial plan is activated for the SIP trunk.",
"example": true,
"type": "boolean"
},
"rewrite_prefix": {
"description": "Leading digits to be added before the dialed phone numbers.",
"example": "1",
"type": "string"
},
"transcription_enabled": {
"default": false,
"description": "Indicates if automatic call transcription is enabled on the SIP trunk. Available for `Flex Pro` customers only.",
"example": false,
"type": "boolean"
},
"transcription_threshold": {
"default": 6,
"description": "Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds",
"example": 10,
"format": "int32",
"type": "integer"
}
},
"required": [
"id",
"name",
"callerid",
"label",
"allowed_ips",
"created_at"
],
"title": "SipTrunkResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a message.",
"inputSchema": {
"properties": {
"id": {
"description": "Message ID.",
"example": "3a525ca2-6909-4c72-9399-905adf7f3a74",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "sms_and_mms_messages_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"carrier_fees": {
"description": "Mobile carrier fees in USD.",
"example": "0.0",
"type": [
"string",
"null"
]
},
"charge": {
"description": "Total charge for the message in USD.",
"example": "0.01",
"type": "string"
},
"delivered_at": {
"description": "Date and time the message was delivered in ISO 8601 format. Refers to DLR reception for mobile-terminated messages\n or webhook relay for mobile-originated messages.",
"example": "2022-04-14T13:51:16.096Z",
"type": [
"string",
"null"
]
},
"direction": {
"description": "Message direction. Possible values are `outbound`, `inbound`.",
"example": "outbound",
"type": "string"
},
"error_message": {
"description": "Human-readable error message.",
"type": [
"string",
"null"
]
},
"from": {
"description": "Sender ID.",
"example": "Wavix",
"type": "string"
},
"mcc": {
"description": "Mobile country code.",
"example": "301",
"type": [
"string",
"null"
]
},
"message_body": {
"additionalProperties": false,
"properties": {
"media": {
"description": "List of media URLs.\n If provided, the message is sent as an MMS;\n otherwise, it is sent as an SMS.",
"example": [
"https://you-site.com/media"
],
"items": {
"type": "string"
},
"maxItems": 5,
"minItems": 0,
"type": [
"array",
"null"
]
},
"text": {
"description": "Message text.",
"example": "Hi there, this is a sample message",
"type": "string"
}
},
"required": [
"text",
"media"
],
"title": "MessageBody",
"type": "object"
},
"message_id": {
"description": "Message ID.",
"example": "871b4eeb-f798-4105-be23-32df9e991456",
"type": "string"
},
"message_type": {
"description": "Message type. Possible values are `sms`, `mms`.",
"example": "sms",
"type": "string"
},
"mnc": {
"description": "Mobile network code.",
"example": "204",
"type": [
"string",
"null"
]
},
"segments": {
"description": "Number of SMS segments. Always 1 for MMS.",
"example": 1,
"format": "int32",
"type": "integer"
},
"sent_at": {
"description": "Date and time the message was sent in ISO 8601 format. For mobile-terminated messages only.",
"example": "2022-04-14T13:51:16.096Z",
"type": [
"string",
"null"
]
},
"status": {
"description": "Message delivery status.",
"enum": [
"accepted",
"pending",
"sent",
"delivered",
"undelivered",
"expired",
"rejected",
"dlr_expired"
],
"title": "MessageDeliveryStatus",
"type": "string"
},
"submitted_at": {
"description": "Date and time the message was accepted in ISO 8601 format.",
"example": "2022-04-14T13:51:16.096Z",
"type": "string"
},
"tag": {
"description": "Tag to group messages, such as for a specific campaign.",
"example": "Fall sale",
"type": [
"string",
"null"
]
},
"to": {
"description": "Recipient phone number.",
"example": "447537151866",
"type": "string"
}
},
"required": [
"message_id",
"message_type",
"from",
"to",
"direction",
"mcc",
"mnc",
"message_body",
"tag",
"status",
"segments",
"charge",
"submitted_at",
"sent_at",
"delivered_at",
"error_message"
],
"title": "MessageResponse",
"type": "object"
},
{
"example": {
"carrier_fees": "0.0",
"charge": "0.01",
"delivered_at": "2022-04-14T13:51:16.096Z",
"direction": "outbound",
"error_message": null,
"from": "15072429497",
"mcc": "310",
"message_body": {
"media": null,
"text": "Hello, this is a test message"
},
"message_id": "3a525ca2-6909-4c72-9399-905adf7f3a74",
"message_type": "sms",
"mnc": "024",
"segments": 1,
"sent_at": "2022-04-14T13:51:16.096Z",
"status": "delivered",
"submitted_at": "2022-04-14T13:51:16.096Z",
"tag": "Fall sale",
"to": "16419252149"
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a paginated list of SMS and MMS messages.",
"inputSchema": {
"properties": {
"from": {
"description": "Message sender. For `outbound` messages,\n the Sender ID used to send the message;\n for `inbound` messages, the originating phone number.",
"example": "15072429497",
"type": "string"
},
"message_type": {
"description": "Message type for filtering. Allowed values are `sms`, `mms`.",
"enum": [
"sms",
"mms"
],
"example": "sms",
"type": "string"
},
"page": {
"description": "Page number to retrieve.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 50,
"format": "int32",
"type": "integer"
},
"sent_after": {
"description": "Start date in `YYYY-MM-DD` format.",
"example": "2023-04-10",
"type": "string"
},
"sent_before": {
"description": "End date in `YYYY-MM-DD` format.",
"example": "2023-04-13",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Message delivery status.",
"enum": [
"accepted",
"pending",
"sent",
"delivered",
"undelivered",
"expired",
"rejected",
"dlr_expired"
],
"title": "MessageDeliveryStatus",
"type": "string"
}
],
"description": "Message delivery status for filtering."
},
"tag": {
"description": "Tag for filtering. Supported for outbound messages only.",
"example": "campaignX",
"type": "string"
},
"to": {
"description": "Recipient phone number. For `outbound` messages,\n the destination phone number;\n for `inbound` messages, an SMS-enabled number on the Wavix platform.",
"example": "16419252149",
"type": "string"
},
"type": {
"description": "Message direction for filtering. Allowed values are `inbound`, `outbound`.",
"example": "outbound",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"name": "sms_and_mms_messages_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"items": {
"items": {
"additionalProperties": false,
"description": "SMS or MMS message.",
"example": {
"charge": "0.01",
"delivered_at": "2022-04-14T13:51:16.096Z",
"direction": "outbound",
"error_message": "",
"from": "Wavix",
"mcc": "301",
"message_body": {
"media": null,
"text": "Hi there, this a message from Wavix"
},
"message_id": "871b4eeb-f798-4105-be23-32df9e991456",
"message_type": "sms",
"mnc": "204",
"segments": 1,
"sent_at": "2022-04-14T13:51:16.096Z",
"status": "delivered",
"submitted_at": "2022-04-14T13:51:16.096Z",
"tag": "Fall sale",
"to": "447537151866"
},
"properties": {
"carrier_fees": {
"description": "Carrier fees for the message in USD.",
"example": "0.0",
"format": "float",
"type": "string"
},
"charge": {
"description": "Total charge for the message in USD.",
"example": "0.01",
"type": "string"
},
"delivered_at": {
"description": "Date and time the message was delivered in ISO 8601 format. Refers to DLR reception for mobile-terminated messages\n or webhook relay for mobile-originated messages.",
"example": "2022-04-14T13:51:16.096Z",
"type": [
"string",
"null"
]
},
"direction": {
"description": "Message direction. Possible values are `outbound` or `inbound`.",
"example": "outbound",
"type": "string"
},
"error_message": {
"description": "A human-readable error description.",
"type": [
"string",
"null"
]
},
"from": {
"description": "Sender ID. Can be numeric or alphanumeric.",
"example": "Wavix",
"type": "string"
},
"mcc": {
"description": "Mobile country code.",
"example": "301",
"type": [
"string",
"null"
]
},
"message_body": {
"additionalProperties": false,
"properties": {
"media": {
"description": "List of media URLs.\n If provided, the message is sent as an MMS;\n otherwise, it is sent as an SMS.",
"example": [
"https://you-site.com/media"
],
"items": {
"type": "string"
},
"maxItems": 5,
"minItems": 0,
"type": [
"array",
"null"
]
},
"text": {
"description": "Message text.",
"example": "Hi there, this is a sample message",
"type": "string"
}
},
"required": [
"text",
"media"
],
"title": "MessageBody",
"type": "object"
},
"message_id": {
"description": "Message ID.",
"example": "871b4eeb-f798-4105-be23-32df9e991456",
"type": "string"
},
"message_type": {
"description": "Message type. Possible values are `sms` or `mms`",
"example": "sms",
"type": "string"
},
"mnc": {
"description": "Mobile network code.",
"example": "204",
"type": [
"string",
"null"
]
},
"segments": {
"description": "Number of SMS segments. Always 1 for MMS.",
"example": 1,
"format": "int32",
"type": "integer"
},
"sent_at": {
"description": "Date and time the message was sent in ISO 8601 format. For mobile terminated messages only.",
"example": "2022-04-14T13:51:16.096Z",
"type": [
"string",
"null"
]
},
"status": {
"description": "Message delivery status.",
"enum": [
"accepted",
"pending",
"sent",
"delivered",
"undelivered",
"expired",
"rejected",
"dlr_expired"
],
"title": "MessageDeliveryStatus",
"type": "string"
},
"submitted_at": {
"description": "Date and time the message was accepted in ISO 8601 format.",
"example": "2022-04-14T13:51:16.096Z",
"type": "string"
},
"tag": {
"description": "Tag to group messages, such as for a specific campaign.",
"example": "Fall sale",
"type": [
"string",
"null"
]
},
"to": {
"description": "Recipient phone number.",
"example": "447537151866",
"type": "string"
}
},
"required": [
"message_id",
"message_type",
"from",
"to",
"direction",
"mcc",
"mnc",
"message_body",
"tag",
"status",
"segments",
"charge",
"submitted_at",
"sent_at",
"delivered_at",
"error_message"
],
"title": "Message",
"type": "object"
},
"type": "array"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
}
},
"required": [
"items",
"pagination"
],
"title": "MessageListResponse",
"type": "object"
},
{
"example": {
"items": [
{
"carrier_fees": "0.0",
"charge": "0.0475",
"delivered_at": "2023-08-29T12:32:45.000Z",
"direction": "outbound",
"error_message": null,
"from": "Sender ID.",
"mcc": "234",
"message_body": {
"media": null,
"text": "Please call me back"
},
"message_id": "3a525ca2-6909-4c72-9399-905adf7f3a74",
"message_type": "sms",
"mnc": "024",
"segments": 1,
"sent_at": "2023-08-29T12:32:44.000Z",
"status": "delivered",
"submitted_at": "2023-08-29T12:32:44.000Z",
"tag": null,
"to": "447537151866"
}
],
"pagination": {
"current_page": 1,
"per_page": 10,
"total": 1,
"total_pages": 1
}
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns SMS and MMS messages in newline-delimited JSON (NDJSON) format.",
"inputSchema": {
"properties": {
"from": {
"description": "Message sender. For `outbound` messages, the Sender ID used to send\n the message;\n for `inbound` messages, the originating phone number.",
"example": "15072429497",
"type": "string"
},
"message_type": {
"description": "Message type for filtering. Allowed values are `sms`, `mms`.",
"enum": [
"sms",
"mms"
],
"example": "sms",
"type": "string"
},
"sent_after": {
"description": "Start date in `YYYY-MM-DDTHH:MM:SS` format.",
"example": "2023-04-10T00:00:00",
"type": "string"
},
"sent_before": {
"description": "End date in `YYYY-MM-DDTHH:MM:SS` format.",
"example": "2023-04-13T23:59:59",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Message delivery status.",
"enum": [
"accepted",
"pending",
"sent",
"delivered",
"undelivered",
"expired",
"rejected",
"dlr_expired"
],
"title": "MessageDeliveryStatus",
"type": "string"
}
],
"description": "Message delivery status for filtering."
},
"tag": {
"description": "Tag for filtering. Supported for outbound messages only.",
"example": "campaignX",
"type": "string"
},
"to": {
"description": "Message recipient. For `outbound` messages,\n the destination phone number;\n for `inbound` messages,\n the SMS-enabled number that received the message.",
"example": "16419252149",
"type": "string"
},
"type": {
"description": "Message direction for filtering.\n Allowed values are `inbound`, `outbound`.",
"example": "outbound",
"type": "string"
}
},
"required": [
"type"
],
"type": "object"
},
"name": "sms_and_mms_messages_list_all",
"outputSchema": null
},
{
"description": "Sends SMS or MMS messages. MMS is supported for U.S. numbers only.\n**Rate limit**: 20 messages per phone number in 24 hours.",
"inputSchema": {
"properties": {
"callback_url": {
"description": "Callback URL for delivery reports.",
"example": "https://you-site.com/webhook",
"type": "string"
},
"from": {
"description": "Sender ID. Numeric or alphanumeric.",
"example": "Wavix",
"type": "string"
},
"message_body": {
"additionalProperties": false,
"properties": {
"media": {
"description": "List of media URLs.\n If provided, the message is sent as an MMS;\n otherwise, it is sent as an SMS.",
"example": [
"https://you-site.com/media"
],
"items": {
"type": "string"
},
"maxItems": 5,
"minItems": 0,
"type": [
"array",
"null"
]
},
"text": {
"description": "Message text.",
"example": "Hi there, this is a sample message",
"type": "string"
}
},
"required": [
"text",
"media"
],
"title": "MessageBody",
"type": "object"
},
"tag": {
"description": "Tag to group messages, such as for a specific campaign.",
"example": "Fall sale",
"type": "string"
},
"to": {
"description": "Recipient phone number.",
"example": "447537151866",
"type": "string"
},
"validity": {
"description": "Message validity period in seconds. Delivery attempts stop after this period expires.",
"example": 3600,
"format": "int32",
"type": "integer"
}
},
"required": [
"from",
"to",
"message_body"
],
"type": "object"
},
"name": "sms_and_mms_messages_send",
"outputSchema": {
"additionalProperties": false,
"properties": {
"carrier_fees": {
"description": "Mobile carrier fees in USD.",
"example": "0.0",
"type": [
"string",
"null"
]
},
"charge": {
"description": "Total charge for the message in USD.",
"example": "0.0",
"type": "string"
},
"delivered_at": {
"description": "Date and time the message was delivered in ISO 8601 format.",
"example": "2024-05-28T12:34:56Z",
"format": "date-time",
"type": [
"string",
"null"
]
},
"direction": {
"description": "Message direction. Possible values are `outbound`, `inbound`.",
"example": "outbound",
"type": "string"
},
"error_message": {
"description": "Error message.",
"type": [
"string",
"null"
]
},
"from": {
"description": "Sender ID.",
"example": "Sender ID.",
"type": "string"
},
"mcc": {
"description": "Mobile country code.",
"example": "310",
"type": [
"string",
"null"
]
},
"message_body": {
"additionalProperties": false,
"properties": {
"media": {
"description": "List of media URLs.",
"items": {
"example": "https://api.examples.com/v3/messages/file1",
"format": "uri",
"type": "string"
},
"type": "array"
},
"text": {
"description": "Message text.",
"example": "Hi there, this is a message from Wavix",
"type": "string"
}
},
"type": "object"
},
"message_id": {
"description": "Message ID.",
"example": "abc123de-4567-890f-gh12-ijklmnop3456",
"type": "string"
},
"message_type": {
"description": "Message type.",
"example": "mms",
"type": "string"
},
"mnc": {
"description": "Mobile network code.",
"example": "260",
"type": [
"string",
"null"
]
},
"segments": {
"description": "Number of SMS segments. Always 1 for MMS.",
"example": 1,
"type": "integer"
},
"sent_at": {
"description": "Date and time the message was sent in ISO 8601 format.",
"example": "2024-05-28T12:34:54Z",
"format": "date-time",
"type": [
"string",
"null"
]
},
"status": {
"description": "Message status.",
"example": "accepted",
"type": "string"
},
"submitted_at": {
"description": "Date and time the message was submitted in ISO 8601 format.",
"example": "2025-09-22T09:07:53Z",
"type": "string"
},
"tag": {
"description": "Message tag.",
"example": "campaign_test",
"type": [
"string",
"null"
]
},
"to": {
"description": "Recipient phone number.",
"example": "+15551234567",
"type": "string"
}
},
"type": "object"
}
},
{
"description": "Creates an opt-out for a Sender ID, 10DLC campaign,\n or all outbound messages.",
"inputSchema": {
"properties": {
"opt_out": {
"additionalProperties": false,
"example": {
"number": "16419252149",
"sender_id": "15072429497"
},
"properties": {
"number": {
"description": "Phone number to opt out.",
"example": "16419252149",
"type": "string"
},
"sender_id": {
"description": "Sender ID. If omitted, the phone number is opted out of all messages.",
"example": "15072429497",
"type": "string"
}
},
"required": [
"number"
],
"title": "OptOut",
"type": "object"
}
},
"required": [
"opt_out"
],
"type": "object"
},
"name": "sms_and_mms_opt_outs_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a paginated list of opted-out phone numbers. Results are limited to 25 records per page by default. Use `page` and `per_page` to navigate results.",
"inputSchema": {
"properties": {
"campaign_id": {
"description": "10DLC campaign for filtering.",
"type": "string"
},
"created_after": {
"description": "Start date in `YYYY-MM-DD` format.",
"format": "date",
"type": "string"
},
"created_before": {
"description": "End date in `YYYY-MM-DD` format.",
"format": "date",
"type": "string"
},
"page": {
"description": "Page number to retrieve.",
"minimum": 1,
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"sender_id": {
"description": "Sender ID for filtering.",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "sms_and_mms_opt_outs_list",
"outputSchema": {
"properties": {
"items": {
"items": {
"properties": {
"campaign_id": {
"description": "10DLC campaign ID, if any.",
"example": "C123456",
"type": [
"string",
"null"
]
},
"created_at": {
"description": "Opt-out date and time in ISO 8601 format.",
"example": "2024-01-15T10:30:00Z",
"format": "date-time",
"type": "string"
},
"phone_number": {
"description": "Opted-out phone number.",
"example": "15551234567",
"type": "string"
},
"sender_id": {
"description": "Sender ID. Contains `null` if the phone number opted out of all messages.",
"example": "MySender",
"type": [
"string",
"null"
]
}
},
"title": "OptOutItem",
"type": "object"
},
"type": "array"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
}
},
"title": "OptOutsListResponse",
"type": "object"
}
},
{
"description": "Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US.",
"inputSchema": {
"properties": {
"countries": {
"description": "Two-letter ISO country codes where the Sender ID is allowlisted.",
"items": {
"type": "string"
},
"type": "array"
},
"monthly_volume": {
"description": "Expected monthly volume.",
"enum": [
"1-1000",
"1001-20000",
"20001-50000",
"50001-100000",
"More than 100000"
],
"example": "1001-20000",
"type": "string"
},
"samples": {
"description": "Message samples.",
"example": [
"Sample message 1",
"Sample message 2"
],
"items": {
"type": "string"
},
"type": "array"
},
"sender_id": {
"description": "Sender ID name. Can be either an alphanumeric string or a phone number.",
"example": "Wavix",
"type": "string"
},
"type": {
"description": "Sender ID type.",
"enum": [
"numeric",
"alphanumeric"
],
"title": "SenderIdType",
"type": "string"
},
"usecase": {
"description": "Use case for the Sender ID",
"enum": [
"transactional",
"promo",
"authentication"
],
"example": "transactional",
"type": "string"
}
},
"required": [
"sender_id",
"type",
"countries",
"usecase"
],
"type": "object"
},
"name": "sms_and_mms_sender_ids_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"allowlisted_in": {
"description": "List of countries where the Sender ID is allowlisted.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Sender ID ID.",
"example": "3c7a5a90-43e0-43e0-b006-fdfea30c5a7c",
"type": "string"
},
"samples": {
"description": "Message samples.",
"example": [
"Sample message 1",
"Sample message 2"
],
"items": {
"type": "string"
},
"type": "array"
},
"sender_id": {
"description": "Sender ID name.",
"example": "Wavix",
"type": "string"
},
"type": {
"description": "Sender ID type.",
"enum": [
"numeric",
"alphanumeric"
],
"title": "SenderIdType",
"type": "string"
},
"usecase": {
"example": "promo",
"type": "string"
}
},
"required": [
"id",
"sender_id",
"type",
"allowlisted_in"
],
"title": "SenderIDDetails",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Deletes a Sender ID.",
"inputSchema": {
"properties": {
"id": {
"description": "Sender ID ID.",
"example": "fc34ba88-1eee-476e-b09e-dae63dc441e0",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "sms_and_mms_sender_ids_delete",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a Sender ID.",
"inputSchema": {
"properties": {
"id": {
"description": "Sender ID ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "sms_and_mms_sender_ids_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"allowlisted_in": {
"description": "List of countries where the Sender ID is allowlisted.",
"items": {
"example": "GB",
"type": "string"
},
"type": "array"
},
"id": {
"description": "Sender ID ID.",
"example": "3c7a5a90-43e0-43e0-b006-fdfea30c5a7c",
"format": "uuid",
"type": "string"
},
"samples": {
"description": "Message samples.",
"items": {
"example": "Sample",
"type": "string"
},
"type": "array"
},
"sender_id": {
"description": "Sender ID.",
"example": "Wavix",
"type": "string"
},
"type": {
"description": "Sender ID type.",
"enum": [
"alphanumeric",
"numeric",
"shortcode"
],
"example": "alphanumeric",
"type": "string"
},
"usecase": {
"description": "Use case for the Sender ID.",
"example": "promo",
"type": "string"
}
},
"required": [
"id",
"sender_id",
"type"
],
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of Sender IDs.",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "sms_and_mms_sender_ids_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"items": {
"description": "List of Sender IDs.",
"items": {
"additionalProperties": false,
"description": "SMS Sender ID.",
"properties": {
"allowlisted_in": {
"description": "Two-letter ISO country codes where the Sender ID is allowlisted.",
"items": {
"type": "string"
},
"type": "array"
},
"id": {
"description": "Sender ID ID.",
"example": "3c7a5a90-43e0-43e0-b006-fdfea30c5a7c",
"type": "string"
},
"samples": {
"description": "Message samples.",
"items": {
"example": "sample",
"type": "string"
},
"type": "array"
},
"sender_id": {
"description": "Sender ID name.",
"example": "Wavix",
"type": "string"
},
"type": {
"description": "Sender ID type.",
"enum": [
"numeric",
"alphanumeric"
],
"title": "SenderIdType",
"type": "string"
},
"usecase": {
"example": "promo",
"type": "string"
}
},
"required": [
"id",
"sender_id",
"type",
"allowlisted_in"
],
"title": "SenderID",
"type": "object"
},
"type": "array"
}
},
"required": [
"items"
],
"title": "SenderIdListResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Uploads an audio file for transcription. Wavix sends a POST callback to the specified callback URL when the transcription is complete.\n\nCallback body:\n```json\n {\n \"request_id\": \"e865ea07-25af-4fdd-876e-04b0d41d5ebd\",\n \"status\": \"completed\",\n \"error\": null\n }\n```\n\n- `request_id`: Transcription request ID.\n- `status`: Operation status. Possible values are `completed`, `failed`. `completed` indicates successful transcription; `failed` indicates an error. - `error`: Error description. Value is `null` if the transcription was successful.",
"inputSchema": {
"properties": {
"callback_url": {
"description": "Callback URL for transcription status updates.",
"example": "https://you-site.com/webhook",
"type": "string"
},
"file": {
"description": "Binary file content. Maximum size is 25 MB. Wavix supports WAV, MP3, and MP4 stereo formats.",
"format": "binary",
"type": "string"
},
"insights": {
"description": "Indicates whether to enable insights generation.",
"example": true,
"type": "boolean"
}
},
"required": [],
"type": "object"
},
"name": "speech_analytics_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"example": {
"file": "file.mp3",
"request_id": "e865ea07-25af-4fdd-876e-04b0d41d5ebd",
"success": true
},
"properties": {
"file": {
"description": "Uploaded file name.",
"example": "file.mp3",
"type": "string"
},
"request_id": {
"description": "Transcription request ID.",
"example": "e865ea07-25af-4fdd-876e-04b0d41d5ebd",
"type": "string"
},
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"required": [
"file",
"request_id",
"success"
],
"title": "SubmitFileTranscriptionResponse",
"type": "object"
},
{
"example": {
"file": "file.mp3",
"request_id": "e865ea07-25af-4fdd-876e-04b0d41d5ebd",
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Get a download URL for a speech-analytics audio file.\n\nReturns ``{download_url, content_type, status_code, note}`` instead of the\nbinary audio stream (WAV/MP3/MP4). Fetch ``download_url`` to obtain the file.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"uuid": {
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "speech_analytics_file_get",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Returns a transcription.",
"inputSchema": {
"properties": {
"uuid": {
"description": "Transcription request ID.",
"example": "e865ea07-25af-4fdd-876e-04b0d41d5ebd",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "speech_analytics_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"charge": {
"description": "Total transcription charge in USD.",
"example": "0.01",
"type": "string"
},
"duration": {
"description": "File duration in seconds.",
"example": 102,
"format": "int32",
"type": [
"integer",
"null"
]
},
"language": {
"allOf": [
{
"description": "Language.",
"enum": [
"en",
"de",
"es",
"fr",
"it",
null
],
"title": "TranscriptionLanguage",
"type": [
"string",
"null"
]
},
{
"description": "Transcription language.",
"example": "en"
}
]
},
"original_file": {
"description": "Uploaded file URL.",
"example": "https://api.wavix.com/v1/files/uuid",
"type": "string"
},
"request_id": {
"description": "Transcription request ID.",
"example": "e84f350f-6da7-4b56-80eb-41dec572626b",
"type": "string"
},
"status": {
"allOf": [
{
"description": "Transcription status.",
"enum": [
"completed",
"failed"
],
"title": "TranscriptionStatus",
"type": "string"
},
{
"description": "Transcription status. Possible values are `completed`, `failed`.",
"example": "completed"
}
]
},
"transcript": {
"anyOf": [
{
"additionalProperties": false,
"properties": {
"channel_1": {
"description": "Transcription of speaker one.",
"example": "Hi there",
"type": "string"
},
"channel_2": {
"description": "Transcription of speaker two.",
"example": "Hello",
"type": "string"
}
},
"required": [
"channel_1",
"channel_2"
],
"title": "FileTranscriptResponse",
"type": "object"
},
{
"type": "null"
}
],
"description": "Complete transcription text attributed to each channel."
},
"transcription_date": {
"description": "Date and time of the transcription in ISO 8601 format.",
"example": "2023-01-09T10:04:39.734Z",
"format": "date-time",
"type": "string"
},
"transcription_score": {
"description": "Conversation sentiment score. Scores from 1.0 to 3.0 are negative; scores from 4.0 to 5.0 are positive.",
"example": "3.8",
"type": [
"string",
"null"
]
},
"transcription_summary": {
"description": "Transcription summary.",
"example": "The agent and client discussed call recording and call transcription",
"type": [
"string",
"null"
]
},
"turns": {
"description": "List of transcription turns, including speaker attribution, timestamps, and sentiment.",
"example": [
{
"e": 700,
"s": 600,
"sentiment": "positive",
"speaker": "channel_1",
"text": "Hi"
}
],
"items": {
"additionalProperties": false,
"description": "Transcription `turn` details, including speaker, timestamps, text, and sentiment.",
"example": {
"e": 700,
"s": 600,
"sentiment": "positive",
"speaker": "channel_1",
"text": "Hi there"
},
"properties": {
"e": {
"description": "Turn end time in milliseconds from the beginning of the file.",
"example": 18000,
"format": "int32",
"type": "integer"
},
"s": {
"description": "Turn start time in milliseconds from the beginning of the file.",
"example": 3000,
"format": "int32",
"type": "integer"
},
"sentiment": {
"description": "Sentiment associated with the turn. Possible values are `positive`, `neutral`, `negative`.",
"example": "positive",
"type": "string"
},
"speaker": {
"description": "Speaker identifier.",
"example": "channel_1",
"type": "string"
},
"text": {
"description": "Transcription text attributed to the speaker.",
"example": "Hi there, how are you?",
"type": "string"
}
},
"required": [
"speaker",
"s",
"e",
"text",
"sentiment"
],
"title": "FileTranscriptTurn",
"type": "object"
},
"type": [
"array",
"null"
]
}
},
"required": [
"transcript",
"turns",
"request_id",
"language",
"duration",
"charge",
"status",
"transcription_date",
"transcription_score",
"transcription_summary",
"original_file"
],
"title": "FileTranscriptionResponse",
"type": "object"
},
{
"example": {
"charge": "0.01",
"duration": 102,
"language": "en",
"original_file": "https://api.wavix.com/v1/files/uuid",
"request_id": "e84f350f-6da7-4b56-80eb-41dec572626b",
"status": "completed",
"transcript": {
"channel_1": "Hi there",
"channel_2": "Hello"
},
"transcription_date": "2023-01-09T10:04:39.734Z",
"transcription_score": "3.8",
"transcription_summary": "The agent and client discussed call recording and call transcription",
"turns": [
{
"e": 700,
"s": 600,
"sentiment": "positive",
"speaker": "channel_1",
"text": "Hi"
}
]
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Retranscribes an uploaded file.",
"inputSchema": {
"properties": {
"callback_url": {
"description": "Callback URL for transcription status updates.",
"example": "https://you-site.com/webhook",
"type": "string"
},
"insights": {
"description": "Indicates whether to enable insights generation.",
"example": true,
"type": "boolean"
},
"uuid": {
"description": "Transcription request ID.",
"example": "e865ea07-25af-4fdd-876e-04b0d41d5ebd",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "speech_analytics_retranscribe",
"outputSchema": {
"properties": {
"success": {
"description": "Indicates whether the request was successful.",
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Creates a sub-account.",
"inputSchema": {
"properties": {
"default_destinations": {
"additionalProperties": false,
"description": "Default webhook URLs for inbound messages and delivery reports.",
"properties": {
"dlr_endpoint": {
"description": "Delivery report webhook URL.",
"example": "https://examples.com/dlr",
"format": "uri",
"type": "string"
},
"sms_endpoint": {
"description": "Inbound messages webhook URL.",
"example": "https://examples.com/sms",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"name": {
"description": "Sub-account name.",
"example": "Company name",
"maxLength": 255,
"type": "string"
}
},
"required": [
"name"
],
"type": "object"
},
"name": "sub_accounts_create",
"outputSchema": {
"additionalProperties": false,
"description": "Sub-account details including API key and webhook configurations.",
"example": {
"api_key": "abc123def456",
"created_at": "2023-06-15T10:30:00Z",
"default_destinations": {
"dlr_endpoint": "https://examples.com/dlr",
"sms_endpoint": "https://examples.com/sms"
},
"id": 123,
"master_organization": 456,
"name": "My sub-account",
"status": "enabled"
},
"properties": {
"api_key": {
"description": "Sub-account API key.",
"example": "abc123def456",
"type": "string"
},
"created_at": {
"description": "Date and time the sub-account was created in ISO 8601 format.",
"example": "2023-06-15T10:30:00Z",
"format": "date-time",
"type": "string"
},
"default_destinations": {
"additionalProperties": false,
"description": "Default webhook URLs for inbound messages and delivery reports.",
"properties": {
"dlr_endpoint": {
"description": "Delivery report webhook URL.",
"example": "https://examples.com/dlr",
"format": "uri",
"type": "string"
},
"sms_endpoint": {
"description": "Inbound messages webhook URL.",
"example": "https://examples.com/sms",
"format": "uri",
"type": "string"
}
},
"required": [
"sms_endpoint",
"dlr_endpoint"
],
"type": "object"
},
"id": {
"description": "Sub-account ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"master_organization": {
"description": "Master account ID.",
"example": 456,
"format": "int32",
"type": "integer"
},
"name": {
"description": "Sub-account name.",
"example": "My sub-account",
"type": "string"
},
"status": {
"description": "Sub-account status.",
"enum": [
"enabled",
"disabled"
],
"example": "enabled",
"type": "string"
}
},
"required": [
"id",
"created_at",
"name",
"api_key",
"master_organization",
"status",
"default_destinations"
],
"title": "SubOrganizationResponse",
"type": "object"
}
},
{
"description": "Returns a specific sub-account. Results are limited to 25 records per page by default. Use `page` and `per_page` to navigate results.",
"inputSchema": {
"properties": {
"id": {
"description": "Sub-account ID.",
"example": 123,
"format": "int32",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "sub_accounts_get",
"outputSchema": {
"additionalProperties": false,
"description": "Sub-account details including API key and webhook configurations.",
"example": {
"api_key": "abc123def456",
"created_at": "2023-06-15T10:30:00Z",
"default_destinations": {
"dlr_endpoint": "https://examples.com/dlr",
"sms_endpoint": "https://examples.com/sms"
},
"id": 123,
"master_organization": 456,
"name": "My sub-account",
"status": "enabled"
},
"properties": {
"api_key": {
"description": "Sub-account API key.",
"example": "abc123def456",
"type": "string"
},
"created_at": {
"description": "Date and time the sub-account was created in ISO 8601 format.",
"example": "2023-06-15T10:30:00Z",
"format": "date-time",
"type": "string"
},
"default_destinations": {
"additionalProperties": false,
"description": "Default webhook URLs for inbound messages and delivery reports.",
"properties": {
"dlr_endpoint": {
"description": "Delivery report webhook URL.",
"example": "https://examples.com/dlr",
"format": "uri",
"type": "string"
},
"sms_endpoint": {
"description": "Inbound messages webhook URL.",
"example": "https://examples.com/sms",
"format": "uri",
"type": "string"
}
},
"required": [
"sms_endpoint",
"dlr_endpoint"
],
"type": "object"
},
"id": {
"description": "Sub-account ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"master_organization": {
"description": "Master account ID.",
"example": 456,
"format": "int32",
"type": "integer"
},
"name": {
"description": "Sub-account name.",
"example": "My sub-account",
"type": "string"
},
"status": {
"description": "Sub-account status.",
"enum": [
"enabled",
"disabled"
],
"example": "enabled",
"type": "string"
}
},
"required": [
"id",
"created_at",
"name",
"api_key",
"master_organization",
"status",
"default_destinations"
],
"title": "SubOrganizationResponse",
"type": "object"
}
},
{
"description": "Returns a paginated list of sub-accounts. Results are limited to 25 records per page by default. Use `page` and `per_page` to navigate results.",
"inputSchema": {
"properties": {
"status": {
"description": "Account status to filter results.",
"enum": [
"enabled",
"disabled"
],
"example": "enabled",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "sub_accounts_list",
"outputSchema": {
"additionalProperties": false,
"properties": {
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
},
"sub_organizations": {
"items": {
"additionalProperties": false,
"description": "Sub-account details including API key and webhook configurations.",
"example": {
"api_key": "abc123def456",
"created_at": "2023-06-15T10:30:00Z",
"default_destinations": {
"dlr_endpoint": "https://examples.com/dlr",
"sms_endpoint": "https://examples.com/sms"
},
"id": 123,
"master_organization": 456,
"name": "My sub-account",
"status": "enabled"
},
"properties": {
"api_key": {
"description": "Sub-account API key.",
"example": "abc123def456",
"type": "string"
},
"created_at": {
"description": "Date and time the sub-account was created in ISO 8601 format.",
"example": "2023-06-15T10:30:00Z",
"format": "date-time",
"type": "string"
},
"default_destinations": {
"additionalProperties": false,
"description": "Default webhook URLs for inbound messages and delivery reports.",
"properties": {
"dlr_endpoint": {
"description": "Delivery report webhook URL.",
"example": "https://examples.com/dlr",
"format": "uri",
"type": "string"
},
"sms_endpoint": {
"description": "Inbound messages webhook URL.",
"example": "https://examples.com/sms",
"format": "uri",
"type": "string"
}
},
"required": [
"sms_endpoint",
"dlr_endpoint"
],
"type": "object"
},
"id": {
"description": "Sub-account ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"master_organization": {
"description": "Master account ID.",
"example": 456,
"format": "int32",
"type": "integer"
},
"name": {
"description": "Sub-account name.",
"example": "My sub-account",
"type": "string"
},
"status": {
"description": "Sub-account status.",
"enum": [
"enabled",
"disabled"
],
"example": "enabled",
"type": "string"
}
},
"required": [
"id",
"created_at",
"name",
"api_key",
"master_organization",
"status",
"default_destinations"
],
"title": "SubOrganizationResponse",
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Returns a paginated list of transactions for a specific sub-account. Filter by date range and type. Results are paginated with 25 records per page by default. Use `page` and `per_page` to navigate results.",
"inputSchema": {
"properties": {
"from_date": {
"description": "Start date in `YYYY-MM-DD` format.",
"example": "2023-01-01",
"format": "date",
"type": "string"
},
"id": {
"description": "Sub-account ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"page": {
"description": "Page number to retrieve.",
"example": 1,
"format": "int32",
"type": "integer"
},
"per_page": {
"default": 25,
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"to_date": {
"description": "End date in `YYYY-MM-DD` format.",
"example": "2023-12-31",
"format": "date",
"type": "string"
},
"type": {
"anyOf": [
{
"example": 1,
"format": "int32",
"type": "integer"
},
{
"example": [
1,
2,
3
],
"items": {
"format": "int32",
"type": "integer"
},
"type": "array"
}
],
"description": "Transaction types to filter results."
}
},
"required": [
"id",
"from_date",
"to_date"
],
"type": "object"
},
"name": "sub_accounts_transactions_list",
"outputSchema": {
"additionalProperties": false,
"properties": {
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 1,
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 1,
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"type": "integer"
}
},
"type": "object"
},
"transactions": {
"items": {
"additionalProperties": false,
"properties": {
"amount": {
"description": "Transaction amount.",
"example": 10.5,
"format": "float",
"type": "number"
},
"balance_after": {
"description": "Sub-account balance after the transaction.",
"example": 100,
"format": "float",
"type": "number"
},
"date": {
"description": "Transaction date and time in ISO 8601 format.",
"example": "2023-06-15T10:30:00Z",
"format": "date-time",
"type": "string"
},
"details": {
"description": "Transaction details.",
"example": "Account top-up",
"type": "string"
},
"status": {
"description": "Transaction status.",
"example": "committed",
"type": "string"
},
"type": {
"description": "Transaction type.",
"example": 1,
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
}
},
{
"description": "Updates a sub-account's configuration.",
"inputSchema": {
"properties": {
"default_destinations": {
"additionalProperties": false,
"description": "Default webhook URLs for inbound messages and delivery reports.",
"properties": {
"dlr_endpoint": {
"description": "Delivery report webhook URL.",
"example": "https://examples.com/dlr",
"format": "uri",
"type": "string"
},
"sms_endpoint": {
"description": "Inbound messages webhook URL.",
"example": "https://examples.com/sms",
"format": "uri",
"type": "string"
}
},
"type": "object"
},
"id": {
"description": "Sub-account ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"name": {
"description": "Sub-account name.",
"example": "Updated Company Name",
"maxLength": 255,
"type": "string"
},
"status": {
"description": "Sub-account status.",
"enum": [
"enabled",
"disabled"
],
"example": "enabled",
"type": "string"
}
},
"required": [
"id",
"name"
],
"type": "object"
},
"name": "sub_accounts_update",
"outputSchema": {
"additionalProperties": false,
"description": "Sub-account details including API key and webhook configurations.",
"example": {
"api_key": "abc123def456",
"created_at": "2023-06-15T10:30:00Z",
"default_destinations": {
"dlr_endpoint": "https://examples.com/dlr",
"sms_endpoint": "https://examples.com/sms"
},
"id": 123,
"master_organization": 456,
"name": "My sub-account",
"status": "enabled"
},
"properties": {
"api_key": {
"description": "Sub-account API key.",
"example": "abc123def456",
"type": "string"
},
"created_at": {
"description": "Date and time the sub-account was created in ISO 8601 format.",
"example": "2023-06-15T10:30:00Z",
"format": "date-time",
"type": "string"
},
"default_destinations": {
"additionalProperties": false,
"description": "Default webhook URLs for inbound messages and delivery reports.",
"properties": {
"dlr_endpoint": {
"description": "Delivery report webhook URL.",
"example": "https://examples.com/dlr",
"format": "uri",
"type": "string"
},
"sms_endpoint": {
"description": "Inbound messages webhook URL.",
"example": "https://examples.com/sms",
"format": "uri",
"type": "string"
}
},
"required": [
"sms_endpoint",
"dlr_endpoint"
],
"type": "object"
},
"id": {
"description": "Sub-account ID.",
"example": 123,
"format": "int32",
"type": "integer"
},
"master_organization": {
"description": "Master account ID.",
"example": 456,
"format": "int32",
"type": "integer"
},
"name": {
"description": "Sub-account name.",
"example": "My sub-account",
"type": "string"
},
"status": {
"description": "Sub-account status.",
"enum": [
"enabled",
"disabled"
],
"example": "enabled",
"type": "string"
}
},
"required": [
"id",
"created_at",
"name",
"api_key",
"master_organization",
"status",
"default_destinations"
],
"title": "SubOrganizationResponse",
"type": "object"
}
},
{
"description": "Submits an appeal for 10DLC brand identity verification. Provide any additional documentation to support the appeal. Use `appeal_category` to specify the appeal type:\n- `VERIFY_TAX_ID` — Use if the brand is UNVERIFIED due to a tax ID mismatch. Applies to private companies, public companies, non-profits, and government entities.\n- `VERIFY_NON_PROFIT` — Use if a non-profit brand is UNVERIFIED or VERIFIED but missing tax-exempt status.\n- `VERIFY_GOVERNMENT` — Use if a government brand is UNVERIFIED or VERIFIED but missing government entity status. ",
"inputSchema": {
"properties": {
"appeal_categories": {
"description": "List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`",
"example": [
"VERIFY_TAX_ID"
],
"items": {
"type": "string"
},
"type": "array"
},
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"evidence": {
"description": "List of evidence IDs associated with the appeal.",
"example": [
"855dff49-c097-4645-3983-08dcb9856232"
],
"items": {
"type": "string"
},
"type": "array"
},
"explanation": {
"description": "Appeal comment or justification.",
"example": "Find the company incorporation docs attached and please review the Brand Identity status.",
"type": "string"
}
},
"required": [
"brand_id",
"appeal_categories",
"evidence"
],
"type": "object"
},
"name": "ten_dlc_brand_appeals_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of brand identity verification appeals.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "ten_dlc_brand_appeals_list",
"outputSchema": {
"properties": {
"result": {
"example": [
{
"categories": [
"VERIFY_TAX_ID"
],
"created_at": "2024-08-01T14:09:43Z",
"evidence": [],
"explanation": "Dear partner, please review the registration docs",
"outcome": {
"feedback": {
"category": []
},
"optional_attributes": {},
"vetting_status": "VERIFIED"
},
"status": "COMPLETE",
"updated_at": "2024-08-01T18:33:15Z"
}
],
"items": {
"additionalProperties": false,
"example": {
"categories": [
"VERIFY_TAX_ID"
],
"created_at": "2024-08-01T14:09:43Z",
"evidence": [],
"explanation": "Dear partner, please review the registration docs",
"outcome": {
"feedback": {
"category": []
},
"optional_attributes": {},
"vetting_status": "VERIFIED"
},
"status": "COMPLETE",
"updated_at": "2024-08-01T18:33:15Z"
},
"properties": {
"categories": {
"description": "A list of Brand Identity status appeal categories associated with the original request",
"example": [
"VERIFY_TAX_ID"
],
"items": {
"type": "string"
},
"type": "array"
},
"created_at": {
"description": "The date and time the appeal request is created",
"example": "2024-08-01T14:09:43Z",
"format": "date-time",
"type": "string"
},
"evidence": {
"description": "A list of evidence UUIDs to be associated with the appeal",
"example": [
"13d8e00c-3cb4-4dc0-9e26-d5057fa938d9"
],
"items": {
"type": "string"
},
"type": "array"
},
"explanation": {
"description": "The appeal justification",
"example": "Dear partner, please review the uploaded company registration docs.",
"type": "string"
},
"outcome": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"feedback": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"category": {
"description": "The feedback category",
"items": {
"additionalProperties": false,
"description": "TCR returns the feedback per submitted appeal category",
"properties": {
"description": {
"description": "The description of the category",
"example": "Select this category if the record is UNVERIFIED due to an inability to match the tax ID.",
"type": "string"
},
"display_name": {
"description": "The display name of the category",
"example": "Verify tax ID",
"type": "string"
},
"errors": {
"description": "An array of verification errors, if any",
"items": {
"additionalProperties": false,
"example": {
"code": "TFTI01",
"message": "The submitted US EIN is invalid."
},
"properties": {
"code": {
"description": "TCR error code",
"type": "string"
},
"message": {
"description": "A human-readable error description",
"type": "string"
}
},
"required": [
"code",
"message"
],
"title": "TcrErrorMessage",
"type": "object"
},
"type": [
"array",
"null"
]
},
"fields": {
"description": "An array of Brand attributes",
"type": [
"string",
"null"
]
},
"id": {
"description": "The submitted appeal category",
"example": "VERIFY_TAX_ID",
"type": "string"
}
},
"required": [
"id",
"display_name",
"description",
"fields",
"errors"
],
"title": "TcrFeedbackCategory",
"type": "object"
},
"type": "array"
}
},
"required": [
"category"
],
"title": "TcrFeedback",
"type": "object"
},
{
"description": "Brand Identity Verification appeal feedback, if any"
}
]
},
"optional_attributes": {
"additionalProperties": false,
"description": "An optional attributes that might be returned from TCR",
"type": "object"
},
"vetting_status": {
"allOf": [
{
"description": "10DLC Brand Identity verification status",
"enum": [
"REVIEW",
"VERIFIED",
"UNVERIFIED",
"VETTED_VERIFIED",
"SUSPENDED"
],
"title": "TenDlcBrandIdentityVerificationStatus",
"type": "string"
},
{
"description": "Brand Identity Verification appeal outcome",
"example": "UNVERIFIED"
}
]
}
},
"required": [
"optional_attributes",
"vetting_status",
"feedback"
],
"title": "TenDlcBrandAppealOutcome",
"type": "object"
},
{
"description": "The appeal outcome details"
}
]
},
"status": {
"description": "The appeal status",
"example": "COMPLETED",
"type": "string"
},
"updated_at": {
"description": "The date and time the appeal request is updated",
"example": "2024-08-01T14:09:43Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"categories",
"created_at",
"evidence",
"outcome",
"status",
"updated_at",
"explanation"
],
"title": "TenDlcBrandAppeal",
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Registers a 10DLC Campaign.",
"inputSchema": {
"properties": {
"affiliate_marketing": {
"description": "Indicates whether the Campaign is used for affiliate marketing",
"example": false,
"type": "boolean"
},
"age_gated": {
"description": "Indicates whether the Campaign messages contain age-gated content",
"example": false,
"type": "boolean"
},
"auto_renewal": {
"description": "Indicates whether the Campaign should be automatically renewed",
"example": true,
"type": "boolean"
},
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"description": {
"description": "The Campaign description",
"example": "Our campaign aims to …",
"type": "string"
},
"direct_lending": {
"description": "Indicates whether the Campaign messages contain direct lending content",
"example": true,
"type": "boolean"
},
"embedded_link_sample": {
"description": "An embedded link sample",
"type": [
"string",
"null"
]
},
"embedded_links": {
"description": "Indicates whether the Campaign messages contain embedded links",
"example": true,
"type": "boolean"
},
"embedded_phones": {
"description": "Indicates whether the Campaign messages contain embedded phone numbers",
"example": true,
"type": [
"boolean",
"null"
]
},
"help": {
"description": "Indicates whether the campaign has a help system (e.g. keyword: HELP, INFO) that subscribers can use or not.",
"example": true,
"type": "boolean"
},
"help_keywords": {
"description": "A comma-separated list of HELP keywords. The HELP keywords are case-insensitive.",
"example": "help",
"type": "string"
},
"help_message": {
"description": "An acknowledgement to be sent when a HELP keyword is received",
"example": "For help, please visit www.site.com. To opt out, reply STOP.",
"type": "string"
},
"mock": {
"description": "Indicates a mock Campaign. The mock Campaigns cannot be used to send production traffic",
"example": false,
"type": "boolean"
},
"name": {
"description": "A user-defined Campaign name",
"example": "My first campaign",
"type": "string"
},
"optin": {
"description": "Indicates whether the campaign requires a subscriber to opt-in before receiving messages or not.",
"example": true,
"type": "boolean"
},
"optin_keywords": {
"description": "A comma-separated list of OPT-IN keywords. The OPT-IN keywords are case-insensitive.",
"example": "begin,start",
"type": "string"
},
"optin_message": {
"description": "An acknowledgement to be sent when an OPT-IN keyword is received",
"example": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"type": "string"
},
"optin_workflow": {
"description": "The opt-in workflow - the process through which consumers opt-in to the Campaign",
"example": "Our SMS ...",
"type": "string"
},
"optout": {
"description": "Indicates whether the campaign has an opt-out system (e.g. keyword: STOP, QUIT) that subscribers can use or not.",
"example": true,
"type": "boolean"
},
"optout_keywords": {
"description": "A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive.",
"example": "stop,quit,unsubscribe",
"type": "string"
},
"optout_message": {
"description": "An acknowledgement to be sent when an OPT-OUT keyword is received",
"example": "You are now opted out and will receive no further messages",
"type": "string"
},
"privacy_policy": {
"description": "A link to the Campaign privacy policy",
"example": "https://site.com/privacy-policy",
"type": "string"
},
"sample1": {
"description": "Message sample",
"example": "Your verification code is XXXXXX",
"type": "string"
},
"sample2": {
"description": "Message sample",
"type": [
"string",
"null"
]
},
"sample3": {
"description": "Message sample",
"type": [
"string",
"null"
]
},
"sample4": {
"description": "Message sample",
"type": [
"string",
"null"
]
},
"sample5": {
"description": "Message sample",
"type": [
"string",
"null"
]
},
"terms_conditions": {
"description": "A link to the Campaign terms and conditions",
"example": "https://site.com/terms-and-conditions",
"type": "string"
},
"usecase": {
"description": "The Campaign use case",
"example": "2FA",
"type": "string"
}
},
"required": [
"brand_id",
"affiliate_marketing",
"age_gated",
"auto_renewal",
"direct_lending",
"embedded_links",
"embedded_phones",
"embedded_link_sample",
"description",
"optin_workflow",
"help",
"help_keywords",
"help_message",
"optin",
"optin_keywords",
"optin_message",
"optout",
"optout_keywords",
"optout_message",
"name",
"sample1",
"sample2",
"sample3",
"sample4",
"sample5",
"mock",
"usecase",
"terms_conditions"
],
"type": "object"
},
"name": "ten_dlc_brand_campaigns_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"description": "10DLC campaign details.",
"example": {
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [
"14358684439",
"13193337776",
"12673296046"
],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
},
"properties": {
"affiliate_marketing": {
"description": "Indicates whether the Campaign is used for affiliate marketing.",
"example": false,
"type": "boolean"
},
"age_gated": {
"description": "Indicates whether the Campaign messages contain age-gated content.",
"example": false,
"type": "boolean"
},
"auto_renewal": {
"description": "Indicates whether the Campaign should be automatically renewed.",
"example": true,
"type": "boolean"
},
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CKLCK95",
"type": "string"
},
"created_at": {
"description": "Date and time the Campaign was created in ISO 8601 format.",
"example": "2024-08-14T11:57:41",
"type": "string"
},
"description": {
"description": "Campaign description.",
"example": "Our campaign aims to …",
"type": [
"string",
"null"
]
},
"direct_lending": {
"description": "Indicates whether the Campaign messages contain direct lending content.",
"example": true,
"type": "boolean"
},
"embedded_link_sample": {
"description": "Embedded link sample.",
"type": [
"string",
"null"
]
},
"embedded_links": {
"description": "Indicates whether the Campaign messages contain embedded links.",
"example": true,
"type": "boolean"
},
"embedded_phones": {
"description": "Indicates whether the Campaign messages contain embedded phone numbers.",
"example": true,
"type": "boolean"
},
"feedback": {
"description": "Campaign feedback.",
"type": [
"string",
"null"
]
},
"help": {
"description": "Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).",
"example": true,
"type": "boolean"
},
"help_keywords": {
"description": "Comma-separated list of help keywords. Keywords are case-insensitive.",
"example": "help",
"type": "string"
},
"help_message": {
"description": "Help message sent upon receiving a help keyword.",
"example": "For help, please visit www.site.com. To opt out, reply STOP.",
"type": [
"string",
"null"
]
},
"last_bill_date": {
"description": "Date and time the Campaign was last billed in ISO 8601 format. `null` if the Campaign has never been billed.",
"example": "2024-08-14T11:57:42",
"type": [
"string",
"null"
]
},
"mock": {
"description": "Indicates whether the Campaign is a mock campaign.",
"example": false,
"type": "boolean"
},
"monthly_fee": {
"description": "Campaign monthly fee.",
"example": "10.0",
"type": "string"
},
"name": {
"description": "Campaign name.",
"example": "My first campaign",
"type": "string"
},
"next_bill_date": {
"description": "Date and time the Campaign will be billed next in ISO 8601 format. `null` if the next billing date is not scheduled.",
"example": "2024-08-14T11:57:42",
"type": [
"string",
"null"
]
},
"optin": {
"description": "Indicates whether the Campaign requires subscriber opt-in.",
"example": true,
"type": "boolean"
},
"optin_keywords": {
"description": "Comma-separated list of opt-in keywords. Keywords are case-insensitive.",
"example": "begin,start",
"type": "string"
},
"optin_message": {
"description": "Opt-in message sent upon receiving an opt-in keyword.",
"example": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"type": [
"string",
"null"
]
},
"optin_workflow": {
"description": "Opt-in workflow description.",
"example": "Our SMS ...",
"type": [
"string",
"null"
]
},
"optout": {
"description": "Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).",
"example": true,
"type": "boolean"
},
"optout_keywords": {
"description": "Comma-separated list of opt-out keywords. Keywords are case-insensitive.",
"example": "stop,quit,unsubscribe",
"type": "string"
},
"optout_message": {
"description": "Opt-out message sent upon receiving an opt-out keyword.",
"example": "You are now opted out and will receive no further messages",
"type": [
"string",
"null"
]
},
"phone_numbers": {
"description": "List of phone numbers associated with the campaign.",
"example": [
"14358684439",
"13193337776",
"12673296046"
],
"items": {
"type": "string"
},
"type": "array"
},
"privacy_policy": {
"description": "Privacy policy URL.",
"example": "https://site.com/privacy-policy",
"type": [
"string",
"null"
]
},
"sample1": {
"description": "Message sample.",
"example": "Your verification code is XXXXXX",
"type": [
"string",
"null"
]
},
"sample2": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample3": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample4": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample5": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Campaign status.",
"example": "APPROVED",
"type": "string"
},
"terms_conditions": {
"description": "Terms and conditions URL.",
"example": "https://site.com/terms-and-conditions",
"type": [
"string",
"null"
]
},
"updated_at": {
"description": "Date and time the Campaign was updated in ISO 8601 format.",
"example": "2024-08-14T11:57:47",
"type": "string"
},
"usecase": {
"description": "Campaign use case.",
"example": "2FA",
"type": "string"
}
},
"required": [
"affiliate_marketing",
"age_gated",
"auto_renewal",
"last_bill_date",
"next_bill_date",
"direct_lending",
"embedded_links",
"embedded_phones",
"embedded_link_sample",
"brand_id",
"campaign_id",
"description",
"optin_workflow",
"feedback",
"help",
"help_keywords",
"help_message",
"optin",
"optin_keywords",
"optin_message",
"optout",
"optout_keywords",
"optout_message",
"name",
"created_at",
"sample1",
"sample2",
"sample3",
"sample4",
"sample5",
"updated_at",
"mock",
"usecase",
"monthly_fee",
"terms_conditions",
"privacy_policy",
"status",
"phone_numbers"
],
"title": "TenDlcCampaign",
"type": "object"
},
{
"example": {
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Deletes a 10DLC Campaign. Associated phone numbers cannot be used as Sender IDs once the Campaign is deleted.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CKLCK95",
"type": "string"
}
},
"required": [
"brand_id",
"campaign_id"
],
"type": "object"
},
"name": "ten_dlc_brand_campaigns_delete",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a 10DLC Campaign.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CKLCK95",
"type": "string"
}
},
"required": [
"brand_id",
"campaign_id"
],
"type": "object"
},
"name": "ten_dlc_brand_campaigns_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"description": "10DLC campaign details.",
"example": {
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [
"14358684439",
"13193337776",
"12673296046"
],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
},
"properties": {
"affiliate_marketing": {
"description": "Indicates whether the Campaign is used for affiliate marketing.",
"example": false,
"type": "boolean"
},
"age_gated": {
"description": "Indicates whether the Campaign messages contain age-gated content.",
"example": false,
"type": "boolean"
},
"auto_renewal": {
"description": "Indicates whether the Campaign should be automatically renewed.",
"example": true,
"type": "boolean"
},
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CKLCK95",
"type": "string"
},
"created_at": {
"description": "Date and time the Campaign was created in ISO 8601 format.",
"example": "2024-08-14T11:57:41",
"type": "string"
},
"description": {
"description": "Campaign description.",
"example": "Our campaign aims to …",
"type": [
"string",
"null"
]
},
"direct_lending": {
"description": "Indicates whether the Campaign messages contain direct lending content.",
"example": true,
"type": "boolean"
},
"embedded_link_sample": {
"description": "Embedded link sample.",
"type": [
"string",
"null"
]
},
"embedded_links": {
"description": "Indicates whether the Campaign messages contain embedded links.",
"example": true,
"type": "boolean"
},
"embedded_phones": {
"description": "Indicates whether the Campaign messages contain embedded phone numbers.",
"example": true,
"type": "boolean"
},
"feedback": {
"description": "Campaign feedback.",
"type": [
"string",
"null"
]
},
"help": {
"description": "Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).",
"example": true,
"type": "boolean"
},
"help_keywords": {
"description": "Comma-separated list of help keywords. Keywords are case-insensitive.",
"example": "help",
"type": "string"
},
"help_message": {
"description": "Help message sent upon receiving a help keyword.",
"example": "For help, please visit www.site.com. To opt out, reply STOP.",
"type": [
"string",
"null"
]
},
"last_bill_date": {
"description": "Date and time the Campaign was last billed in ISO 8601 format. `null` if the Campaign has never been billed.",
"example": "2024-08-14T11:57:42",
"type": [
"string",
"null"
]
},
"mock": {
"description": "Indicates whether the Campaign is a mock campaign.",
"example": false,
"type": "boolean"
},
"monthly_fee": {
"description": "Campaign monthly fee.",
"example": "10.0",
"type": "string"
},
"name": {
"description": "Campaign name.",
"example": "My first campaign",
"type": "string"
},
"next_bill_date": {
"description": "Date and time the Campaign will be billed next in ISO 8601 format. `null` if the next billing date is not scheduled.",
"example": "2024-08-14T11:57:42",
"type": [
"string",
"null"
]
},
"optin": {
"description": "Indicates whether the Campaign requires subscriber opt-in.",
"example": true,
"type": "boolean"
},
"optin_keywords": {
"description": "Comma-separated list of opt-in keywords. Keywords are case-insensitive.",
"example": "begin,start",
"type": "string"
},
"optin_message": {
"description": "Opt-in message sent upon receiving an opt-in keyword.",
"example": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"type": [
"string",
"null"
]
},
"optin_workflow": {
"description": "Opt-in workflow description.",
"example": "Our SMS ...",
"type": [
"string",
"null"
]
},
"optout": {
"description": "Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).",
"example": true,
"type": "boolean"
},
"optout_keywords": {
"description": "Comma-separated list of opt-out keywords. Keywords are case-insensitive.",
"example": "stop,quit,unsubscribe",
"type": "string"
},
"optout_message": {
"description": "Opt-out message sent upon receiving an opt-out keyword.",
"example": "You are now opted out and will receive no further messages",
"type": [
"string",
"null"
]
},
"phone_numbers": {
"description": "List of phone numbers associated with the campaign.",
"example": [
"14358684439",
"13193337776",
"12673296046"
],
"items": {
"type": "string"
},
"type": "array"
},
"privacy_policy": {
"description": "Privacy policy URL.",
"example": "https://site.com/privacy-policy",
"type": [
"string",
"null"
]
},
"sample1": {
"description": "Message sample.",
"example": "Your verification code is XXXXXX",
"type": [
"string",
"null"
]
},
"sample2": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample3": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample4": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample5": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Campaign status.",
"example": "APPROVED",
"type": "string"
},
"terms_conditions": {
"description": "Terms and conditions URL.",
"example": "https://site.com/terms-and-conditions",
"type": [
"string",
"null"
]
},
"updated_at": {
"description": "Date and time the Campaign was updated in ISO 8601 format.",
"example": "2024-08-14T11:57:47",
"type": "string"
},
"usecase": {
"description": "Campaign use case.",
"example": "2FA",
"type": "string"
}
},
"required": [
"affiliate_marketing",
"age_gated",
"auto_renewal",
"last_bill_date",
"next_bill_date",
"direct_lending",
"embedded_links",
"embedded_phones",
"embedded_link_sample",
"brand_id",
"campaign_id",
"description",
"optin_workflow",
"feedback",
"help",
"help_keywords",
"help_message",
"optin",
"optin_keywords",
"optin_message",
"optout",
"optout_keywords",
"optout_message",
"name",
"created_at",
"sample1",
"sample2",
"sample3",
"sample4",
"sample5",
"updated_at",
"mock",
"usecase",
"monthly_fee",
"terms_conditions",
"privacy_policy",
"status",
"phone_numbers"
],
"title": "TenDlcCampaign",
"type": "object"
},
{
"example": {
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [
"14358684439",
"13193337776",
"12673296046"
],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns 10DLC Campaigns associated with a Brand.\n Results are limited to 25 records per page by default.\n Use `page` and `per_page` to navigate results.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"created_after": {
"description": "Campaign creation start date in `YYYY-MM-DD` format.",
"example": "2024-08-22",
"format": "date",
"type": "string"
},
"created_before": {
"description": "Campaign creation end date in `YYYY-MM-DD` format.",
"example": "2024-08-22",
"format": "date",
"type": "string"
},
"mock": {
"default": false,
"description": "Indicates whether to include mock Campaigns only.",
"example": true,
"type": "boolean"
},
"name": {
"description": "Campaign name.",
"example": "Name",
"type": "string"
},
"page": {
"description": "Page number to retrieve.",
"example": 1,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"status": {
"description": "Campaign status.",
"example": "APPROVED",
"type": "string"
},
"usecase": {
"description": "Use case.",
"example": "2FA",
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "ten_dlc_brand_campaigns_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"description": "A list of 10DLC Campaigns",
"example": {
"items": [
{
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [
"14358684439",
"13193337776",
"12673296046"
],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
}
],
"pagination": {
"current_page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
}
},
"properties": {
"items": {
"description": "A paginated list of 10DLC Campaign matching the filter criteria",
"items": {
"additionalProperties": false,
"description": "10DLC campaign details.",
"example": {
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [
"14358684439",
"13193337776",
"12673296046"
],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
},
"properties": {
"affiliate_marketing": {
"description": "Indicates whether the Campaign is used for affiliate marketing.",
"example": false,
"type": "boolean"
},
"age_gated": {
"description": "Indicates whether the Campaign messages contain age-gated content.",
"example": false,
"type": "boolean"
},
"auto_renewal": {
"description": "Indicates whether the Campaign should be automatically renewed.",
"example": true,
"type": "boolean"
},
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CKLCK95",
"type": "string"
},
"created_at": {
"description": "Date and time the Campaign was created in ISO 8601 format.",
"example": "2024-08-14T11:57:41",
"type": "string"
},
"description": {
"description": "Campaign description.",
"example": "Our campaign aims to …",
"type": [
"string",
"null"
]
},
"direct_lending": {
"description": "Indicates whether the Campaign messages contain direct lending content.",
"example": true,
"type": "boolean"
},
"embedded_link_sample": {
"description": "Embedded link sample.",
"type": [
"string",
"null"
]
},
"embedded_links": {
"description": "Indicates whether the Campaign messages contain embedded links.",
"example": true,
"type": "boolean"
},
"embedded_phones": {
"description": "Indicates whether the Campaign messages contain embedded phone numbers.",
"example": true,
"type": "boolean"
},
"feedback": {
"description": "Campaign feedback.",
"type": [
"string",
"null"
]
},
"help": {
"description": "Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).",
"example": true,
"type": "boolean"
},
"help_keywords": {
"description": "Comma-separated list of help keywords. Keywords are case-insensitive.",
"example": "help",
"type": "string"
},
"help_message": {
"description": "Help message sent upon receiving a help keyword.",
"example": "For help, please visit www.site.com. To opt out, reply STOP.",
"type": [
"string",
"null"
]
},
"last_bill_date": {
"description": "Date and time the Campaign was last billed in ISO 8601 format. `null` if the Campaign has never been billed.",
"example": "2024-08-14T11:57:42",
"type": [
"string",
"null"
]
},
"mock": {
"description": "Indicates whether the Campaign is a mock campaign.",
"example": false,
"type": "boolean"
},
"monthly_fee": {
"description": "Campaign monthly fee.",
"example": "10.0",
"type": "string"
},
"name": {
"description": "Campaign name.",
"example": "My first campaign",
"type": "string"
},
"next_bill_date": {
"description": "Date and time the Campaign will be billed next in ISO 8601 format. `null` if the next billing date is not scheduled.",
"example": "2024-08-14T11:57:42",
"type": [
"string",
"null"
]
},
"optin": {
"description": "Indicates whether the Campaign requires subscriber opt-in.",
"example": true,
"type": "boolean"
},
"optin_keywords": {
"description": "Comma-separated list of opt-in keywords. Keywords are case-insensitive.",
"example": "begin,start",
"type": "string"
},
"optin_message": {
"description": "Opt-in message sent upon receiving an opt-in keyword.",
"example": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"type": [
"string",
"null"
]
},
"optin_workflow": {
"description": "Opt-in workflow description.",
"example": "Our SMS ...",
"type": [
"string",
"null"
]
},
"optout": {
"description": "Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).",
"example": true,
"type": "boolean"
},
"optout_keywords": {
"description": "Comma-separated list of opt-out keywords. Keywords are case-insensitive.",
"example": "stop,quit,unsubscribe",
"type": "string"
},
"optout_message": {
"description": "Opt-out message sent upon receiving an opt-out keyword.",
"example": "You are now opted out and will receive no further messages",
"type": [
"string",
"null"
]
},
"phone_numbers": {
"description": "List of phone numbers associated with the campaign.",
"example": [
"14358684439",
"13193337776",
"12673296046"
],
"items": {
"type": "string"
},
"type": "array"
},
"privacy_policy": {
"description": "Privacy policy URL.",
"example": "https://site.com/privacy-policy",
"type": [
"string",
"null"
]
},
"sample1": {
"description": "Message sample.",
"example": "Your verification code is XXXXXX",
"type": [
"string",
"null"
]
},
"sample2": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample3": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample4": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample5": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Campaign status.",
"example": "APPROVED",
"type": "string"
},
"terms_conditions": {
"description": "Terms and conditions URL.",
"example": "https://site.com/terms-and-conditions",
"type": [
"string",
"null"
]
},
"updated_at": {
"description": "Date and time the Campaign was updated in ISO 8601 format.",
"example": "2024-08-14T11:57:47",
"type": "string"
},
"usecase": {
"description": "Campaign use case.",
"example": "2FA",
"type": "string"
}
},
"required": [
"affiliate_marketing",
"age_gated",
"auto_renewal",
"last_bill_date",
"next_bill_date",
"direct_lending",
"embedded_links",
"embedded_phones",
"embedded_link_sample",
"brand_id",
"campaign_id",
"description",
"optin_workflow",
"feedback",
"help",
"help_keywords",
"help_message",
"optin",
"optin_keywords",
"optin_message",
"optout",
"optout_keywords",
"optout_message",
"name",
"created_at",
"sample1",
"sample2",
"sample3",
"sample4",
"sample5",
"updated_at",
"mock",
"usecase",
"monthly_fee",
"terms_conditions",
"privacy_policy",
"status",
"phone_numbers"
],
"title": "TenDlcCampaign",
"type": "object"
},
"type": "array"
},
"pagination": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
},
{
"description": "Pagination details"
}
]
}
},
"required": [
"items",
"pagination"
],
"title": "TenDlcCampaignListResponse",
"type": "object"
},
{
"example": {
"items": [
{
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [
"14358684439",
"13193337776",
"12673296046"
],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
}
],
"pagination": {
"current_page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
}
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Updates a 10DLC Campaign.",
"inputSchema": {
"properties": {
"age_gated": {
"default": false,
"description": "Indicates whether the Campaign messages contain age-gated content",
"example": false,
"type": "boolean"
},
"auto_renewal": {
"default": true,
"description": "Indicates whether the Campaign should be automatically renewed",
"example": true,
"type": "boolean"
},
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CKLCK95",
"type": "string"
},
"description": {
"description": "The Campaign description",
"example": "Explain how users opt in (e.g., via website or paid ads), specify the message frequency, and clearly state that opting in to messages is optional and not required to use the service.",
"maxLength": 4096,
"minLength": 40,
"type": "string"
},
"direct_lending": {
"default": false,
"description": "Indicates whether the Campaign messages contain direct lending content",
"example": false,
"type": "boolean"
},
"embedded_link_sample": {
"description": "An embedded link sample",
"example": "https://example.com",
"maxLength": 255,
"type": "string"
},
"embedded_links": {
"default": false,
"description": "Indicates whether the Campaign messages contain embedded links",
"example": false,
"type": "boolean"
},
"embedded_phones": {
"default": false,
"description": "Indicates whether the Campaign messages contain embedded phone numbers",
"example": false,
"type": "boolean"
},
"help": {
"default": false,
"description": "Indicates whether the Campaign provides HELP responses",
"example": true,
"type": "boolean"
},
"help_keywords": {
"default": "HELP",
"description": "A comma-separated list of HELP keywords. The HELP keywords are case-insensitive.",
"example": "help",
"maxLength": 255,
"type": "string"
},
"help_message": {
"description": "An acknowledgement to be sent when a HELP keyword is received",
"example": "For help, please visit www.site.com. To opt out, reply STOP.",
"maxLength": 320,
"minLength": 20,
"type": "string"
},
"name": {
"description": "A user-defined Campaign name",
"example": "Campaign",
"maxLength": 120,
"type": "string"
},
"optin": {
"default": false,
"description": "Indicates whether the Campaign supports opt-in functionality",
"example": true,
"type": "boolean"
},
"optin_keywords": {
"description": "A comma-separated list of OPT-IN keywords. The OPT-IN keywords are case-insensitive.",
"example": "start,optin",
"maxLength": 255,
"type": "string"
},
"optin_message": {
"description": "An acknowledgement to be sent when an OPT-IN keyword is received",
"example": "You have opted in to our campaign. Reply HELP for assistance or STOP to unsubscribe.",
"maxLength": 320,
"minLength": 20,
"type": "string"
},
"optin_workflow": {
"description": "The opt-in workflow - the process through which consumers opt-in to the Campaign",
"example": "Our SMS campaign uses a double opt-in workflow where customers reply START to begin",
"maxLength": 4096,
"minLength": 40,
"type": "string"
},
"optout": {
"default": false,
"description": "Indicates whether the Campaign supports opt-out functionality",
"example": true,
"type": "boolean"
},
"optout_keywords": {
"description": "A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive.",
"example": "optout,discard",
"maxLength": 255,
"type": "string"
},
"optout_message": {
"description": "An acknowledgement to be sent when an OPT-OUT keyword is received",
"example": "A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive.",
"maxLength": 320,
"minLength": 20,
"type": "string"
},
"privacy_policy": {
"description": "A link to the Campaign privacy policy",
"example": "PROFESSIONAL",
"maxLength": 255,
"type": "string"
},
"sample1": {
"description": "Message sample",
"example": "Example of message sample for campaign 1",
"maxLength": 1024,
"minLength": 20,
"type": "string"
},
"sample2": {
"description": "Message sample",
"example": "Example of message sample for campaign 2",
"maxLength": 1024,
"minLength": 20,
"type": "string"
},
"sample3": {
"description": "Message sample",
"example": "Example of message sample for campaign 3",
"maxLength": 1024,
"minLength": 20,
"type": "string"
},
"sample4": {
"description": "Message sample",
"example": "Example of message sample for campaign 4",
"maxLength": 1024,
"minLength": 20,
"type": "string"
},
"sample5": {
"description": "Message sample",
"example": "Example of message sample for campaign 5",
"maxLength": 1024,
"minLength": 20,
"type": "string"
},
"terms_conditions": {
"description": "A link to the Campaign terms and conditions",
"example": "https://site.com/terms-and-conditions",
"maxLength": 255,
"type": "string"
},
"usecase": {
"description": "Campaign use case",
"enum": [
"CUSTOMER_CARE",
"MARKETING",
"ACCOUNT_NOTIFICATION",
"FRAUD_ALERT",
"PUBLIC_SERVICE_ANNOUNCEMENT",
"SECURITY_ALERT"
],
"example": "MARKETING",
"type": "string"
}
},
"required": [
"brand_id",
"campaign_id"
],
"type": "object"
},
"name": "ten_dlc_brand_campaigns_update",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"description": "10DLC campaign details.",
"example": {
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [
"14358684439",
"13193337776",
"12673296046"
],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
},
"properties": {
"affiliate_marketing": {
"description": "Indicates whether the Campaign is used for affiliate marketing.",
"example": false,
"type": "boolean"
},
"age_gated": {
"description": "Indicates whether the Campaign messages contain age-gated content.",
"example": false,
"type": "boolean"
},
"auto_renewal": {
"description": "Indicates whether the Campaign should be automatically renewed.",
"example": true,
"type": "boolean"
},
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CKLCK95",
"type": "string"
},
"created_at": {
"description": "Date and time the Campaign was created in ISO 8601 format.",
"example": "2024-08-14T11:57:41",
"type": "string"
},
"description": {
"description": "Campaign description.",
"example": "Our campaign aims to …",
"type": [
"string",
"null"
]
},
"direct_lending": {
"description": "Indicates whether the Campaign messages contain direct lending content.",
"example": true,
"type": "boolean"
},
"embedded_link_sample": {
"description": "Embedded link sample.",
"type": [
"string",
"null"
]
},
"embedded_links": {
"description": "Indicates whether the Campaign messages contain embedded links.",
"example": true,
"type": "boolean"
},
"embedded_phones": {
"description": "Indicates whether the Campaign messages contain embedded phone numbers.",
"example": true,
"type": "boolean"
},
"feedback": {
"description": "Campaign feedback.",
"type": [
"string",
"null"
]
},
"help": {
"description": "Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).",
"example": true,
"type": "boolean"
},
"help_keywords": {
"description": "Comma-separated list of help keywords. Keywords are case-insensitive.",
"example": "help",
"type": "string"
},
"help_message": {
"description": "Help message sent upon receiving a help keyword.",
"example": "For help, please visit www.site.com. To opt out, reply STOP.",
"type": [
"string",
"null"
]
},
"last_bill_date": {
"description": "Date and time the Campaign was last billed in ISO 8601 format. `null` if the Campaign has never been billed.",
"example": "2024-08-14T11:57:42",
"type": [
"string",
"null"
]
},
"mock": {
"description": "Indicates whether the Campaign is a mock campaign.",
"example": false,
"type": "boolean"
},
"monthly_fee": {
"description": "Campaign monthly fee.",
"example": "10.0",
"type": "string"
},
"name": {
"description": "Campaign name.",
"example": "My first campaign",
"type": "string"
},
"next_bill_date": {
"description": "Date and time the Campaign will be billed next in ISO 8601 format. `null` if the next billing date is not scheduled.",
"example": "2024-08-14T11:57:42",
"type": [
"string",
"null"
]
},
"optin": {
"description": "Indicates whether the Campaign requires subscriber opt-in.",
"example": true,
"type": "boolean"
},
"optin_keywords": {
"description": "Comma-separated list of opt-in keywords. Keywords are case-insensitive.",
"example": "begin,start",
"type": "string"
},
"optin_message": {
"description": "Opt-in message sent upon receiving an opt-in keyword.",
"example": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"type": [
"string",
"null"
]
},
"optin_workflow": {
"description": "Opt-in workflow description.",
"example": "Our SMS ...",
"type": [
"string",
"null"
]
},
"optout": {
"description": "Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).",
"example": true,
"type": "boolean"
},
"optout_keywords": {
"description": "Comma-separated list of opt-out keywords. Keywords are case-insensitive.",
"example": "stop,quit,unsubscribe",
"type": "string"
},
"optout_message": {
"description": "Opt-out message sent upon receiving an opt-out keyword.",
"example": "You are now opted out and will receive no further messages",
"type": [
"string",
"null"
]
},
"phone_numbers": {
"description": "List of phone numbers associated with the campaign.",
"example": [
"14358684439",
"13193337776",
"12673296046"
],
"items": {
"type": "string"
},
"type": "array"
},
"privacy_policy": {
"description": "Privacy policy URL.",
"example": "https://site.com/privacy-policy",
"type": [
"string",
"null"
]
},
"sample1": {
"description": "Message sample.",
"example": "Your verification code is XXXXXX",
"type": [
"string",
"null"
]
},
"sample2": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample3": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample4": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample5": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Campaign status.",
"example": "APPROVED",
"type": "string"
},
"terms_conditions": {
"description": "Terms and conditions URL.",
"example": "https://site.com/terms-and-conditions",
"type": [
"string",
"null"
]
},
"updated_at": {
"description": "Date and time the Campaign was updated in ISO 8601 format.",
"example": "2024-08-14T11:57:47",
"type": "string"
},
"usecase": {
"description": "Campaign use case.",
"example": "2FA",
"type": "string"
}
},
"required": [
"affiliate_marketing",
"age_gated",
"auto_renewal",
"last_bill_date",
"next_bill_date",
"direct_lending",
"embedded_links",
"embedded_phones",
"embedded_link_sample",
"brand_id",
"campaign_id",
"description",
"optin_workflow",
"feedback",
"help",
"help_keywords",
"help_message",
"optin",
"optin_keywords",
"optin_message",
"optout",
"optout_keywords",
"optout_message",
"name",
"created_at",
"sample1",
"sample2",
"sample3",
"sample4",
"sample5",
"updated_at",
"mock",
"usecase",
"monthly_fee",
"terms_conditions",
"privacy_policy",
"status",
"phone_numbers"
],
"title": "TenDlcCampaign",
"type": "object"
},
{
"example": {
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Deletes a 10DLC Brand evidence file.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "B6AI7PA",
"type": "string"
},
"uuid": {
"description": "Evidence ID.",
"example": "191eb205-8357-4d71-b8da-160a25a000d7",
"type": "string"
}
},
"required": [
"brand_id",
"uuid"
],
"type": "object"
},
"name": "ten_dlc_brand_evidence_delete",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Get a download URL for a 10DLC brand evidence file.\n\nReturns ``{download_url, content_type, status_code, note}`` instead of the\nbinary file stream. Fetch ``download_url`` to obtain the file.",
"inputSchema": {
"additionalProperties": false,
"properties": {
"brand_id": {
"type": "string"
},
"uuid": {
"type": "string"
}
},
"required": [
"brand_id",
"uuid"
],
"type": "object"
},
"name": "ten_dlc_brand_evidence_get",
"outputSchema": {
"additionalProperties": true,
"type": "object"
}
},
{
"description": "Use this method to list previously uploaded Brand appeal evidence.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Unique identifier of a Brand",
"example": "B6AI7PA",
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "ten_dlc_brand_evidence_list",
"outputSchema": {
"example": {
"items": [
{
"file_name": "file.png",
"mime_type": "image/png",
"url": "https://api.qa1.wavix.dev/v3/10dlc/brands/BRGQVL0/evidence/3d8d97b6-61f7-4f91-8c1c-7ef83828e072",
"uuid": "3d8d97b6-61f7-4f91-8c1c-7ef83828e072"
}
]
},
"properties": {
"items": {
"description": "List of uploaded evidence files",
"items": {
"additionalProperties": false,
"example": {
"file_name": "image.png",
"mime_type": "image/png",
"url": "https://api.wavix.dev/v3/10dlc/brands/B6AI7PA/evidence/191eb205-8357-4d71-b8da-160a25a000d7",
"uuid": "191eb205-8357-4d71-b8da-160a25a000d7"
},
"properties": {
"file_name": {
"description": "The uploaded file name",
"example": "image.png",
"type": "string"
},
"mime_type": {
"description": "The uploaded file media type",
"example": "image/png",
"type": "string"
},
"url": {
"description": "An URL to the uploaded file",
"example": "https://api.wavix.dev/v3/10dlc/brands/B6AI7PA/evidence/191eb205-8357-4d71-b8da-160a25a000d7",
"type": "string"
},
"uuid": {
"description": "The evidence UUID",
"example": "191eb205-8357-4d71-b8da-160a25a000d7",
"type": "string"
}
},
"required": [
"file_name",
"mime_type",
"url",
"uuid"
],
"title": "TenDlcBrandEvidence",
"type": "object"
},
"type": "array"
}
},
"required": [
"items"
],
"type": "object"
}
},
{
"description": "Uploads 10DLC Brand evidence. Supported formats include .jpg, .png, .pdf, and more. File size must be under 10MB.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "B6AI7PA",
"type": "string"
},
"file": {
"description": "File to upload.",
"format": "binary",
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "ten_dlc_brand_evidence_upload",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"example": {
"file_name": "image.png",
"mime_type": "image/png",
"url": "https://api.wavix.dev/v3/10dlc/brands/B6AI7PA/evidence/191eb205-8357-4d71-b8da-160a25a000d7",
"uuid": "191eb205-8357-4d71-b8da-160a25a000d7"
},
"properties": {
"file_name": {
"description": "The uploaded file name",
"example": "image.png",
"type": "string"
},
"mime_type": {
"description": "The uploaded file media type",
"example": "image/png",
"type": "string"
},
"url": {
"description": "An URL to the uploaded file",
"example": "https://api.wavix.dev/v3/10dlc/brands/B6AI7PA/evidence/191eb205-8357-4d71-b8da-160a25a000d7",
"type": "string"
},
"uuid": {
"description": "The evidence UUID",
"example": "191eb205-8357-4d71-b8da-160a25a000d7",
"type": "string"
}
},
"required": [
"file_name",
"mime_type",
"url",
"uuid"
],
"title": "TenDlcBrandEvidence",
"type": "object"
},
{
"example": {
"file_name": "image.png",
"mime_type": "image/png",
"url": "https://api.wavix.dev/v3/10dlc/brands/B6AI7PA/evidence/191eb205-8357-4d71-b8da-160a25a000d7",
"uuid": "191eb205-8357-4d71-b8da-160a25a000d7"
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns the qualification results for a 10DLC Brand use case. Includes MNO-specific attributes, restrictions, and fees.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BMQFB7X",
"type": "string"
},
"use_case": {
"description": "Use case name.",
"enum": [
"AGENTS_FRANCHISES",
"CARRIER_EXEMPT",
"CHARITY",
"EMERGENCY",
"K12_EDUCATION",
"LOW_VOLUME",
"M2M",
"MIXED",
"POLITICAL",
"PROXY",
"SOCIAL",
"SOLE_PROPRIETOR",
"SWEEPSTAKE",
"TRIAL",
"UCAAS_HIGH",
"UCAAS_LOW",
"2FA",
"ACCOUNT_NOTIFICATION",
"CUSTOMER_CARE",
"DELIVERY_NOTIFICATION",
"FRAUD_ALERT",
"HIGHER_EDUCATION",
"MARKETING",
"POLLING_VOTING",
"PUBLIC_SERVICE_ANNOUNCEMENT",
"SECURITY_ALERT"
],
"example": "2FA",
"type": "string"
}
},
"required": [
"brand_id",
"use_case"
],
"type": "object"
},
"name": "ten_dlc_brand_usecase_qualify",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"example": {
"mno_metadata": [
{
"att_mms_tpm": null,
"att_msg_class": null,
"att_sms_tpm": null,
"att_tpm_scope": null,
"help_required": true,
"min_msg_samples": 1,
"mno": "T-Mobile",
"mno_qualify": true,
"mno_review": false,
"mno_support": true,
"no_embedded_links": false,
"no_embedded_phone": false,
"optin_required": true,
"optout_required": false,
"tmobile_brand_dcap": 2000,
"tmobile_brand_tier": "LOW"
}
],
"monthly_fee": 10,
"usecase": "2FA"
},
"properties": {
"mno_metadata": {
"description": "An array MNO-specific attributes (e.g. AT&T message class) for every MNO the Brand is qualified to run a Campaign with the specified use case.",
"items": {
"additionalProperties": false,
"example": {
"att_mms_tpm": null,
"att_msg_class": null,
"att_sms_tpm": null,
"att_tpm_scope": null,
"help_required": true,
"min_msg_samples": 1,
"mno": "T-Mobile",
"mno_qualify": true,
"mno_review": false,
"mno_support": true,
"no_embedded_links": false,
"no_embedded_phone": false,
"optin_required": true,
"optout_required": false,
"tmobile_brand_dcap": 2000,
"tmobile_brand_tier": "LOW"
},
"properties": {
"att_mms_tpm": {
"description": "MMS message throughput on the AT&T mobile networks",
"format": "int32",
"type": [
"integer",
"null"
]
},
"att_msg_class": {
"description": "The message class assigned by AT&T",
"type": [
"string",
"null"
]
},
"att_sms_tpm": {
"description": "MMS message throughput on the AT&T mobile networks",
"format": "int32",
"type": [
"integer",
"null"
]
},
"att_tpm_scope": {
"description": "The message throughput score on the AT&T mobile networks",
"format": "int32",
"type": [
"string",
"null"
]
},
"help_required": {
"description": "Indicates whether the HEPL keywords and acknowledgement is mandatory for the use case",
"example": true,
"type": "boolean"
},
"min_msg_samples": {
"description": "The minimal number of message samples required by the MNO",
"example": 1,
"format": "int32",
"type": "integer"
},
"mno": {
"description": "The MNO name",
"example": "T-Mobile",
"type": "string"
},
"mno_qualify": {
"description": "Indicates whether the Brand is qualified by the MNO for the selected use case",
"example": true,
"type": "boolean"
},
"mno_review": {
"description": "Indicates whether the use case post-approval review is request by the MNO",
"example": false,
"type": "boolean"
},
"mno_support": {
"description": "Indicates whether the use case is supported by the MNO",
"example": true,
"type": "boolean"
},
"no_embedded_links": {
"description": "Indicates whether embedded links are prohibited in the message content for the use case",
"example": false,
"type": "boolean"
},
"no_embedded_phone": {
"description": "Indicates whether embedded phone numbers are prohibited in the message content for the use case",
"example": false,
"type": "boolean"
},
"optin_required": {
"description": "Indicates whether the opt in mechanism is mandatory for the use case",
"example": true,
"type": "boolean"
},
"optout_required": {
"description": "Indicates whether the opt out mechanism is mandatory for the use case",
"example": false,
"type": "boolean"
},
"tmobile_brand_dcap": {
"description": "Message daily cap on the T-Mobile mobile networks",
"example": 2000,
"format": "int32",
"type": [
"integer",
"null"
]
},
"tmobile_brand_tier": {
"description": "The Brand tier for the T-Mobile mobile networks",
"example": "LOW",
"type": [
"string",
"null"
]
}
},
"required": [
"att_mms_tpm",
"att_msg_class",
"att_sms_tpm",
"att_tpm_scope",
"help_required",
"optin_required",
"optout_required",
"min_msg_samples",
"mno",
"mno_qualify",
"mno_review",
"mno_support",
"no_embedded_links",
"no_embedded_phone",
"tmobile_brand_dcap",
"tmobile_brand_tier"
],
"title": "TenDlcMnoMetadata",
"type": "object"
},
"type": "array"
},
"monthly_fee": {
"description": "Monthly fee associated with any Campaign with this use case",
"example": 10,
"type": "number"
},
"usecase": {
"description": "The use case name",
"example": "2FA",
"type": "string"
}
},
"required": [
"mno_metadata",
"monthly_fee",
"usecase"
],
"title": "TenDlcBrandQualificationResult",
"type": "object"
},
{
"example": {
"mno_metadata": [
{
"att_mms_tpm": null,
"att_msg_class": null,
"att_sms_tpm": null,
"att_tpm_scope": null,
"help_required": true,
"min_msg_samples": 1,
"mno": "T-Mobile",
"mno_qualify": true,
"mno_review": false,
"mno_support": true,
"no_embedded_links": false,
"no_embedded_phone": false,
"optin_required": true,
"optout_required": false,
"tmobile_brand_dcap": 2000,
"tmobile_brand_tier": "LOW"
}
],
"monthly_fee": 10,
"usecase": "2FA"
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Submits an appeal for a 10DLC Brand external vetting.",
"inputSchema": {
"properties": {
"appeal_categories": {
"description": "List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`, `LOW_SCORE`.",
"example": [
"VERIFY_TAX_ID"
],
"items": {
"type": "string"
},
"type": "array"
},
"brand_id": {
"description": "Brand ID.",
"example": "B6AI7PA",
"type": "string"
},
"evidence": {
"description": "List of evidence IDs associated with the appeal.",
"example": [
"855dff49-c097-4645-3983-08dcb9856232"
],
"items": {
"type": "string"
},
"type": "array"
},
"evp_id": {
"description": "EVP ID.",
"example": "AEGIS",
"type": "string"
},
"explanation": {
"description": "Appeal comment or justification.",
"example": "Find the company incorporation docs attached and please review the Brand Identity status.",
"type": "string"
},
"vetting_id": {
"description": "Vetting ID.",
"example": "48c0ffaa-4e51-4d44-3982-08dcb9856232",
"type": "string"
}
},
"required": [
"brand_id",
"appeal_categories",
"evidence"
],
"type": "object"
},
"name": "ten_dlc_brand_vetting_appeals_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of external vetting appeals for a 10DLC Brand.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BMQFB7X",
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "ten_dlc_brand_vetting_appeals_list",
"outputSchema": {
"properties": {
"result": {
"example": [
{
"appeal_outcome": {
"feedback": {
"reasons": [
"Company size as reported by government or business sources resulted in a score deduction: size range 6-10."
]
},
"vet_score": 80,
"vet_status": "ACTIVE"
},
"appeal_status": "COMPLETE",
"appeal_status_update_date": "2024-08-15T08:42:31Z",
"attachment_uuid_list": [],
"brand_id": "BMQFB7X",
"category_list": [
"LOW_SCORE"
],
"create_date": "2024-08-15T08:41:05",
"evp_id": "AEGIS",
"explanation": "This is an API test",
"vetting_class": "STANDARD",
"vetting_id": "48c0ffaa-4e51-4d44-3982-08dcb9856232"
}
],
"items": {
"additionalProperties": false,
"example": {
"appeal_outcome": {
"feedback": {
"reasons": [
"Company size as reported by government or business sources resulted in a score deduction: size range 6-10."
]
},
"vet_score": 80,
"vet_status": "ACTIVE"
},
"appeal_status": "COMPLETE",
"appeal_status_update_date": "2024-08-15T08:42:31Z",
"attachment_uuid_list": [],
"brand_id": "BMQFB7X",
"category_list": [
"LOW_SCORE"
],
"create_date": "2024-08-15T08:41:05",
"evp_id": "AEGIS",
"explanation": "Please review the Brand score",
"vetting_class": "STANDARD",
"vetting_id": "48c0ffaa-4e51-4d44-3982-08dcb9856232"
},
"properties": {
"appeal_outcome": {
"allOf": [
{
"additionalProperties": false,
"example": {
"feedback": {
"reasons": [
"Company size as reported by government or business sources resulted in a score deduction: size range 6-10."
]
},
"vet_score": 80,
"vet_status": "ACTIVE"
},
"properties": {
"feedback": {
"allOf": [
{
"additionalProperties": false,
"example": {
"reasons": [
"Company size as reported by government or business sources resulted in a score deduction: size range 6-10."
]
},
"properties": {
"reasons": {
"description": "An list of human-readable explanations returned by TCR",
"example": [
"Company size as reported by government or business sources resulted in a score deduction: size range 6-10."
],
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"reasons"
],
"title": "TenDlcBrandVettingAppealOutcomeReason",
"type": "object"
},
{
"description": "The feedback provided by the external vetting provider"
}
]
},
"vet_score": {
"description": "The Brand vetting score",
"example": 80,
"format": "int32",
"type": "integer"
},
"vet_status": {
"description": "Current status of the Brand vetting",
"example": "ACTIVE",
"type": "string"
}
},
"required": [
"vet_status",
"vet_score",
"feedback"
],
"title": "TenDlcBrandVettingAppealOutcome",
"type": "object"
},
{
"description": "The appeal outcome",
"example": {
"feedback": {
"reasons": [
"Company size as reported by government or business sources resulted in a score deduction: size range 6-10."
]
},
"vet_score": 80,
"vet_status": "ACTIVE"
}
}
]
},
"appeal_status": {
"description": "The appeal status",
"example": "COMPLETE",
"type": "string"
},
"appeal_status_update_date": {
"description": "The date and time the appeal status was updated",
"example": "2024-08-15T08:42:31Z",
"format": "date-time",
"type": "string"
},
"attachment_uuid_list": {
"description": "A list of evidence UUIDs associated with the appeal",
"example": [],
"items": {
"type": "string"
},
"type": "array"
},
"brand_id": {
"description": "The unique identifier of the Brand the appeal is associated with",
"example": "BMQFB7X",
"type": "string"
},
"category_list": {
"description": "A list of appeal categories",
"example": [
"LOW_SCORE"
],
"items": {
"type": "string"
},
"type": "array"
},
"create_date": {
"description": "Date and time the appeal was created",
"example": "2024-08-15T08:41:05",
"type": "string"
},
"evp_id": {
"description": "External vetting provider code",
"example": "AEGIS",
"type": "string"
},
"explanation": {
"description": "The appeal justification",
"example": "Please review the Brand score",
"type": "string"
},
"vetting_class": {
"description": "The vetting class",
"example": "STANDARD",
"type": "string"
},
"vetting_id": {
"description": "The vetting unique identifier",
"example": "48c0ffaa-4e51-4d44-3982-08dcb9856232",
"type": "string"
}
},
"required": [
"appeal_outcome",
"appeal_status",
"appeal_status_update_date",
"attachment_uuid_list",
"brand_id",
"category_list",
"create_date",
"explanation",
"evp_id",
"vetting_class",
"vetting_id"
],
"title": "TenDlcBrandVettingAppeal",
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Requests external vetting for a 10DLC Brand. Supported providers: `AEGIS`, `CV`, `WMC`. Supported classes: `STANDARD`, `ENHANCED`.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "B6AI7PA",
"type": "string"
},
"evp_id": {
"description": "External vetting provider code",
"example": "AEGIS",
"type": "string"
},
"vetting_class": {
"description": "The vetting class",
"example": "STANDARD",
"type": "string"
}
},
"required": [
"brand_id",
"evp_id",
"vetting_class"
],
"type": "object"
},
"name": "ten_dlc_brand_vettings_create",
"outputSchema": {
"additionalProperties": false,
"properties": {
"create_date": {
"description": "The date and time the vetting request is created",
"example": "2024-08-01T14:09:43",
"type": "string"
},
"evp_id": {
"description": "External vetting provider code",
"example": "AEGIS",
"type": "string"
},
"reasons": {
"description": "Reason",
"example": [
"Company size as reported by government or business sources resulted in a score deduction: size range 6-10"
],
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"vetted_date": {
"description": "The date and time the vetting request is competed",
"example": "2024-08-01T14:09:43",
"type": [
"string",
"null"
]
},
"vetting_class": {
"description": "The vetting class",
"example": "STANDARD",
"type": "string"
},
"vetting_details": {
"additionalProperties": true,
"description": "Additional details of the vetting request",
"example": {
"additional_prop1": {},
"additional_prop2": {},
"additional_prop3": {}
},
"type": "object"
},
"vetting_id": {
"description": "Unique identifier of the vetting request",
"example": "13d8e00c-3cb4-4dc0-9e26-d5057fa938d9",
"type": "string"
},
"vetting_score": {
"description": "The assigned Brand vetting score",
"example": 80,
"format": "int32",
"type": [
"integer",
"null"
]
},
"vetting_status": {
"description": "Status of the vetting request",
"example": "PENDING",
"type": "string"
},
"vetting_token": {
"description": "Unique vetting token",
"example": "3oDcE1vq8OR43claMa6Thu/7V4vzZywAfKRgiJnXDjlw+08wpWbGqOssAXKgeZibHCLaGgXvU/yPb7kISeeb5qGdisGRLdhPnSNpvRR82RnCWYNpTp92orlJWjTJU8ZGmNxL5MwK0tt/9SxCha36iTtPV2+4vND8xCPe5suItuQTonG4A3Yi6F1LMqihgwdesRjxJnKqcE7Thcv9ug1NyNPYEZQvPugFj2F2DdU6jFZcOWgXsnE7ucZ+xNaNX9LkF9if3v0hrcviG9L8bUUrpPBGr02txP0i+cPBTLbj4Rq1Ox83R+WUx1gnoXHCIU1ByDGWvQq2Ef4qxGVOwPJHJbja1BovxKBk4YJxiz8OSO68QAIEfxuPTpj5eZz7KEFtFmBIVaVmxBDe4b8Tpl01C2rek7xgPzXaoURvh7CQVnVmJL00DTWKvyOmUOQQW901XEcgcJ7VWgfIvxhIMuXEXXtVDGNowmEc9JQXXYHVlGuN5QicSbApkwwqRZI7TQ4lsS66zCfqomIIJyBNRJpl+8sGwsa2J2h6fEkAD77J9zdUgIKXMFamHbvRadCKMZNIbMrkOC7PuOjZdSiWKh5A8FSjzkv3PlN2hRDqkaODEoodp5pTQeBtNe37+uAMOuHNfsZXlwvfMgCZjiZJ9HQNSLhJBUq7/IvT/EzszUk4HPTj/WFSbT1YrrkDi+zrB20ZDY9lZFWxN1hlYQoNcanDAAWPmw/yW1+8DroL5WIMGsXX3WFGOG7eWB1GHgFQsziAeRQl78u1qOvsRMN08+GrkASBJwqwy5l7xCesUKqbz3O0QA/dwzzsWIDvFPavZpjqMBSjRTurQLFahAaGmdY0BX/Ii+s2+OxfaHQIa1lgucm0P7GPKeZvLX/8boO01Onr/87ra+NX7ABvQb+SXvwsg+Bm5CziWB6DMKDKRD/KQjHxpjIY35UwSEW7G4ixux7ufizXttthHfPJWd/rWFhfYigFhVLgIPCR12smwFVuZwM7ujvY2CIM0X4E0dsX9uVHkgYmqRIdNf5vshpmRuIcHsXZpTJP/tD7zQM6m214c5xkJSfAVIaD7WzRYS4eVL+R3z4u+6n5p6FjuWSjSzuEffUai3HCWjes4JbtDSjIwoG0tOMtBukgPbreH+pjXcvnhU+1QhCV2aIdG6C3FmaI5Uoo/mthJyiFAThwtOpxQ5YkdsRunqVVEFYZfMNEn4Ig2clCFrLOm46JB2wPcLGP2MoH5RqajYzQ6IV8IXIFQVzG0C7HoHsBkVp+GrpnH6N0FCKR+fpbGjigM2lLf4pYBhChUY4ao9hvV1hd8ikS6QoasvDLPytBBa1YAwbSa8d7YdwO6fXfQqetfS8S9gbHD0zxazw5p9Lp5fXFmajDNkD2voYNMzOHJMMHG/49pWV2",
"type": [
"string",
"null"
]
}
},
"required": [
"evp_id",
"create_date",
"vetted_date",
"vetting_id",
"vetting_token",
"vetting_score",
"vetting_class",
"vetting_status",
"reasons"
],
"title": "TenDlcBrandVetting",
"type": "object"
}
},
{
"description": "Imports an existing external vetting for a 10DLC Brand.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "B6AI7PA",
"type": "string"
},
"evp_id": {
"description": "External vetting provider code",
"example": "AEGIS",
"type": "string"
},
"vetting_id": {
"description": "Unique identifier of the vetting request",
"example": "13d8e00c-3cb4-4dc0-9e26-d5057fa938d9",
"type": "string"
},
"vetting_token": {
"description": "Unique vetting token",
"example": "3oDcE1vq8OR43claMa6Thu/7V4vzZywAfKRgiJnXDjlw+08wpWbGqOssAXKgeZibHCLaGgXvU/yPb7kISeeb5qGdisGRLdhPnSNpvRR82RnCWYNpTp92orlJWjTJU8ZGmNxL5MwK0tt/9SxCha36iTtPV2+4vND8xCPe5suItuQTonG4A3Yi6F1LMqihgwdesRjxJnKqcE7Thcv9ug1NyNPYEZQvPugFj2F2DdU6jFZcOWgXsnE7ucZ+xNaNX9LkF9if3v0hrcviG9L8bUUrpPBGr02txP0i+cPBTLbj4Rq1Ox83R+WUx1gnoXHCIU1ByDGWvQq2Ef4qxGVOwPJHJbja1BovxKBk4YJxiz8OSO68QAIEfxuPTpj5eZz7KEFtFmBIVaVmxBDe4b8Tpl01C2rek7xgPzXaoURvh7CQVnVmJL00DTWKvyOmUOQQW901XEcgcJ7VWgfIvxhIMuXEXXtVDGNowmEc9JQXXYHVlGuN5QicSbApkwwqRZI7TQ4lsS66zCfqomIIJyBNRJpl+8sGwsa2J2h6fEkAD77J9zdUgIKXMFamHbvRadCKMZNIbMrkOC7PuOjZdSiWKh5A8FSjzkv3PlN2hRDqkaODEoodp5pTQeBtNe37+uAMOuHNfsZXlwvfMgCZjiZJ9HQNSLhJBUq7/IvT/EzszUk4HPTj/WFSbT1YrrkDi+zrB20ZDY9lZFWxN1hlYQoNcanDAAWPmw/yW1+8DroL5WIMGsXX3WFGOG7eWB1GHgFQsziAeRQl78u1qOvsRMN08+GrkASBJwqwy5l7xCesUKqbz3O0QA/dwzzsWIDvFPavZpjqMBSjRTurQLFahAaGmdY0BX/Ii+s2+OxfaHQIa1lgucm0P7GPKeZvLX/8boO01Onr/87ra+NX7ABvQb+SXvwsg+Bm5CziWB6DMKDKRD/KQjHxpjIY35UwSEW7G4ixux7ufizXttthHfPJWd/rWFhfYigFhVLgIPCR12smwFVuZwM7ujvY2CIM0X4E0dsX9uVHkgYmqRIdNf5vshpmRuIcHsXZpTJP/tD7zQM6m214c5xkJSfAVIaD7WzRYS4eVL+R3z4u+6n5p6FjuWSjSzuEffUai3HCWjes4JbtDSjIwoG0tOMtBukgPbreH+pjXcvnhU+1QhCV2aIdG6C3FmaI5Uoo/mthJyiFAThwtOpxQ5YkdsRunqVVEFYZfMNEn4Ig2clCFrLOm46JB2wPcLGP2MoH5RqajYzQ6IV8IXIFQVzG0C7HoHsBkVp+GrpnH6N0FCKR+fpbGjigM2lLf4pYBhChUY4ao9hvV1hd8ikS6QoasvDLPytBBa1YAwbSa8d7YdwO6fXfQqetfS8S9gbHD0zxazw5p9Lp5fXFmajDNkD2voYNMzOHJMMHG/49pWV2",
"type": "string"
}
},
"required": [
"brand_id",
"evp_id",
"vetting_id",
"vetting_token"
],
"type": "object"
},
"name": "ten_dlc_brand_vettings_import",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"create_date": {
"description": "The date and time the vetting request is created",
"example": "2024-08-01T14:09:43",
"type": "string"
},
"evp_id": {
"description": "External vetting provider code",
"example": "AEGIS",
"type": "string"
},
"reasons": {
"description": "Reason",
"example": [
"Company size as reported by government or business sources resulted in a score deduction: size range 6-10"
],
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"vetted_date": {
"description": "The date and time the vetting request is competed",
"example": "2024-08-01T14:09:43",
"type": [
"string",
"null"
]
},
"vetting_class": {
"description": "The vetting class",
"example": "STANDARD",
"type": "string"
},
"vetting_details": {
"additionalProperties": true,
"description": "Additional details of the vetting request",
"example": {
"additional_prop1": {},
"additional_prop2": {},
"additional_prop3": {}
},
"type": "object"
},
"vetting_id": {
"description": "Unique identifier of the vetting request",
"example": "13d8e00c-3cb4-4dc0-9e26-d5057fa938d9",
"type": "string"
},
"vetting_score": {
"description": "The assigned Brand vetting score",
"example": 80,
"format": "int32",
"type": [
"integer",
"null"
]
},
"vetting_status": {
"description": "Status of the vetting request",
"example": "PENDING",
"type": "string"
},
"vetting_token": {
"description": "Unique vetting token",
"example": "3oDcE1vq8OR43claMa6Thu/7V4vzZywAfKRgiJnXDjlw+08wpWbGqOssAXKgeZibHCLaGgXvU/yPb7kISeeb5qGdisGRLdhPnSNpvRR82RnCWYNpTp92orlJWjTJU8ZGmNxL5MwK0tt/9SxCha36iTtPV2+4vND8xCPe5suItuQTonG4A3Yi6F1LMqihgwdesRjxJnKqcE7Thcv9ug1NyNPYEZQvPugFj2F2DdU6jFZcOWgXsnE7ucZ+xNaNX9LkF9if3v0hrcviG9L8bUUrpPBGr02txP0i+cPBTLbj4Rq1Ox83R+WUx1gnoXHCIU1ByDGWvQq2Ef4qxGVOwPJHJbja1BovxKBk4YJxiz8OSO68QAIEfxuPTpj5eZz7KEFtFmBIVaVmxBDe4b8Tpl01C2rek7xgPzXaoURvh7CQVnVmJL00DTWKvyOmUOQQW901XEcgcJ7VWgfIvxhIMuXEXXtVDGNowmEc9JQXXYHVlGuN5QicSbApkwwqRZI7TQ4lsS66zCfqomIIJyBNRJpl+8sGwsa2J2h6fEkAD77J9zdUgIKXMFamHbvRadCKMZNIbMrkOC7PuOjZdSiWKh5A8FSjzkv3PlN2hRDqkaODEoodp5pTQeBtNe37+uAMOuHNfsZXlwvfMgCZjiZJ9HQNSLhJBUq7/IvT/EzszUk4HPTj/WFSbT1YrrkDi+zrB20ZDY9lZFWxN1hlYQoNcanDAAWPmw/yW1+8DroL5WIMGsXX3WFGOG7eWB1GHgFQsziAeRQl78u1qOvsRMN08+GrkASBJwqwy5l7xCesUKqbz3O0QA/dwzzsWIDvFPavZpjqMBSjRTurQLFahAaGmdY0BX/Ii+s2+OxfaHQIa1lgucm0P7GPKeZvLX/8boO01Onr/87ra+NX7ABvQb+SXvwsg+Bm5CziWB6DMKDKRD/KQjHxpjIY35UwSEW7G4ixux7ufizXttthHfPJWd/rWFhfYigFhVLgIPCR12smwFVuZwM7ujvY2CIM0X4E0dsX9uVHkgYmqRIdNf5vshpmRuIcHsXZpTJP/tD7zQM6m214c5xkJSfAVIaD7WzRYS4eVL+R3z4u+6n5p6FjuWSjSzuEffUai3HCWjes4JbtDSjIwoG0tOMtBukgPbreH+pjXcvnhU+1QhCV2aIdG6C3FmaI5Uoo/mthJyiFAThwtOpxQ5YkdsRunqVVEFYZfMNEn4Ig2clCFrLOm46JB2wPcLGP2MoH5RqajYzQ6IV8IXIFQVzG0C7HoHsBkVp+GrpnH6N0FCKR+fpbGjigM2lLf4pYBhChUY4ao9hvV1hd8ikS6QoasvDLPytBBa1YAwbSa8d7YdwO6fXfQqetfS8S9gbHD0zxazw5p9Lp5fXFmajDNkD2voYNMzOHJMMHG/49pWV2",
"type": [
"string",
"null"
]
}
},
"required": [
"evp_id",
"create_date",
"vetted_date",
"vetting_id",
"vetting_token",
"vetting_score",
"vetting_class",
"vetting_status",
"reasons"
],
"title": "TenDlcBrandVetting",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of external vettings for a 10DLC Brand.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "B6AI7PA",
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "ten_dlc_brand_vettings_list",
"outputSchema": {
"properties": {
"result": {
"items": {
"additionalProperties": false,
"properties": {
"create_date": {
"description": "The date and time the vetting request is created",
"example": "2024-08-01T14:09:43",
"type": "string"
},
"evp_id": {
"description": "External vetting provider code",
"example": "AEGIS",
"type": "string"
},
"reasons": {
"description": "Reason",
"example": [
"Company size as reported by government or business sources resulted in a score deduction: size range 6-10"
],
"items": {
"type": "string"
},
"type": [
"array",
"null"
]
},
"vetted_date": {
"description": "The date and time the vetting request is competed",
"example": "2024-08-01T14:09:43",
"type": [
"string",
"null"
]
},
"vetting_class": {
"description": "The vetting class",
"example": "STANDARD",
"type": "string"
},
"vetting_details": {
"additionalProperties": true,
"description": "Additional details of the vetting request",
"example": {
"additional_prop1": {},
"additional_prop2": {},
"additional_prop3": {}
},
"type": "object"
},
"vetting_id": {
"description": "Unique identifier of the vetting request",
"example": "13d8e00c-3cb4-4dc0-9e26-d5057fa938d9",
"type": "string"
},
"vetting_score": {
"description": "The assigned Brand vetting score",
"example": 80,
"format": "int32",
"type": [
"integer",
"null"
]
},
"vetting_status": {
"description": "Status of the vetting request",
"example": "PENDING",
"type": "string"
},
"vetting_token": {
"description": "Unique vetting token",
"example": "3oDcE1vq8OR43claMa6Thu/7V4vzZywAfKRgiJnXDjlw+08wpWbGqOssAXKgeZibHCLaGgXvU/yPb7kISeeb5qGdisGRLdhPnSNpvRR82RnCWYNpTp92orlJWjTJU8ZGmNxL5MwK0tt/9SxCha36iTtPV2+4vND8xCPe5suItuQTonG4A3Yi6F1LMqihgwdesRjxJnKqcE7Thcv9ug1NyNPYEZQvPugFj2F2DdU6jFZcOWgXsnE7ucZ+xNaNX9LkF9if3v0hrcviG9L8bUUrpPBGr02txP0i+cPBTLbj4Rq1Ox83R+WUx1gnoXHCIU1ByDGWvQq2Ef4qxGVOwPJHJbja1BovxKBk4YJxiz8OSO68QAIEfxuPTpj5eZz7KEFtFmBIVaVmxBDe4b8Tpl01C2rek7xgPzXaoURvh7CQVnVmJL00DTWKvyOmUOQQW901XEcgcJ7VWgfIvxhIMuXEXXtVDGNowmEc9JQXXYHVlGuN5QicSbApkwwqRZI7TQ4lsS66zCfqomIIJyBNRJpl+8sGwsa2J2h6fEkAD77J9zdUgIKXMFamHbvRadCKMZNIbMrkOC7PuOjZdSiWKh5A8FSjzkv3PlN2hRDqkaODEoodp5pTQeBtNe37+uAMOuHNfsZXlwvfMgCZjiZJ9HQNSLhJBUq7/IvT/EzszUk4HPTj/WFSbT1YrrkDi+zrB20ZDY9lZFWxN1hlYQoNcanDAAWPmw/yW1+8DroL5WIMGsXX3WFGOG7eWB1GHgFQsziAeRQl78u1qOvsRMN08+GrkASBJwqwy5l7xCesUKqbz3O0QA/dwzzsWIDvFPavZpjqMBSjRTurQLFahAaGmdY0BX/Ii+s2+OxfaHQIa1lgucm0P7GPKeZvLX/8boO01Onr/87ra+NX7ABvQb+SXvwsg+Bm5CziWB6DMKDKRD/KQjHxpjIY35UwSEW7G4ixux7ufizXttthHfPJWd/rWFhfYigFhVLgIPCR12smwFVuZwM7ujvY2CIM0X4E0dsX9uVHkgYmqRIdNf5vshpmRuIcHsXZpTJP/tD7zQM6m214c5xkJSfAVIaD7WzRYS4eVL+R3z4u+6n5p6FjuWSjSzuEffUai3HCWjes4JbtDSjIwoG0tOMtBukgPbreH+pjXcvnhU+1QhCV2aIdG6C3FmaI5Uoo/mthJyiFAThwtOpxQ5YkdsRunqVVEFYZfMNEn4Ig2clCFrLOm46JB2wPcLGP2MoH5RqajYzQ6IV8IXIFQVzG0C7HoHsBkVp+GrpnH6N0FCKR+fpbGjigM2lLf4pYBhChUY4ao9hvV1hd8ikS6QoasvDLPytBBa1YAwbSa8d7YdwO6fXfQqetfS8S9gbHD0zxazw5p9Lp5fXFmajDNkD2voYNMzOHJMMHG/49pWV2",
"type": [
"string",
"null"
]
}
},
"required": [
"evp_id",
"create_date",
"vetted_date",
"vetting_id",
"vetting_token",
"vetting_score",
"vetting_class",
"vetting_status",
"reasons"
],
"title": "TenDlcBrandVetting",
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Registers a 10DLC Brand. TCR automatically verifies the brand identity. Only brands with `VERIFIED` or `VETTED_VERIFIED` identity status can register 10DLC Campaigns.",
"inputSchema": {
"properties": {
"city": {
"description": "The city name",
"example": "Miami",
"maxLength": 100,
"type": "string"
},
"company_name": {
"description": "Legal name of the company",
"example": "Company",
"maxLength": 255,
"type": "string"
},
"country": {
"description": "2-letter ISO country code the business address",
"example": "US",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"dba_name": {
"description": "Brand name or DBA",
"example": "Brand",
"maxLength": 255,
"type": "string"
},
"ein_taxid": {
"description": "IRS Employee Identification Number (EIN) for US-based or foreign companies with EIN. The numeric portion of Tax ID for companies incorporated in other countries.",
"example": "12-2142342",
"maxLength": 21,
"type": "string"
},
"ein_taxid_country": {
"description": "2-letter ISO country code of the Tax ID issuing country",
"example": "US",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"email": {
"description": "The email address of the support contact",
"example": "[email protected]",
"format": "email",
"maxLength": 100,
"type": "string"
},
"entity_type": {
"description": "The company entity type",
"enum": [
"PRIVATE_PROFIT",
"PUBLIC_PROFIT",
"NON_PROFIT",
"GOVERNMENT"
],
"example": "PUBLIC_PROFIT",
"type": "string"
},
"first_name": {
"description": "The first name of the business contact",
"example": "John",
"maxLength": 100,
"type": "string"
},
"last_name": {
"description": "The last name of the business contact",
"example": "Dow",
"maxLength": 100,
"type": "string"
},
"mock": {
"default": false,
"description": "Indicates a mock Brand. You can create mock Brands for testing purposes only, production traffic with the mock Brands is prohibited.",
"example": false,
"type": "boolean"
},
"phone_number": {
"description": "The support contact telephone in E.164 format",
"example": "12046661776",
"maxLength": 20,
"type": "string"
},
"state_or_province": {
"description": "State or province. For the United States, use 2 character codes.",
"example": "AL",
"maxLength": 20,
"type": [
"string",
"null"
]
},
"stock_exchange": {
"description": "The stock exchange code. For PUBLIC_PROFIT Brands only.",
"example": "NASDAQ",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"stock_symbol": {
"description": "The stock symbol of the Brand. For PUBLIC_PROFIT Brands only.",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"street_address": {
"description": "Street name and house number",
"example": "10, City Name",
"maxLength": 100,
"type": "string"
},
"vertical": {
"description": "The segment the business operates in",
"enum": [
"HEALTHCARE",
"PROFESSIONAL",
"RETAIL",
"TECHNOLOGY",
"EDUCATION",
"FINANCIAL",
"NON_PROFIT",
"GOVERNMENT",
"OTHER"
],
"example": "PROFESSIONAL",
"type": "string"
},
"website": {
"description": "The website of the business",
"example": "Tess.com",
"maxLength": 255,
"type": "string"
},
"zip": {
"description": "The business zip or postal code",
"example": "12345",
"maxLength": 10,
"type": "string"
}
},
"required": [
"dba_name",
"company_name",
"entity_type",
"vertical",
"ein_taxid",
"ein_taxid_country",
"first_name",
"last_name",
"phone_number",
"email",
"street_address",
"city",
"state_or_province",
"country",
"zip"
],
"type": "object"
},
"name": "ten_dlc_brands_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"description": "10DLC brand details.",
"example": {
"brand_id": "BM20QP9",
"city": "Miami",
"company_name": "Company legal name",
"country": "US",
"created_at": "2024-07-24T08:10:49",
"dba_name": "New Brand",
"ein_taxid": "12345",
"ein_taxid_country": "US",
"email": "[email protected]",
"entity_type": "PRIVATE_PROFIT",
"feedback": null,
"first_name": "John",
"last_name": "Dow",
"mock": false,
"phone_number": "12123450099",
"state_or_province": "FL",
"status": "VERIFIED",
"stock_exchange": null,
"stock_symbol": null,
"street_address": "10, Street name",
"updated_at": "2024-07-24T08:29:09",
"vertical": "HEALTHCARE",
"website": "https://brand.com",
"zip": "12345"
},
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"city": {
"description": "City name.",
"example": "Miami",
"type": "string"
},
"company_name": {
"description": "Company legal name.",
"example": "Company",
"type": "string"
},
"country": {
"description": "ISO 3166-1 alpha-2 country code of the business address.",
"example": "US",
"type": "string"
},
"created_at": {
"description": "Date and time the Brand was created in ISO 8601 format.",
"example": "2024-07-24T08:29:09",
"type": "string"
},
"dba_name": {
"description": "Brand name or DBA.",
"example": "Brand",
"type": "string"
},
"ein_taxid": {
"description": "IRS EIN or Tax ID.",
"example": "999999999",
"type": "string"
},
"ein_taxid_country": {
"description": "ISO 3166-1 alpha-2 country code where the Tax ID was issued.",
"example": "US",
"type": "string"
},
"email": {
"description": "Support contact email address.",
"example": "[email protected]",
"type": "string"
},
"entity_type": {
"allOf": [
{
"description": "Brand entity type",
"enum": [
"PRIVATE_PROFIT",
"PUBLIC_PROFIT",
"NON_PROFIT",
"GOVERNMENT"
],
"example": "PRIVATE_PROFIT",
"title": "TenDlcBrandEntityType",
"type": "string"
},
{
"description": "Company entity type.",
"example": "PRIVATE_PROFIT"
}
]
},
"feedback": {
"description": "Brand identity verification feedback.",
"type": [
"string",
"null"
]
},
"first_name": {
"description": "Business contact first name.",
"example": "John",
"type": "string"
},
"last_name": {
"description": "Business contact last name.",
"example": "Dow",
"type": "string"
},
"mock": {
"default": false,
"description": "Indicates whether the Brand is a mock brand for testing.",
"example": false,
"type": "boolean"
},
"phone_number": {
"description": "Support contact phone number in E.164 format.",
"example": "12123450099",
"type": "string"
},
"state_or_province": {
"description": "State or province.",
"example": "FL",
"type": [
"string",
"null"
]
},
"status": {
"allOf": [
{
"description": "10DLC Brand Identity verification status",
"enum": [
"REVIEW",
"VERIFIED",
"UNVERIFIED",
"VETTED_VERIFIED",
"SUSPENDED"
],
"title": "TenDlcBrandIdentityVerificationStatus",
"type": "string"
},
{
"description": "Brand identity verification status.",
"example": "VERIFIED"
}
]
},
"stock_exchange": {
"description": "Stock exchange code. Required for public companies.",
"type": [
"string",
"null"
]
},
"stock_symbol": {
"description": "Stock symbol. Required for public companies.",
"type": [
"string",
"null"
]
},
"street_address": {
"description": "Street address.",
"example": "10, City Name",
"type": "string"
},
"updated_at": {
"description": "Date and time the Brand was updated in ISO 8601 format.",
"example": "2024-07-24T08:29:09",
"type": "string"
},
"vertical": {
"description": "Business vertical.",
"example": "HEALTHCARE",
"type": "string"
},
"website": {
"description": "Business website URL.",
"example": "https://brand.com",
"type": [
"string",
"null"
]
},
"zip": {
"description": "Zip or postal code.",
"example": "12345",
"type": "string"
}
},
"required": [
"brand_id",
"dba_name",
"company_name",
"entity_type",
"vertical",
"ein_taxid",
"ein_taxid_country",
"status",
"first_name",
"last_name",
"phone_number",
"email",
"street_address",
"city",
"country",
"zip",
"feedback",
"created_at",
"updated_at"
],
"title": "TenDlcBrand",
"type": "object"
},
{
"example": {
"brand_id": "BM20QP9",
"city": "Miami",
"company_name": "Company legal name",
"country": "US",
"created_at": "2024-07-24T08:10:49",
"dba_name": "New Brand",
"ein_taxid": "99999999",
"ein_taxid_country": "US",
"email": "[email protected]",
"entity_type": "PRIVATE_PROFIT",
"feedback": null,
"first_name": "John",
"last_name": "Dow",
"mock": false,
"phone_number": "12123450099",
"state_or_province": "FL",
"status": "REVIEW",
"stock_exchange": null,
"stock_symbol": null,
"street_address": "10, Street Name",
"updated_at": "2024-07-24T08:10:49",
"vertical": "HEALTHCARE",
"website": "https://brand.com",
"zip": "12345"
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Deletes a 10DLC Brand. Brands with active campaigns cannot be deleted.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "ten_dlc_brands_delete",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a 10DLC Brand.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "ten_dlc_brands_get",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"description": "10DLC brand details.",
"example": {
"brand_id": "BM20QP9",
"city": "Miami",
"company_name": "Company legal name",
"country": "US",
"created_at": "2024-07-24T08:10:49",
"dba_name": "New Brand",
"ein_taxid": "12345",
"ein_taxid_country": "US",
"email": "[email protected]",
"entity_type": "PRIVATE_PROFIT",
"feedback": null,
"first_name": "John",
"last_name": "Dow",
"mock": false,
"phone_number": "12123450099",
"state_or_province": "FL",
"status": "VERIFIED",
"stock_exchange": null,
"stock_symbol": null,
"street_address": "10, Street name",
"updated_at": "2024-07-24T08:29:09",
"vertical": "HEALTHCARE",
"website": "https://brand.com",
"zip": "12345"
},
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"city": {
"description": "City name.",
"example": "Miami",
"type": "string"
},
"company_name": {
"description": "Company legal name.",
"example": "Company",
"type": "string"
},
"country": {
"description": "ISO 3166-1 alpha-2 country code of the business address.",
"example": "US",
"type": "string"
},
"created_at": {
"description": "Date and time the Brand was created in ISO 8601 format.",
"example": "2024-07-24T08:29:09",
"type": "string"
},
"dba_name": {
"description": "Brand name or DBA.",
"example": "Brand",
"type": "string"
},
"ein_taxid": {
"description": "IRS EIN or Tax ID.",
"example": "999999999",
"type": "string"
},
"ein_taxid_country": {
"description": "ISO 3166-1 alpha-2 country code where the Tax ID was issued.",
"example": "US",
"type": "string"
},
"email": {
"description": "Support contact email address.",
"example": "[email protected]",
"type": "string"
},
"entity_type": {
"allOf": [
{
"description": "Brand entity type",
"enum": [
"PRIVATE_PROFIT",
"PUBLIC_PROFIT",
"NON_PROFIT",
"GOVERNMENT"
],
"example": "PRIVATE_PROFIT",
"title": "TenDlcBrandEntityType",
"type": "string"
},
{
"description": "Company entity type.",
"example": "PRIVATE_PROFIT"
}
]
},
"feedback": {
"description": "Brand identity verification feedback.",
"type": [
"string",
"null"
]
},
"first_name": {
"description": "Business contact first name.",
"example": "John",
"type": "string"
},
"last_name": {
"description": "Business contact last name.",
"example": "Dow",
"type": "string"
},
"mock": {
"default": false,
"description": "Indicates whether the Brand is a mock brand for testing.",
"example": false,
"type": "boolean"
},
"phone_number": {
"description": "Support contact phone number in E.164 format.",
"example": "12123450099",
"type": "string"
},
"state_or_province": {
"description": "State or province.",
"example": "FL",
"type": [
"string",
"null"
]
},
"status": {
"allOf": [
{
"description": "10DLC Brand Identity verification status",
"enum": [
"REVIEW",
"VERIFIED",
"UNVERIFIED",
"VETTED_VERIFIED",
"SUSPENDED"
],
"title": "TenDlcBrandIdentityVerificationStatus",
"type": "string"
},
{
"description": "Brand identity verification status.",
"example": "VERIFIED"
}
]
},
"stock_exchange": {
"description": "Stock exchange code. Required for public companies.",
"type": [
"string",
"null"
]
},
"stock_symbol": {
"description": "Stock symbol. Required for public companies.",
"type": [
"string",
"null"
]
},
"street_address": {
"description": "Street address.",
"example": "10, City Name",
"type": "string"
},
"updated_at": {
"description": "Date and time the Brand was updated in ISO 8601 format.",
"example": "2024-07-24T08:29:09",
"type": "string"
},
"vertical": {
"description": "Business vertical.",
"example": "HEALTHCARE",
"type": "string"
},
"website": {
"description": "Business website URL.",
"example": "https://brand.com",
"type": [
"string",
"null"
]
},
"zip": {
"description": "Zip or postal code.",
"example": "12345",
"type": "string"
}
},
"required": [
"brand_id",
"dba_name",
"company_name",
"entity_type",
"vertical",
"ein_taxid",
"ein_taxid_country",
"status",
"first_name",
"last_name",
"phone_number",
"email",
"street_address",
"city",
"country",
"zip",
"feedback",
"created_at",
"updated_at"
],
"title": "TenDlcBrand",
"type": "object"
},
{
"example": {
"brand_id": "BM20QP9",
"city": "Miami",
"company_name": "Company legal name",
"country": "US",
"created_at": "2024-07-24T08:10:49",
"dba_name": "New Brand",
"ein_taxid": "99999999",
"ein_taxid_country": "US",
"email": "[email protected]",
"entity_type": "PRIVATE_PROFIT",
"feedback": null,
"first_name": "John",
"last_name": "Dow",
"mock": false,
"phone_number": "12123450099",
"state_or_province": "FL",
"status": "VERIFIED",
"stock_exchange": null,
"stock_symbol": null,
"street_address": "10, Street Name",
"updated_at": "2024-07-24T08:29:09",
"vertical": "HEALTHCARE",
"website": "https://brand.com",
"zip": "12345"
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a paginated list of 10DLC brands. Filter results by date, name, legal name, and status. Results are limited to 25 records per page by default. Use `page` and `per_page` to navigate results.",
"inputSchema": {
"properties": {
"company_name": {
"description": "Company legal name.",
"example": "Company",
"type": "string"
},
"country": {
"description": "Brand registration country.",
"example": "US",
"type": "string"
},
"created_after": {
"description": "Brand creation start date in `YYYY-MM-DD` format.",
"example": "2024-08-22",
"type": "string"
},
"created_before": {
"description": "Brand creation end date in `YYYY-MM-DD` format.",
"example": "2024-08-22",
"type": "string"
},
"dba_name": {
"description": "Brand name.",
"example": "Brand",
"type": "string"
},
"ein_taxid": {
"description": "EIN/Tax ID.",
"example": "999999999",
"type": "string"
},
"entity_type": {
"description": "Business entity type.",
"example": "PRIVATE_PROFIT",
"type": "string"
},
"mock": {
"default": false,
"description": "Indicates whether to include mock brands only.",
"example": false,
"type": "boolean"
},
"page": {
"description": "Page number.",
"example": 1,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"show_deleted": {
"default": false,
"description": "Indicates whether to include deleted brands.",
"example": false,
"type": "boolean"
},
"status": {
"description": "Brand identity verification status.",
"example": "VERIFIED",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "ten_dlc_brands_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"description": "A list of 10DLC Brands",
"example": {
"items": [
{
"brand_id": "BM20QP9",
"city": "Miami",
"company_name": "Company legal name",
"country": "US",
"created_at": "2024-07-24T08:10:49",
"dba_name": "New Brand",
"ein_taxid": "12345",
"ein_taxid_country": "US",
"email": "[email protected]",
"entity_type": "PRIVATE_PROFIT",
"feedback": null,
"first_name": "John",
"last_name": "Dow",
"mock": false,
"phone_number": "12123450099",
"state_or_province": "FL",
"status": "VERIFIED",
"stock_exchange": null,
"stock_symbol": null,
"street_address": "10, Street name",
"updated_at": "2024-07-24T08:29:09",
"vertical": "HEALTHCARE",
"website": "https://brand.com",
"zip": "12345"
}
],
"pagination": {
"current_page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
}
},
"properties": {
"items": {
"description": "A paginated list of 10DLC Brands matching the filter criteria",
"items": {
"additionalProperties": false,
"description": "10DLC brand details.",
"example": {
"brand_id": "BM20QP9",
"city": "Miami",
"company_name": "Company legal name",
"country": "US",
"created_at": "2024-07-24T08:10:49",
"dba_name": "New Brand",
"ein_taxid": "12345",
"ein_taxid_country": "US",
"email": "[email protected]",
"entity_type": "PRIVATE_PROFIT",
"feedback": null,
"first_name": "John",
"last_name": "Dow",
"mock": false,
"phone_number": "12123450099",
"state_or_province": "FL",
"status": "VERIFIED",
"stock_exchange": null,
"stock_symbol": null,
"street_address": "10, Street name",
"updated_at": "2024-07-24T08:29:09",
"vertical": "HEALTHCARE",
"website": "https://brand.com",
"zip": "12345"
},
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"city": {
"description": "City name.",
"example": "Miami",
"type": "string"
},
"company_name": {
"description": "Company legal name.",
"example": "Company",
"type": "string"
},
"country": {
"description": "ISO 3166-1 alpha-2 country code of the business address.",
"example": "US",
"type": "string"
},
"created_at": {
"description": "Date and time the Brand was created in ISO 8601 format.",
"example": "2024-07-24T08:29:09",
"type": "string"
},
"dba_name": {
"description": "Brand name or DBA.",
"example": "Brand",
"type": "string"
},
"ein_taxid": {
"description": "IRS EIN or Tax ID.",
"example": "999999999",
"type": "string"
},
"ein_taxid_country": {
"description": "ISO 3166-1 alpha-2 country code where the Tax ID was issued.",
"example": "US",
"type": "string"
},
"email": {
"description": "Support contact email address.",
"example": "[email protected]",
"type": "string"
},
"entity_type": {
"allOf": [
{
"description": "Brand entity type",
"enum": [
"PRIVATE_PROFIT",
"PUBLIC_PROFIT",
"NON_PROFIT",
"GOVERNMENT"
],
"example": "PRIVATE_PROFIT",
"title": "TenDlcBrandEntityType",
"type": "string"
},
{
"description": "Company entity type.",
"example": "PRIVATE_PROFIT"
}
]
},
"feedback": {
"description": "Brand identity verification feedback.",
"type": [
"string",
"null"
]
},
"first_name": {
"description": "Business contact first name.",
"example": "John",
"type": "string"
},
"last_name": {
"description": "Business contact last name.",
"example": "Dow",
"type": "string"
},
"mock": {
"default": false,
"description": "Indicates whether the Brand is a mock brand for testing.",
"example": false,
"type": "boolean"
},
"phone_number": {
"description": "Support contact phone number in E.164 format.",
"example": "12123450099",
"type": "string"
},
"state_or_province": {
"description": "State or province.",
"example": "FL",
"type": [
"string",
"null"
]
},
"status": {
"allOf": [
{
"description": "10DLC Brand Identity verification status",
"enum": [
"REVIEW",
"VERIFIED",
"UNVERIFIED",
"VETTED_VERIFIED",
"SUSPENDED"
],
"title": "TenDlcBrandIdentityVerificationStatus",
"type": "string"
},
{
"description": "Brand identity verification status.",
"example": "VERIFIED"
}
]
},
"stock_exchange": {
"description": "Stock exchange code. Required for public companies.",
"type": [
"string",
"null"
]
},
"stock_symbol": {
"description": "Stock symbol. Required for public companies.",
"type": [
"string",
"null"
]
},
"street_address": {
"description": "Street address.",
"example": "10, City Name",
"type": "string"
},
"updated_at": {
"description": "Date and time the Brand was updated in ISO 8601 format.",
"example": "2024-07-24T08:29:09",
"type": "string"
},
"vertical": {
"description": "Business vertical.",
"example": "HEALTHCARE",
"type": "string"
},
"website": {
"description": "Business website URL.",
"example": "https://brand.com",
"type": [
"string",
"null"
]
},
"zip": {
"description": "Zip or postal code.",
"example": "12345",
"type": "string"
}
},
"required": [
"brand_id",
"dba_name",
"company_name",
"entity_type",
"vertical",
"ein_taxid",
"ein_taxid_country",
"status",
"first_name",
"last_name",
"phone_number",
"email",
"street_address",
"city",
"country",
"zip",
"feedback",
"created_at",
"updated_at"
],
"title": "TenDlcBrand",
"type": "object"
},
"type": "array"
},
"pagination": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
},
{
"description": "Pagination details"
}
]
}
},
"required": [
"items",
"pagination"
],
"title": "TenDlcBrandListResponse",
"type": "object"
},
{
"example": {
"items": [
{
"brand_id": "BM20QP9",
"city": "Miami",
"company_name": "Company legal name",
"country": "US",
"created_at": "2024-07-24T08:10:49",
"dba_name": "New Brand",
"ein_taxid": "999999999",
"ein_taxid_country": "US",
"email": "[email protected]",
"entity_type": "PRIVATE_PROFIT",
"feedback": null,
"first_name": "John",
"last_name": "Dow",
"mock": false,
"phone_number": "12123450099",
"state_or_province": "FL",
"status": "VERIFIED",
"stock_exchange": null,
"stock_symbol": null,
"street_address": "10, Street Name",
"updated_at": "2024-07-24T08:29:09",
"vertical": "HEALTHCARE",
"website": "https://brand.com",
"zip": "12345"
}
],
"pagination": {
"current_page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
}
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Updates a 10DLC brand. Updating identity-related parameters, including `ein_taxid`, `ein_taxid_country`, and `entity_type`, resets the Brand status to `UNVERIFIED` and triggers automatic re-submission. Brands in `VETTED_VERIFIED` status or with active Campaigns cannot be updated.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"city": {
"description": "The city name",
"example": "Miami",
"maxLength": 100,
"type": "string"
},
"company_name": {
"description": "Legal name of the company",
"example": "Company",
"maxLength": 255,
"type": "string"
},
"country": {
"description": "2-letter ISO country code the business address",
"example": "US",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"dba_name": {
"description": "Brand name or DBA",
"example": "Brand",
"maxLength": 255,
"type": "string"
},
"ein_taxid": {
"description": "IRS Employee Identification Number (EIN) for US-based or foreign companies with EIN. The numeric portion of Tax ID for companies incorporated in other countries.",
"example": "999999999",
"maxLength": 21,
"type": "string"
},
"ein_taxid_country": {
"description": "2-letter ISO country code of the Tax ID issuing country",
"example": "US",
"maxLength": 2,
"minLength": 2,
"type": "string"
},
"email": {
"description": "The email address of the support contact",
"example": "[email protected]",
"format": "email",
"maxLength": 100,
"type": "string"
},
"entity_type": {
"description": "The company entity type",
"enum": [
"PRIVATE_PROFIT",
"PUBLIC_PROFIT",
"NON_PROFIT",
"GOVERNMENT"
],
"example": "PRIVATE_PROFIT",
"type": "string"
},
"first_name": {
"description": "The first name of the business contact",
"example": "John",
"maxLength": 100,
"type": "string"
},
"last_name": {
"description": "The last name of the business contact",
"example": "Dow",
"maxLength": 100,
"type": "string"
},
"mock": {
"default": false,
"description": "Mock flag for testing (optional, defaults to false)",
"example": false,
"type": "boolean"
},
"phone_number": {
"description": "The support contact telephone in E.164 format",
"example": "12123450099",
"maxLength": 20,
"type": "string"
},
"state_or_province": {
"description": "State or province. For the United States, use 2 character codes.",
"example": "FL",
"maxLength": 20,
"type": [
"string",
"null"
]
},
"stock_exchange": {
"description": "The stock exchange code. For PUBLIC_PROFIT Brands only.",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"stock_symbol": {
"description": "The stock symbol of the Brand. For PUBLIC_PROFIT Brands only.",
"maxLength": 10,
"type": [
"string",
"null"
]
},
"street_address": {
"description": "Street name and house number",
"example": "10, City Name",
"maxLength": 100,
"type": "string"
},
"vertical": {
"description": "The segment the business operates in",
"enum": [
"HEALTHCARE",
"PROFESSIONAL",
"RETAIL",
"TECHNOLOGY",
"EDUCATION",
"FINANCIAL",
"NON_PROFIT",
"GOVERNMENT",
"OTHER"
],
"example": "HEALTHCARE",
"type": "string"
},
"website": {
"description": "The website of the business",
"example": "https://brand.com",
"maxLength": 255,
"type": "string"
},
"zip": {
"description": "The business zip or postal code",
"example": "12346",
"maxLength": 10,
"type": "string"
}
},
"required": [
"brand_id"
],
"type": "object"
},
"name": "ten_dlc_brands_update",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"description": "10DLC brand details.",
"example": {
"brand_id": "BM20QP9",
"city": "Miami",
"company_name": "Company legal name",
"country": "US",
"created_at": "2024-07-24T08:10:49",
"dba_name": "New Brand",
"ein_taxid": "12345",
"ein_taxid_country": "US",
"email": "[email protected]",
"entity_type": "PRIVATE_PROFIT",
"feedback": null,
"first_name": "John",
"last_name": "Dow",
"mock": false,
"phone_number": "12123450099",
"state_or_province": "FL",
"status": "VERIFIED",
"stock_exchange": null,
"stock_symbol": null,
"street_address": "10, Street name",
"updated_at": "2024-07-24T08:29:09",
"vertical": "HEALTHCARE",
"website": "https://brand.com",
"zip": "12345"
},
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"city": {
"description": "City name.",
"example": "Miami",
"type": "string"
},
"company_name": {
"description": "Company legal name.",
"example": "Company",
"type": "string"
},
"country": {
"description": "ISO 3166-1 alpha-2 country code of the business address.",
"example": "US",
"type": "string"
},
"created_at": {
"description": "Date and time the Brand was created in ISO 8601 format.",
"example": "2024-07-24T08:29:09",
"type": "string"
},
"dba_name": {
"description": "Brand name or DBA.",
"example": "Brand",
"type": "string"
},
"ein_taxid": {
"description": "IRS EIN or Tax ID.",
"example": "999999999",
"type": "string"
},
"ein_taxid_country": {
"description": "ISO 3166-1 alpha-2 country code where the Tax ID was issued.",
"example": "US",
"type": "string"
},
"email": {
"description": "Support contact email address.",
"example": "[email protected]",
"type": "string"
},
"entity_type": {
"allOf": [
{
"description": "Brand entity type",
"enum": [
"PRIVATE_PROFIT",
"PUBLIC_PROFIT",
"NON_PROFIT",
"GOVERNMENT"
],
"example": "PRIVATE_PROFIT",
"title": "TenDlcBrandEntityType",
"type": "string"
},
{
"description": "Company entity type.",
"example": "PRIVATE_PROFIT"
}
]
},
"feedback": {
"description": "Brand identity verification feedback.",
"type": [
"string",
"null"
]
},
"first_name": {
"description": "Business contact first name.",
"example": "John",
"type": "string"
},
"last_name": {
"description": "Business contact last name.",
"example": "Dow",
"type": "string"
},
"mock": {
"default": false,
"description": "Indicates whether the Brand is a mock brand for testing.",
"example": false,
"type": "boolean"
},
"phone_number": {
"description": "Support contact phone number in E.164 format.",
"example": "12123450099",
"type": "string"
},
"state_or_province": {
"description": "State or province.",
"example": "FL",
"type": [
"string",
"null"
]
},
"status": {
"allOf": [
{
"description": "10DLC Brand Identity verification status",
"enum": [
"REVIEW",
"VERIFIED",
"UNVERIFIED",
"VETTED_VERIFIED",
"SUSPENDED"
],
"title": "TenDlcBrandIdentityVerificationStatus",
"type": "string"
},
{
"description": "Brand identity verification status.",
"example": "VERIFIED"
}
]
},
"stock_exchange": {
"description": "Stock exchange code. Required for public companies.",
"type": [
"string",
"null"
]
},
"stock_symbol": {
"description": "Stock symbol. Required for public companies.",
"type": [
"string",
"null"
]
},
"street_address": {
"description": "Street address.",
"example": "10, City Name",
"type": "string"
},
"updated_at": {
"description": "Date and time the Brand was updated in ISO 8601 format.",
"example": "2024-07-24T08:29:09",
"type": "string"
},
"vertical": {
"description": "Business vertical.",
"example": "HEALTHCARE",
"type": "string"
},
"website": {
"description": "Business website URL.",
"example": "https://brand.com",
"type": [
"string",
"null"
]
},
"zip": {
"description": "Zip or postal code.",
"example": "12345",
"type": "string"
}
},
"required": [
"brand_id",
"dba_name",
"company_name",
"entity_type",
"vertical",
"ein_taxid",
"ein_taxid_country",
"status",
"first_name",
"last_name",
"phone_number",
"email",
"street_address",
"city",
"country",
"zip",
"feedback",
"created_at",
"updated_at"
],
"title": "TenDlcBrand",
"type": "object"
},
{
"example": {
"brand_id": "BM20QP9",
"city": "Miami",
"company_name": "Company legal name",
"country": "US",
"created_at": "2024-07-24T08:10:49",
"dba_name": "New Brand",
"ein_taxid": "99999999",
"ein_taxid_country": "US",
"email": "[email protected]",
"entity_type": "PRIVATE_PROFIT",
"feedback": null,
"first_name": "John",
"last_name": "Dow",
"mock": false,
"phone_number": "12123450099",
"state_or_province": "FL",
"status": "REVIEW",
"stock_exchange": null,
"stock_symbol": null,
"street_address": "10, Street Name",
"updated_at": "2024-07-24T09:02:19",
"vertical": "HEALTHCARE",
"website": "https://brand.com",
"zip": "12345"
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Links a phone number to a 10DLC Campaign. Wavix automatically creates a Sender ID once the number is approved.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "B9FXYNH",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CSJ4TV0",
"type": "string"
},
"number": {
"description": "Phone number to associate with the Campaign.",
"example": "17029641104",
"type": "string"
}
},
"required": [
"brand_id",
"campaign_id",
"number"
],
"type": "object"
},
"name": "ten_dlc_campaign_numbers_link",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of phone numbers associated with a 10DLC Campaign.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "B9FXYNH",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CSJ4TV0",
"type": "string"
}
},
"required": [
"brand_id",
"campaign_id"
],
"type": "object"
},
"name": "ten_dlc_campaign_numbers_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"brand_id": {
"description": "Unique identifier of a 10DLC Brand",
"type": "string"
},
"campaign_id": {
"description": "Unique identifier of a 10DLC Campaign",
"type": "string"
},
"numbers": {
"description": "A list of phone numbers associated with the Campaign",
"items": {
"additionalProperties": false,
"properties": {
"number": {
"description": "A phone number associated with a 10DLC Campaign",
"example": "17029641104",
"type": "string"
},
"status": {
"description": "The number provisioning status. Only `APPROVED` numbers can be used as Sender IDs.",
"example": "APPROVED",
"type": "string"
}
},
"required": [
"number",
"status"
],
"title": "TenDlcCampaignNumber",
"type": "object"
},
"type": "array"
}
},
"required": [
"brand_id",
"campaign_id",
"numbers"
],
"title": "TenDlcCampaignNumberListResponse",
"type": "object"
},
{
"example": {
"brand_id": "B9FXYNH",
"campaign_id": "CSJ4TV0",
"numbers": [
{
"number": "17029641104",
"status": "APPROVED"
}
]
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Unlinks a phone number from a 10DLC Campaign. The associated Sender ID is also deleted.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "B9FXYNH",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CSJ4TV0",
"type": "string"
},
"number": {
"description": "Phone number to unlink.",
"example": "17029641104",
"type": "string"
}
},
"required": [
"brand_id",
"campaign_id",
"number"
],
"type": "object"
},
"name": "ten_dlc_campaign_numbers_unlink",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a paginated list of 10DLC Campaigns. Filter results by date, status, and use case. Results are limited to 25 records per page by default. Use `page` and `per_page` to navigate results.",
"inputSchema": {
"properties": {
"created_after": {
"description": "Campaign creation start date in `YYYY-MM-DD` format.",
"example": "2024-08-22",
"format": "date",
"type": "string"
},
"created_before": {
"description": "Campaign creation end date in `YYYY-MM-DD` format.",
"example": "2024-08-22",
"format": "date",
"type": "string"
},
"mock": {
"default": false,
"description": "Indicates whether to include mock 10DLC Campaigns only.",
"example": true,
"type": "boolean"
},
"name": {
"description": "Campaign name.",
"example": "Name",
"type": "string"
},
"page": {
"description": "Page number to retrieve.",
"example": 1,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"status": {
"description": "Campaign status.",
"example": "APPROVED",
"type": "string"
},
"usecase": {
"description": "Use case.",
"example": "2FA",
"type": "string"
}
},
"required": [],
"type": "object"
},
"name": "ten_dlc_campaigns_list",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"description": "A list of 10DLC Campaigns",
"example": {
"items": [
{
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [
"14358684439",
"13193337776",
"12673296046"
],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
}
],
"pagination": {
"current_page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
}
},
"properties": {
"items": {
"description": "A paginated list of 10DLC Campaign matching the filter criteria",
"items": {
"additionalProperties": false,
"description": "10DLC campaign details.",
"example": {
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [
"14358684439",
"13193337776",
"12673296046"
],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
},
"properties": {
"affiliate_marketing": {
"description": "Indicates whether the Campaign is used for affiliate marketing.",
"example": false,
"type": "boolean"
},
"age_gated": {
"description": "Indicates whether the Campaign messages contain age-gated content.",
"example": false,
"type": "boolean"
},
"auto_renewal": {
"description": "Indicates whether the Campaign should be automatically renewed.",
"example": true,
"type": "boolean"
},
"brand_id": {
"description": "Brand ID.",
"example": "BM20QP9",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CKLCK95",
"type": "string"
},
"created_at": {
"description": "Date and time the Campaign was created in ISO 8601 format.",
"example": "2024-08-14T11:57:41",
"type": "string"
},
"description": {
"description": "Campaign description.",
"example": "Our campaign aims to …",
"type": [
"string",
"null"
]
},
"direct_lending": {
"description": "Indicates whether the Campaign messages contain direct lending content.",
"example": true,
"type": "boolean"
},
"embedded_link_sample": {
"description": "Embedded link sample.",
"type": [
"string",
"null"
]
},
"embedded_links": {
"description": "Indicates whether the Campaign messages contain embedded links.",
"example": true,
"type": "boolean"
},
"embedded_phones": {
"description": "Indicates whether the Campaign messages contain embedded phone numbers.",
"example": true,
"type": "boolean"
},
"feedback": {
"description": "Campaign feedback.",
"type": [
"string",
"null"
]
},
"help": {
"description": "Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).",
"example": true,
"type": "boolean"
},
"help_keywords": {
"description": "Comma-separated list of help keywords. Keywords are case-insensitive.",
"example": "help",
"type": "string"
},
"help_message": {
"description": "Help message sent upon receiving a help keyword.",
"example": "For help, please visit www.site.com. To opt out, reply STOP.",
"type": [
"string",
"null"
]
},
"last_bill_date": {
"description": "Date and time the Campaign was last billed in ISO 8601 format. `null` if the Campaign has never been billed.",
"example": "2024-08-14T11:57:42",
"type": [
"string",
"null"
]
},
"mock": {
"description": "Indicates whether the Campaign is a mock campaign.",
"example": false,
"type": "boolean"
},
"monthly_fee": {
"description": "Campaign monthly fee.",
"example": "10.0",
"type": "string"
},
"name": {
"description": "Campaign name.",
"example": "My first campaign",
"type": "string"
},
"next_bill_date": {
"description": "Date and time the Campaign will be billed next in ISO 8601 format. `null` if the next billing date is not scheduled.",
"example": "2024-08-14T11:57:42",
"type": [
"string",
"null"
]
},
"optin": {
"description": "Indicates whether the Campaign requires subscriber opt-in.",
"example": true,
"type": "boolean"
},
"optin_keywords": {
"description": "Comma-separated list of opt-in keywords. Keywords are case-insensitive.",
"example": "begin,start",
"type": "string"
},
"optin_message": {
"description": "Opt-in message sent upon receiving an opt-in keyword.",
"example": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"type": [
"string",
"null"
]
},
"optin_workflow": {
"description": "Opt-in workflow description.",
"example": "Our SMS ...",
"type": [
"string",
"null"
]
},
"optout": {
"description": "Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).",
"example": true,
"type": "boolean"
},
"optout_keywords": {
"description": "Comma-separated list of opt-out keywords. Keywords are case-insensitive.",
"example": "stop,quit,unsubscribe",
"type": "string"
},
"optout_message": {
"description": "Opt-out message sent upon receiving an opt-out keyword.",
"example": "You are now opted out and will receive no further messages",
"type": [
"string",
"null"
]
},
"phone_numbers": {
"description": "List of phone numbers associated with the campaign.",
"example": [
"14358684439",
"13193337776",
"12673296046"
],
"items": {
"type": "string"
},
"type": "array"
},
"privacy_policy": {
"description": "Privacy policy URL.",
"example": "https://site.com/privacy-policy",
"type": [
"string",
"null"
]
},
"sample1": {
"description": "Message sample.",
"example": "Your verification code is XXXXXX",
"type": [
"string",
"null"
]
},
"sample2": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample3": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample4": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"sample5": {
"description": "Message sample.",
"type": [
"string",
"null"
]
},
"status": {
"description": "Campaign status.",
"example": "APPROVED",
"type": "string"
},
"terms_conditions": {
"description": "Terms and conditions URL.",
"example": "https://site.com/terms-and-conditions",
"type": [
"string",
"null"
]
},
"updated_at": {
"description": "Date and time the Campaign was updated in ISO 8601 format.",
"example": "2024-08-14T11:57:47",
"type": "string"
},
"usecase": {
"description": "Campaign use case.",
"example": "2FA",
"type": "string"
}
},
"required": [
"affiliate_marketing",
"age_gated",
"auto_renewal",
"last_bill_date",
"next_bill_date",
"direct_lending",
"embedded_links",
"embedded_phones",
"embedded_link_sample",
"brand_id",
"campaign_id",
"description",
"optin_workflow",
"feedback",
"help",
"help_keywords",
"help_message",
"optin",
"optin_keywords",
"optin_message",
"optout",
"optout_keywords",
"optout_message",
"name",
"created_at",
"sample1",
"sample2",
"sample3",
"sample4",
"sample5",
"updated_at",
"mock",
"usecase",
"monthly_fee",
"terms_conditions",
"privacy_policy",
"status",
"phone_numbers"
],
"title": "TenDlcCampaign",
"type": "object"
},
"type": "array"
},
"pagination": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
},
{
"description": "Pagination details"
}
]
}
},
"required": [
"items",
"pagination"
],
"title": "TenDlcCampaignListResponse",
"type": "object"
},
{
"example": {
"items": [
{
"affiliate_marketing": false,
"age_gated": false,
"auto_renewal": false,
"brand_id": "BM20QP9",
"campaign_id": "CKLCK95",
"created_at": "2024-08-14T11:57:41",
"description": "Our campaign aims to …",
"direct_lending": false,
"embedded_link_sample": null,
"embedded_links": false,
"embedded_phones": false,
"feedback": null,
"help": true,
"help_keywords": "help",
"help_message": "For help, please visit www.site.com. To opt-out, reply STOP.",
"last_bill_date": "2024-08-14T11:57:42",
"mock": false,
"monthly_fee": "10.0",
"name": "My first campaign",
"next_bill_date": "2024-11-14T00:00:00",
"optin": true,
"optin_keywords": "begin,start",
"optin_message": "You are now opted-in for help please reply HELP, to stop please reply STOP",
"optin_workflow": "Our SMS ...",
"optout": true,
"optout_keywords": "stop,quit,unsubscribe",
"optout_message": "You are now opted out and will receive no further messages",
"phone_numbers": [
"14358684439",
"13193337776",
"12673296046"
],
"privacy_policy": "https://site.com/privacy-policy",
"sample1": "Your verification code is XXXXXX",
"sample2": "XXXX is your verification code",
"sample3": null,
"sample4": null,
"sample5": null,
"status": "APPROVED",
"terms_conditions": "https://site.com/terms-and-conditions",
"updated_at": "2024-08-14T11:57:47",
"usecase": "2FA"
}
],
"pagination": {
"current_page": 1,
"per_page": 25,
"total": 1,
"total_pages": 1
}
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Requests action on a pending or rejected 10DLC Campaign. Use `nudge_intent` to specify the action: \n- `REVIEW`: Request review for a pending Campaign. - `APPEAL_REJECTION`: Appeal a rejected Campaign.\nNote:\n- The Campaign must be at least 72 hours old.\n- Only one nudge request per Campaign is allowed every 24 hours.",
"inputSchema": {
"properties": {
"brand_id": {
"description": "Brand ID.",
"example": "B9FXYNH",
"type": "string"
},
"campaign_id": {
"description": "Campaign ID.",
"example": "CSJ4TV0",
"type": "string"
},
"description": {
"description": "Description of the nudge request.",
"example": "Please review the campaign.",
"type": "string"
},
"nudge_intent": {
"description": "Nudge intent. Allowed values: `REVIEW`, `APPEAL_REJECTION`. \nUse `nudge_intent` to specify the action: - `REVIEW`: Request review for a pending Campaign. - `APPEAL_REJECTION`: Appeal a rejected Campaign.",
"example": "REVIEW",
"type": "string"
}
},
"required": [
"brand_id",
"campaign_id",
"nudge_intent",
"description"
],
"type": "object"
},
"name": "ten_dlc_campaigns_nudge",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Subscribes to Wavix 10DLC event callbacks.",
"inputSchema": {
"properties": {
"subscription_category": {
"description": "The Wavix 10DLC event type. Can be one of the following: `brand`, `campaign`, or `number`.",
"example": "brand",
"type": "string"
},
"url": {
"description": "A webhook URL to send events to",
"example": "https://webhook.url",
"type": "string"
}
},
"required": [
"subscription_category",
"url"
],
"type": "object"
},
"name": "ten_dlc_subscriptions_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"description": "10DLC event subscription configuration.",
"example": {
"subscription_category": "brand",
"url": "https://webhook.url"
},
"properties": {
"subscription_category": {
"description": "The Wavix 10DLC event type. Can be one of the following: `brand`, `campaign`, or `number`.",
"example": "brand",
"type": "string"
},
"url": {
"description": "A webhook URL to send events to",
"example": "https://webhook.url",
"type": "string"
}
},
"required": [
"subscription_category",
"url"
],
"title": "TenDlcEventSubscription",
"type": "object"
},
{
"example": {
"subscription_category": "brand",
"url": "https://webhook.url"
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Deletes a 10DLC event subscription.",
"inputSchema": {
"properties": {
"subscription_category": {
"description": "Event category to unsubscribe from.",
"example": "number",
"type": "string"
}
},
"required": [
"subscription_category"
],
"type": "object"
},
"name": "ten_dlc_subscriptions_delete",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"success"
],
"title": "SuccessResponse",
"type": "object"
},
{
"example": {
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of 10DLC event subscriptions.",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "ten_dlc_subscriptions_list",
"outputSchema": {
"properties": {
"result": {
"example": [
{
"subscription_category": "brand",
"url": "https://webhook.url"
}
],
"items": {
"additionalProperties": false,
"description": "10DLC event subscription configuration.",
"example": {
"subscription_category": "brand",
"url": "https://webhook.url"
},
"properties": {
"subscription_category": {
"description": "The Wavix 10DLC event type. Can be one of the following: `brand`, `campaign`, or `number`.",
"example": "brand",
"type": "string"
},
"url": {
"description": "A webhook URL to send events to",
"example": "https://webhook.url",
"type": "string"
}
},
"required": [
"subscription_category",
"url"
],
"title": "TenDlcEventSubscription",
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of events for a specific 2FA Verification.",
"inputSchema": {
"properties": {
"session_id": {
"description": "2FA Verification ID.",
"example": "8753d4308f2e11ecb75fcdafd6d2d690",
"type": "string"
}
},
"required": [
"session_id"
],
"type": "object"
},
"name": "two_fa_events_list",
"outputSchema": {
"properties": {
"result": {
"example": [
{
"charge": "0.005",
"created_at": "2022-02-16T13:41:38.000Z",
"error": null,
"event": "Number lookup",
"status": "success"
},
{
"charge": "0.005",
"created_at": "2022-02-16T13:41:38.000Z",
"error": null,
"event": "Code sent via SMS",
"status": "success"
}
],
"items": {
"additionalProperties": false,
"properties": {
"charge": {
"description": "Cost of an operation associated with the event, in USD",
"example": "0.005",
"type": "string"
},
"created_at": {
"description": "Date and time of the event",
"example": "2022-02-16T13:41:38.000Z",
"format": "date-time",
"type": "string"
},
"error": {
"description": "Error description, if any",
"type": [
"string",
"null"
]
},
"event": {
"description": "Human readable event description. Can contain on of the following values:\n- `Number lookup` for the Wavix platform checked if the destination phone number is valid. You'll see the event only when the Number validation option is activated for your 2FA Service;\n- `Code sent via SMS` indicates a code was sent via an SMS;\n- `Code sent via voice` indicates a code was sent via a voice call;\n- `Verification` indicates the code verification attempt",
"example": "Code sent via SMS",
"type": "string"
},
"status": {
"description": "Status of an action associated with the event. Can be either `success`, `failed`, or `pending`.",
"example": "success",
"type": "string"
}
},
"required": [
"created_at",
"event",
"status",
"charge",
"error"
],
"title": "TwoFactorVerificationEvent",
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Returns a list of 2FA verifications. Filter by service or date.",
"inputSchema": {
"properties": {
"from": {
"description": "Start date in `YYYY-MM-DD` format.",
"example": "2022-01-01",
"format": "date",
"type": "string"
},
"service_id": {
"description": "2FA Service ID.",
"example": "7204a030201211ee9fb47d093f2f127c",
"type": "string"
},
"to": {
"description": "End date in `YYYY-MM-DD` format.",
"example": "2022-01-31",
"format": "date",
"type": "string"
}
},
"required": [
"service_id",
"from",
"to"
],
"type": "object"
},
"name": "two_fa_sessions_list",
"outputSchema": {
"properties": {
"result": {
"example": [
{
"charge": "0.01",
"created_at": "2022-02-16T13:41:38.000Z",
"destination_country": "GB",
"phone_number": "447919433768",
"service_id": "7204a030201211ee9fb47d093f2f127c",
"service_name": "Wavix 2FA Service",
"session_id": "2953d4308f2e11ecb75fcdafd6d2d687",
"status": "verified"
},
{
"charge": "0.01",
"created_at": "2022-02-16T13:41:38.000Z",
"destination_country": "GB",
"phone_number": "447919433768",
"service_id": "7204a030201211ee9fb47d093f2f127c",
"service_name": "Wavix 2FA Service",
"session_id": "8753d4308f2e11ecb75fcdafd6d2d690",
"status": "pending"
}
],
"items": {
"additionalProperties": false,
"properties": {
"charge": {
"description": "Charge for the 2FA Verification.",
"example": "0.01",
"type": "string"
},
"created_at": {
"description": "Date and time the 2FA Verification was created in ISO 8601 format.",
"example": "2022-02-16T13:41:38.000Z",
"format": "date-time",
"type": "string"
},
"destination_country": {
"description": "Country code of the destination phone number in ISO 3166-1 alpha-2 format.",
"example": "GB",
"type": "string"
},
"phone_number": {
"description": "Destination phone number.",
"example": "447919433768",
"type": "string"
},
"service_id": {
"description": "2FA Service ID.",
"example": "7204a030201211ee9fb47d093f2f127c",
"type": "string"
},
"service_name": {
"description": "2FA Service name.",
"example": "Wavix 2FA Service",
"type": "string"
},
"session_id": {
"description": "2FA Verification ID.",
"example": "2953d4308f2e11ecb75fcdafd6d2d687",
"type": "string"
},
"status": {
"description": "Status of the 2FA Verification.",
"example": "verified",
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Cancels a 2FA verification. After cancellation, no additional codes are sent, and previously sent codes can no longer be validated. You must create a new verification to send another code.",
"inputSchema": {
"properties": {
"session_id": {
"description": "2FA Verification ID.",
"example": "2953d4308f2e11ecb75fcdafd6d2d687",
"type": "string"
}
},
"required": [
"session_id"
],
"type": "object"
},
"name": "two_fa_verification_cancel",
"outputSchema": {
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Validates the verification code.",
"inputSchema": {
"properties": {
"code": {
"description": "The code entered by an end user",
"example": "123456",
"type": "string"
},
"session_id": {
"description": "2FA Verification ID.",
"example": "2953d4308f2e11ecb75fcdafd6d2d687",
"type": "string"
}
},
"required": [
"session_id",
"code"
],
"type": "object"
},
"name": "two_fa_verification_check",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"is_valid": {
"description": "Indicates whether the entered code is valid",
"example": true,
"type": "boolean"
}
},
"required": [
"is_valid"
],
"title": "TwoFactorVerificationCheckResponse",
"type": "object"
},
{
"example": {
"is_valid": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Creates a new 2FA Verification and sends a one-time password (OTP) to the destination phone number.\nBefore using this endpoint, create a 2FA Service in the Wavix portal. The service is created once and reused to generate and validate OTPs.\nOTP flow:\n1. Create a Verification to generate and send an OTP.\n2. Reuse the same Verification to resend the OTP if needed.\n3. Validate the OTP using the 2FA API\n\nWhen a Verification is created, Wavix generates a random code and sends it to the destination phone number via the selected channel.",
"inputSchema": {
"properties": {
"channel": {
"description": "The communication channel you want to use. Can be either `sms` or `voice`.",
"example": "sms",
"type": "string"
},
"service_id": {
"description": "Unique Wavix 2FA Service ID. Find your 2FA Service ID on the Wavix portal.",
"example": "7204a030201211ee9fb47d093f2f127c",
"type": "string"
},
"to": {
"description": "End user's phone number to which the verification code will be sent. The phone number must be in E.164 format.",
"example": "447919433768",
"type": "string"
}
},
"required": [
"service_id",
"to",
"channel"
],
"type": "object"
},
"name": "two_fa_verification_create",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"additionalProperties": false,
"properties": {
"created_at": {
"description": "Date and time the 2FA Verification is created",
"example": "2022-02-16T13:41:38.000Z",
"format": "date-time",
"type": "string"
},
"destination": {
"description": "The end user’s phone number",
"example": "447919433768",
"type": "string"
},
"number_lookup": {
"additionalProperties": false,
"properties": {
"country": {
"description": "The destination phone number's 2-letter ISO country code",
"example": "GB",
"type": "string"
},
"current_carrier": {
"description": "The carrier name the phone number currently belongs to",
"example": "Vodafone",
"type": "string"
},
"number_type": {
"description": "The destination phone number type",
"example": "mobile",
"type": "string"
}
},
"required": [
"number_type",
"country",
"current_carrier"
],
"title": "PhoneLookupDetails",
"type": "object"
},
"service_id": {
"description": "Unique identifier of the Wavix 2FA Service",
"example": "7204a030201211ee9fb47d093f2f127c",
"type": "string"
},
"session_id": {
"description": "Unique identifier of the Wavix 2FA Verification",
"example": "2953d4308f2e11ecb75fcdafd6d2d687",
"type": "string"
},
"session_url": {
"description": "Automatically generated 2FA Verification URL. The URL can be used to resend or validate the OTP.",
"example": "https://api.wavix.com/v1/two-fa/verification/2953d4308f2e11ecb75fcdafd6d2d687",
"type": "string"
},
"success": {
"description": "Indicates whether the 2FA Verification was successfully created",
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"service_id",
"session_url",
"session_id",
"destination",
"created_at",
"number_lookup"
],
"title": "TwoFactorVerificationResponse",
"type": "object"
},
{
"example": {
"created_at": "2022-02-16T13:41:38.000Z",
"destination": "447919433768",
"number_lookup": {
"country": "GB",
"current_carrier": "Vodafone",
"number_type": "mobile"
},
"service_id": "7204a030201211ee9fb47d093f2f127c",
"session_id": "2953d4308f2e11ecb75fcdafd6d2d687",
"session_url": "https://api.wavix.com/v1/two-fa/verification/2953d4308f2e11ecb75fcdafd6d2d687",
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Resends the verification code using the specified channel. Previously sent codes are invalidated.",
"inputSchema": {
"properties": {
"channel": {
"description": "The communication channel you want to use. Can be either `sms` or `voice`.",
"enum": [
"sms",
"voice"
],
"example": "voice",
"type": "string"
},
"session_id": {
"description": "2FA Verification ID.",
"example": "2953d4308f2e11ecb75fcdafd6d2d687",
"type": "string"
}
},
"required": [
"session_id",
"channel"
],
"type": "object"
},
"name": "two_fa_verification_resend",
"outputSchema": {
"properties": {
"result": {
"allOf": [
{
"properties": {
"channel": {
"description": "Indicates whether the code was sent via an SMS or a voice call",
"example": "voice",
"type": "string"
},
"created_at": {
"description": "Date and time the code was sent",
"example": "2022-02-16T13:41:38.000Z",
"format": "date-time",
"type": "string"
},
"destination": {
"description": "The destination phone number the code was sent to",
"example": "447919433768",
"type": "string"
},
"success": {
"description": "Indicates whether the verification code was successfully sent",
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"channel",
"destination",
"created_at"
],
"title": "TwoFactorVerificationResendResponse",
"type": "object"
},
{
"example": {
"channel": "voice",
"created_at": "2022-02-16T13:41:38.000Z",
"destination": "447919433768",
"success": true
}
}
]
}
},
"required": [
"result"
],
"type": "object",
"x-fastmcp-wrap-result": true
}
},
{
"description": "Triggers an outbound call based on a pre-configured scenario.",
"inputSchema": {
"properties": {
"voice_campaign": {
"additionalProperties": false,
"properties": {
"callback_url": {
"description": "A webhook URL to receive campaign status updates",
"example": "https://you-site.com/webhook",
"type": "string"
},
"caller_id": {
"description": "A phone number on your Wavix account. Will be used as Caller ID when placing an outbound call.",
"example": "13123310912",
"type": "string"
},
"callflow_id": {
"description": "Unique identifier of the Call flow to be launched. You can find it on the Calls flows page. Note that every scenario must be pre-approved by the Wavix Service Operations team before it can be used in production.",
"example": 3212,
"format": "int32",
"type": "integer"
},
"contact": {
"description": "A phone number to place an outbound the call to",
"example": "16729923812",
"type": "string"
}
},
"required": [
"callflow_id",
"caller_id",
"contact"
],
"title": "VoiceCampaignResponse",
"type": "object"
}
},
"required": [
"voice_campaign"
],
"type": "object"
},
"name": "voice_campaigns_create",
"outputSchema": {
"additionalProperties": false,
"properties": {
"voice_campaign": {
"additionalProperties": false,
"properties": {
"caller_id": {
"description": "Caller ID.",
"example": "13123310912",
"type": "string"
},
"contact": {
"description": "Destination phone number.",
"example": "16729923812",
"type": "string"
},
"id": {
"description": "Voice campaign ID.",
"example": 2321423,
"type": "integer"
},
"status": {
"description": "Voice campaign status.",
"example": "in_progress",
"type": "string"
},
"timestamp": {
"description": "Date and time the voice campaign was created in ISO 8601 format.",
"example": "2023-08-03T09:04:12.000Z",
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Returns a specific voice campaign.",
"inputSchema": {
"properties": {
"id": {
"description": "Voice campaign ID.",
"example": 2321423,
"format": "int32",
"type": "integer"
}
},
"required": [
"id"
],
"type": "object"
},
"name": "voice_campaigns_get",
"outputSchema": {
"additionalProperties": false,
"properties": {
"voice_campaign": {
"additionalProperties": false,
"properties": {
"caller_id": {
"description": "Caller ID.",
"example": "13123310912",
"type": "string"
},
"contact": {
"description": "Destination phone number.",
"example": "16729923812",
"type": "string"
},
"id": {
"description": "Voice campaign ID.",
"example": 2321423,
"type": "integer"
},
"status": {
"description": "Voice campaign status.",
"example": "in_progress",
"type": "string"
},
"timestamp": {
"description": "Date and time the voice campaign was created in ISO 8601 format.",
"example": "2023-08-03T09:04:12.000Z",
"format": "date-time",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Creates a Wavix Embeddable widget token.",
"inputSchema": {
"properties": {
"payload": {
"description": "Arbitrary data to be associated with the token",
"example": {},
"type": [
"object",
"null"
]
},
"sip_trunk": {
"description": "SIP trunk name",
"example": "my-sip-trunk",
"type": "string"
},
"ttl": {
"description": "Time to live in seconds. Pass `null` for no expiration.",
"example": 3600,
"minimum": 1,
"type": [
"integer",
"null"
]
}
},
"required": [
"sip_trunk",
"ttl"
],
"type": "object"
},
"name": "webrtc_tokens_create",
"outputSchema": {
"additionalProperties": false,
"properties": {
"payload": {
"description": "Arbitrary data associated with the token",
"example": {},
"type": [
"object",
"null"
]
},
"sip_trunk": {
"description": "SIP trunk name",
"example": "my-sip-trunk",
"type": "string"
},
"token": {
"description": "Wavix Embeddable Widget token.",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
"type": "string"
},
"ttl": {
"description": "Time to live, in seconds",
"example": 3600,
"type": [
"integer",
"null"
]
},
"uuid": {
"description": "Token ID",
"example": "550e8400-e29b-41d4-a716-446655440000",
"type": "string"
}
},
"required": [
"token",
"uuid",
"sip_trunk"
],
"title": "WebRtcTokenResponse",
"type": "object"
}
},
{
"description": "Deletes a Wavix Embeddable widget token. After deletion, the token can't be used to authenticate widget sessions, and any active session associated with it is terminated.",
"inputSchema": {
"properties": {
"uuid": {
"description": "Token ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "webrtc_tokens_delete",
"outputSchema": {
"properties": {
"success": {
"example": true,
"type": "boolean"
}
},
"type": "object"
}
},
{
"description": "Returns a Wavix Embeddable widget token configuration.",
"inputSchema": {
"properties": {
"uuid": {
"description": "Token ID.",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid"
],
"type": "object"
},
"name": "webrtc_tokens_get",
"outputSchema": {
"additionalProperties": false,
"properties": {
"payload": {
"description": "Arbitrary data associated with the token",
"example": {},
"type": [
"object",
"null"
]
},
"sip_trunk": {
"description": "SIP trunk name",
"example": "my-sip-trunk",
"type": "string"
},
"ttl": {
"description": "Time to live, in seconds. `null` means no expiration.",
"example": 3600,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uuid": {
"description": "Token ID",
"example": "550e8400-e29b-41d4-a716-446655440000",
"type": "string"
}
},
"required": [
"uuid",
"sip_trunk"
],
"title": "WebRtcToken",
"type": "object"
}
},
{
"description": "Returns a paginated list of active Wavix Embeddable widget tokens. Results are limited to 25 records per page by default. Use `page` and `per_page` to navigate results.",
"inputSchema": {
"properties": {},
"required": [],
"type": "object"
},
"name": "webrtc_tokens_list",
"outputSchema": {
"properties": {
"items": {
"items": {
"additionalProperties": false,
"properties": {
"payload": {
"description": "Arbitrary data associated with the token",
"example": {},
"type": [
"object",
"null"
]
},
"sip_trunk": {
"description": "SIP trunk name",
"example": "my-sip-trunk",
"type": "string"
},
"ttl": {
"description": "Time to live, in seconds. `null` means no expiration.",
"example": 3600,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uuid": {
"description": "Token ID",
"example": "550e8400-e29b-41d4-a716-446655440000",
"type": "string"
}
},
"required": [
"uuid",
"sip_trunk"
],
"title": "WebRtcToken",
"type": "object"
},
"type": "array"
},
"pagination": {
"additionalProperties": false,
"properties": {
"current_page": {
"description": "Current page number.",
"example": 2,
"format": "int32",
"type": "integer"
},
"per_page": {
"description": "Number of records per page.",
"example": 25,
"format": "int32",
"type": "integer"
},
"total": {
"description": "Total number of records.",
"example": 101,
"format": "int32",
"type": "integer"
},
"total_pages": {
"description": "Total number of pages.",
"example": 5,
"format": "int32",
"type": "integer"
}
},
"required": [
"current_page",
"per_page",
"total",
"total_pages"
],
"title": "Pagination",
"type": "object"
}
},
"type": "object"
}
},
{
"description": "Updates the payload for a Wavix Embeddable widget token.",
"inputSchema": {
"properties": {
"payload": {
"description": "Arbitrary data to be associated with the token",
"example": {},
"type": "object"
},
"uuid": {
"description": "Token ID",
"format": "uuid",
"type": "string"
}
},
"required": [
"uuid",
"payload"
],
"type": "object"
},
"name": "webrtc_tokens_update",
"outputSchema": {
"additionalProperties": false,
"properties": {
"payload": {
"description": "Arbitrary data associated with the token",
"example": {},
"type": [
"object",
"null"
]
},
"sip_trunk": {
"description": "SIP trunk name",
"example": "my-sip-trunk",
"type": "string"
},
"ttl": {
"description": "Time to live, in seconds. `null` means no expiration.",
"example": 3600,
"minimum": 1,
"type": [
"integer",
"null"
]
},
"uuid": {
"description": "Token ID",
"example": "550e8400-e29b-41d4-a716-446655440000",
"type": "string"
}
},
"required": [
"uuid",
"sip_trunk"
],
"title": "WebRtcToken",
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:09ca7b43a14c477a6abd9bab998184dd17d43a7ba04550e36e4529e315530476 | sha256sum