A
licenseNot graded
qualityD
maintenanceMCP server for provisioning dedicated real-SIM US phone numbers, receiving inbound SMS, and extracting OTP codes. Built for AI agents automating phone verification workflows.
25 npm
1
MIT
Wavix
Server Details
Wavix telecom MCP: SMS, voice, 2FA, SIP, numbers, 10DLC, CDRs. Account sign-in or API key.
Glama couldn't complete the latest health check. If this server requires authentication, missing or expired test credentials may be the cause. A test profile lets Glama authenticate for health checks and discover tools; it is separate from your personal connections.
If you are the author, claim ownership, then add or update a test profile under Admin → Test Profile.
- Status
- Unhealthy
- Uptime
- 36.4% over 42 days
- OAuth
- Not checked
- Last Tested
- Transport
- Streamable HTTP
- URL
- Repository
- Wavix/wavix-mcp-server
- GitHub Stars
- 4
- Server Listing
- Wavix
TDQS
A4.1/5.0
Scored across 115 tools
Disambiguation5/5
Each tool is scoped to a distinct resource and action, with clear domain prefixes (api_keys, call_control, ten_dlc, etc.). No two tools overlap in purpose; even the many ten_dlc tools are cleanly separated by brand, campaign, evidence, vetting, and subscription.
Naming Consistency5/5
All tools follow a consistent <domain>_<subdomain>_<verb> pattern (create, list, get, update, delete). Minor deviations like call_recording_get_by_call and number_validator_results_get still use the same verb-based structure and are unambiguous.
Tool Count1/5
With 115 tools, this is an extreme count that makes efficient tool selection impractical for an agent. Even though the tools are well-organized by domain, the sheer number exceeds any reasonable navigation scope.
Completeness5/5
The tool surface provides complete CRUD/lifecycle coverage across all exposed domains: numbers, calls, messages, SIP trunks, 10DLC brands and campaigns, 2FA, webhooks, tokens, and more. No obvious missing operations within the intended scope.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
126 tool updates
- Removed
api_keys_activate - Changed
api_keys_create47 fields changed- changed
Input schema / properties / account / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - added
Input schema / properties / activeAdded value: +{ + "default": true, + "description": "Indicates whether the API key should be activated upon creation.", + "example": true, + "type": "boolean" +} - changed
Input schema / properties / billing / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - changed
Input schema / properties / billing / descriptionPrevious value: -"Access invoices, balance, payment methods, usage reports, and billing settings, including payment method updates."New value: +"Access statements, balance, payment methods, usage reports, and billing settings, including payment method updates." - changed
Input schema / properties / calls / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for the `calls` scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET requests, `POST /v1/cdrs`\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - changed
Input schema / properties / campaigns / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - changed
Input schema / properties / embeddable / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - removed
Input schema / properties / is_activeRemoved value: -{ - "default": true, - "description": "Indicates whether the API key should be activated upon creation.", - "example": true, - "type": "boolean" -} - removed
Input schema / properties / is_restrictionRemoved value: -{ - "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" -} - removed
Input schema / properties / is_scopes_enabledRemoved value: -{ - "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" -} - changed
Input schema / properties / messages / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - changed
Input schema / properties / numbers / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - changed
Input schema / properties / permitted_ips / descriptionPrevious value: -"List of permitted IP addresses for this API key. Each must be a valid IPv4 address. Required when `is_restriction` is true."New value: +"List of permitted IP addresses for this API key. Each must be a valid IPv4 address. Required when `restricted` is true." - changed
Input schema / properties / recordings / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - added
Input schema / properties / restrictedAdded value: +{ + "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" +} - added
Input schema / properties / scopes_enabledAdded value: +{ + "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 `scopes_enabled: true` and no scopes set the key has no access.", + "example": true, + "type": "boolean" +} - changed
Input schema / properties / subaccounts / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - changed
Input schema / properties / trunks / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - changed
Input schema / properties / two_fa / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - changed
Input schema / properties / validator / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - changed
Input schema / properties / webhooks / allOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + } +] - removed
Output schema / descriptionRemoved value: -"API key details including IP restrictions and scope permissions." - removed
Output schema / properties / accountRemoved value: -{ - "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." -} - removed
Output schema / properties / billingRemoved value: -{ - "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." -} - removed
Output schema / properties / callsRemoved value: -{ - "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." -} - removed
Output schema / properties / campaignsRemoved value: -{ - "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." -} - removed
Output schema / properties / created_atRemoved value: -{ - "description": "Creation date and time in ISO 8601 format.", - "example": "2024-01-15T10:30:00Z", - "format": "date-time", - "type": "string" -} - removed
Output schema / properties / embeddableRemoved value: -{ - "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." -} - removed
Output schema / properties / idRemoved value: -{ - "description": "API key ID.", - "example": 123, - "type": "integer" -} - removed
Output schema / properties / is_activeRemoved value: -{ - "description": "Indicates whether the API key is active.", - "example": true, - "type": "boolean" -} - removed
Output schema / properties / is_restrictionRemoved value: -{ - "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" -} - removed
Output schema / properties / is_scopes_enabledRemoved value: -{ - "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" -} - removed
Output schema / properties / labelRemoved value: -{ - "description": "API key label.", - "example": "Production API Key", - "type": "string" -} - removed
Output schema / properties / last_used_atRemoved value: -{ - "description": "Timestamp of the most recent authenticated request made with this key.", - "example": "2026-04-20T15:42:11Z", - "format": "date-time", - "type": [ - "string", - "null" - ] -} - removed
Output schema / properties / messagesRemoved value: -{ - "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." -} - removed
Output schema / properties / numbersRemoved value: -{ - "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." -} - removed
Output schema / properties / permitted_ipsRemoved value: -{ - "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" -} - removed
Output schema / properties / recordingsRemoved value: -{ - "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." -} - added
Output schema / properties / resultAdded value: +{ + "allOf": [ + { + "description": "API key details including IP restrictions and scope permissions.", + "properties": { + "account": { + "anyOf": [ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } + ], + "description": "View and update account profile information and timezone." + }, + "active": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the API key is active.", + "example": true + }, + "billing": { + "anyOf": [ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Access statements, balance, payment methods, usage reports, and billing settings, including payment method updates." + }, + "calls": { + "anyOf": [ + { + "description": "Permission level for the `calls` scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET requests, `POST /v1/cdrs`\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Creation date and time in ISO 8601 format.", + "example": "2024-01-15T10:30:00Z", + "format": "date-time" + }, + "embeddable": { + "anyOf": [ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Manage widget tokens, including listing, viewing, creating, updating, and deleting them." + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "API key ID.", + "example": 123 + }, + "label": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "API key label.", + "example": "Production API Key" + }, + "last_used_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp of the most recent authenticated request made with this key.", + "example": "2026-04-20T15:42:11Z", + "format": "date-time" + }, + "messages": { + "anyOf": [ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } + ], + "description": "View, buy, release, and configure phone numbers, browse inventory, and manage the cart." + }, + "permitted_ips": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "List of permitted IP addresses. If `restricted` is false,\n an empty list means no IP restrictions. If `restricted` is true,\n an empty list prevents all requests.", + "example": [ + "192.168.1.1", + "10.0.0.1" + ], + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "recordings": { + "anyOf": [ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } + ], + "description": "List, download, and delete call recordings." + }, + "restricted": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether IP restrictions are enabled. When enabled,\n the API key works only from IP addresses in `permitted_ips`.", + "example": true + }, + "scopes_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "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 + }, + "subaccounts": { + "anyOf": [ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } + ], + "description": "View number validation results and trigger single or bulk validation or HLR lookup requests." + }, + "value": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "API key value.", + "example": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz" + }, + "webhooks": { + "anyOf": [ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } + ], + "description": "List, create, and delete webhooks." + } + }, + "required": [ + "id", + "label", + "value", + "active", + "restricted", + "permitted_ips", + "scopes_enabled", + "last_used_at", + "numbers", + "trunks", + "calls", + "messages", + "recordings", + "campaigns", + "two_fa", + "validator", + "webhooks", + "embeddable", + "billing", + "account", + "subaccounts", + "created_at" + ], + "type": "object" + } + ], + "description": "API key details, including the secret `value`. Returned only at creation time —\nstore it securely, it cannot be retrieved again." +} - removed
Output schema / properties / subaccountsRemoved value: -{ - "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." -} - removed
Output schema / properties / trunksRemoved value: -{ - "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." -} - removed
Output schema / properties / two_faRemoved value: -{ - "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." -} - removed
Output schema / properties / validatorRemoved value: -{ - "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." -} - removed
Output schema / properties / valueRemoved value: -{ - "description": "API key value.", - "example": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz", - "type": "string" -} - removed
Output schema / properties / webhooksRemoved value: -{ - "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." -} - changed
Output schema / requiredPrevious value: -[ - "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" -]New value: +[ + "result" +] - added
Output schema / x-fastmcp-wrap-resultAdded value: +true
- Removed
api_keys_deactivate - Changed
api_keys_delete6 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"API key ID."New value: +"The unique ID of the API key." - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - added
Output schema / properties / success / descriptionAdded value: +"Indicates whether the request was successful." - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
api_keys_list39 fields changed- changed
Input schema / properties / label / descriptionPrevious value: -"Label to filter API keys. Partial match supported."New value: +"Filters API keys by `label`. Matches partial values." - added
Output schema / properties / result / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / account / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / activeAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the API key is active.", + "example": true +} - changed
Output schema / properties / result / items / properties / billing / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / billing / descriptionPrevious value: -"Access invoices, balance, payment methods, usage reports, and billing settings, including payment method updates."New value: +"Access statements, balance, payment methods, usage reports, and billing settings, including payment method updates." - changed
Output schema / properties / result / items / properties / calls / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for the `calls` scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET requests, `POST /v1/cdrs`\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / campaigns / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / created_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / created_at / typeRemoved value: -"string" - changed
Output schema / properties / result / items / properties / embeddable / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / id / typeRemoved value: -"integer" - removed
Output schema / properties / result / items / properties / is_activeRemoved value: -{ - "description": "Indicates whether the API key is active.", - "example": true, - "type": "boolean" -} - removed
Output schema / properties / result / items / properties / is_restrictionRemoved value: -{ - "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" -} - removed
Output schema / properties / result / items / properties / is_scopes_enabledRemoved value: -{ - "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" -} - added
Output schema / properties / result / items / properties / label / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / label / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / last_used_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / last_used_at / typeRemoved value: -[ - "string", - "null" -] - changed
Output schema / properties / result / items / properties / messages / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / numbers / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / permitted_ips / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / permitted_ips / descriptionPrevious value: -"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."New value: +"List of permitted IP addresses. If `restricted` is false,\n an empty list means no IP restrictions. If `restricted` is true,\n an empty list prevents all requests." - added
Output schema / properties / result / items / properties / permitted_ips / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / permitted_ips / items / typeRemoved value: -"string" - removed
Output schema / properties / result / items / properties / permitted_ips / typeRemoved value: -"array" - changed
Output schema / properties / result / items / properties / recordings / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / restrictedAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether IP restrictions are enabled. When enabled,\n the API key works only from IP addresses in `permitted_ips`.", + "example": true +} - added
Output schema / properties / result / items / properties / scopes_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "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 +} - changed
Output schema / properties / result / items / properties / subaccounts / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / trunks / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / two_fa / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / validator / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / value / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / value / typeRemoved value: -"string" - changed
Output schema / properties / result / items / properties / webhooks / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Permission level for an API key scope group.", + "properties": { + "allow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "default": "none", + "description": "Permission level:\n- `none`: no access\n- `read`: GET only\n- `write`: all methods (includes read)", + "enum": [ + "none", + "read", + "write", + null + ], + "example": "read" + } + }, + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / requiredPrevious value: -[ - "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" -]New value: +[ + "id", + "label", + "value", + "active", + "restricted", + "permitted_ips", + "scopes_enabled", + "last_used_at", + "numbers", + "trunks", + "calls", + "messages", + "recordings", + "campaigns", + "two_fa", + "validator", + "webhooks", + "embeddable", + "billing", + "account", + "subaccounts", + "created_at" +] - removed
Output schema / properties / result / typeRemoved value: -"array"
- Added
api_keys_update - Removed
billing_invoices_download - Changed
billing_invoices_list10 fields changed- changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / invoicesAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Auto-generated statements for the account.", + "items": { + "additionalProperties": false, + "description": "An account financial statement", + "properties": { + "amount": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Statement amount", + "example": "7.72" + }, + "from_date": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Start of the billing period", + "example": "2023-07-01", + "format": "date" + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the statement", + "example": 43209, + "format": "int32" + }, + "to_date": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "End of the billing period", + "example": "2023-07-31", + "format": "date" + } + }, + "required": [ + "id", + "amount", + "from_date", + "to_date" + ], + "title": "Invoice", + "type": "object" + } +} - added
Output schema / properties / is_emptyAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the statement list is empty.", + "example": false +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "is_empty", + "invoices", + "pagination" +] - added
Output schema / titleAdded value: +"InvoiceListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
billing_transactions_list22 fields changed- changed
Input schema / properties / details_contains / descriptionPrevious value: -"Transaction details for filtering."New value: +"Filters transactions whose `details` contain the given substring." - changed
Input schema / properties / from_date / descriptionPrevious value: -"Start date in `YYYY-MM-DD` format."New value: +"Start of the date range to query, in `YYYY-MM-DD` format. Inclusive." - added
Input schema / properties / from_date / formatAdded value: +"date" - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / payments / descriptionPrevious value: -"Indicates whether to include account top-ups only."New value: +"When `true`, returns only account top-up transactions. Defaults to all transaction types." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / to_date / descriptionPrevious value: -"End date in `YYYY-MM-DD` format."New value: +"End of the date range to query, in `YYYY-MM-DD` format. Inclusive." - added
Input schema / properties / to_date / formatAdded value: +"date" - removed
Input schema / properties / type / allOfRemoved value: -[ - { - "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" - } -] - added
Input schema / properties / type / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Input schema / properties / type / descriptionPrevious value: -"Filter by transaction type."New value: +"Transaction type:\n * 0 - Payment adjustment\n * 2 - Phone number activation fee\n * 3 - Phone number monthly fees\n * 6 - Phone number 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 - Phone number 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 * 56 - 10DLC Campaign vetting fee\n * 57 - Outbound SMS segment\n * 58 - Inbound SMS segment\n * 59 - Outbound MMS segment\n * 60 - Inbound MMS segment" - added
Input schema / properties / type / enumAdded value: +[ + 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, + null +] - added
Input schema / properties / type / titleAdded value: +"TransactionType" - added
Input schema / properties / type / x-enum-varnamesAdded value: +[ + "PAYMENT_ADJUSTMENT", + "PHONE_NUMBER_ACTIVATION_FEE", + "PHONE_NUMBER_MONTHLY_FEES", + "PHONE_NUMBER_FORWARDING", + "PSTN_FORWARDING_FEE", + "OUTBOUND_CALL", + "OUTBOUND_SMS", + "CREDIT_CARD_PAYMENT", + "PAYMENT_FEE", + "PORTING_FEE", + "INBOUND_SMS", + "ADMIN_PAYMENT", + "SUBSCRIPTION_PAYMENT", + "NUMBER_VALIDATOR", + "CALL_RECORDING", + "STORAGE_CHARGE", + "CAMPAIGN_BUILDER", + "VOICEMAIL_DETECTION", + "SENDER_ID_REGISTRATION", + "SENDER_ID_MONTHLY_FEE", + "TWO_FA", + "IVR", + "E911_ACTIVATION", + "OUTBOUND_MMS", + "INBOUND_MMS", + "CALL_TRANSCRIPTION", + "TEN_DLC_BRAND_REGISTRATION", + "TEN_DLC_CAMPAIGN_REGISTRATION", + "PHONE_NUMBER_ORDER", + "ADJUSTMENT_IN", + "URL_SHORTENER", + "TEN_DLC_BRAND_UPDATE", + "TEN_DLC_BRAND_APPEAL", + "AUDIO_TRANSCRIPTION", + "TEN_DLC_BRAND_VETTING", + "TEN_DLC_BRAND_VETTING_APPEAL", + "OUTBOUND_SMS_CARRIER_FEE", + "INBOUND_SMS_CARRIER_FEE", + "OUTBOUND_MMS_CARRIER_FEE", + "INBOUND_MMS_CARRIER_FEE", + "TEN_DLC_CAMPAIGN_VETTING_FEE", + "OUTBOUND_SMS_SEGMENT", + "INBOUND_SMS_SEGMENT", + "OUTBOUND_MMS_SEGMENT", + "INBOUND_MMS_SEGMENT" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / is_emptyAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether there are no transactions.", + "example": false +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - ] - } - } - ] -} - added
Output schema / properties / transactionsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "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": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Transaction amount. Negative values decrease balance.", + "example": -0.99, + "format": "float" + }, + "balance_after": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Account balance after the transaction.", + "example": 309.0601, + "format": "float" + }, + "date": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Creation date and time in ISO 8601 format.", + "example": "2023-08-29T14:48:38.000Z", + "format": "date-time" + }, + "details": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Transaction details.", + "example": "Monthly fee for 16419252149" + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Transaction ID.", + "example": 24789389, + "format": "int64" + }, + "show_invoice": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "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 + }, + "status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Current status of the transaction. One of `Created` (the transaction was created but not yet processed), `Pending` (the transaction is being processed), `Committed` (the transaction was applied to the balance), or `Reverted` (the transaction was rolled back).", + "enum": [ + "Created", + "Pending", + "Committed", + "Reverted", + null + ], + "title": "TransactionStatus" + }, + "type": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Transaction type:\n * 0 - Payment adjustment\n * 2 - Phone number activation fee\n * 3 - Phone number monthly fees\n * 6 - Phone number 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 - Phone number 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 * 56 - 10DLC Campaign vetting 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, + null + ], + "title": "TransactionType", + "x-enum-varnames": [ + "PAYMENT_ADJUSTMENT", + "PHONE_NUMBER_ACTIVATION_FEE", + "PHONE_NUMBER_MONTHLY_FEES", + "PHONE_NUMBER_FORWARDING", + "PSTN_FORWARDING_FEE", + "OUTBOUND_CALL", + "OUTBOUND_SMS", + "CREDIT_CARD_PAYMENT", + "PAYMENT_FEE", + "PORTING_FEE", + "INBOUND_SMS", + "ADMIN_PAYMENT", + "SUBSCRIPTION_PAYMENT", + "NUMBER_VALIDATOR", + "CALL_RECORDING", + "STORAGE_CHARGE", + "CAMPAIGN_BUILDER", + "VOICEMAIL_DETECTION", + "SENDER_ID_REGISTRATION", + "SENDER_ID_MONTHLY_FEE", + "TWO_FA", + "IVR", + "E911_ACTIVATION", + "OUTBOUND_MMS", + "INBOUND_MMS", + "CALL_TRANSCRIPTION", + "TEN_DLC_BRAND_REGISTRATION", + "TEN_DLC_CAMPAIGN_REGISTRATION", + "PHONE_NUMBER_ORDER", + "ADJUSTMENT_IN", + "URL_SHORTENER", + "TEN_DLC_BRAND_UPDATE", + "TEN_DLC_BRAND_APPEAL", + "AUDIO_TRANSCRIPTION", + "TEN_DLC_BRAND_VETTING", + "TEN_DLC_BRAND_VETTING_APPEAL", + "OUTBOUND_SMS_CARRIER_FEE", + "INBOUND_SMS_CARRIER_FEE", + "OUTBOUND_MMS_CARRIER_FEE", + "INBOUND_MMS_CARRIER_FEE", + "TEN_DLC_CAMPAIGN_VETTING_FEE", + "OUTBOUND_SMS_SEGMENT", + "INBOUND_SMS_SEGMENT", + "OUTBOUND_MMS_SEGMENT", + "INBOUND_MMS_SEGMENT" + ] + } + }, + "required": [ + "id", + "date", + "amount", + "balance_after", + "details", + "status", + "type", + "show_invoice" + ], + "title": "FinancialTransaction", + "type": "object" + } +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "is_empty", + "transactions", + "pagination" +] - added
Output schema / titleAdded value: +"BillingTransactionListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
buy_cities_list10 fields changed- removed
Input schema / properties / countryRemoved value: -{ - "description": "Country ID.", - "example": 1891, - "format": "int32", - "type": "integer" -} - added
Input schema / properties / country_idAdded value: +{ + "description": "The unique ID of the country.", + "example": 1891, + "format": "int32", + "type": "integer" +} - changed
Input schema / properties / text_enabled_only / descriptionPrevious value: -"Indicates whether to return only cities with text-enabled numbers."New value: +"When `true`, returns only cities that offer text-enabled numbers." - changed
Input schema / requiredPrevious value: -[ - "country" -]New value: +[ + "country_id" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / citiesAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Cities available for the requested country or region.", + "items": { + "additionalProperties": false, + "properties": { + "area_code": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Rate center." + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "City ID.", + "example": 3213, + "format": "int32" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "City name.", + "example": "Paris" + } + }, + "required": [ + "id", + "name", + "area_code" + ], + "title": "City", + "type": "object" + } +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "cities" +] - added
Output schema / titleAdded value: +"CityListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
buy_countries_list7 fields changed- changed
Input schema / properties / text_enabled_only / descriptionPrevious value: -"Indicates whether to return only countries with text-enabled phone numbers."New value: +"When `true`, returns only countries that offer text-enabled phone numbers." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / countriesAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Countries where phone numbers are available.", + "items": { + "additionalProperties": false, + "properties": { + "has_provinces_or_states": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the country has regions.", + "example": false + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Country ID.", + "example": 8148, + "format": "int32" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Country name.", + "example": "France" + } + }, + "required": [ + "id", + "name", + "has_provinces_or_states" + ], + "title": "Country", + "type": "object" + } +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "countries" +] - added
Output schema / titleAdded value: +"CountryListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
buy_numbers_list15 fields changed- removed
Input schema / properties / cityRemoved value: -{ - "description": "City ID.", - "format": "int32", - "type": "integer" -} - added
Input schema / properties / city_idAdded value: +{ + "description": "The unique ID of the city.", + "format": "int32", + "type": "integer" +} - removed
Input schema / properties / countryRemoved value: -{ - "description": "Country ID.", - "format": "int32", - "type": "integer" -} - added
Input schema / properties / country_idAdded value: +{ + "description": "The unique ID of the country.", + "format": "int32", + "type": "integer" +} - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / text_enabled_only / descriptionPrevious value: -"Indicates whether to return only text-enabled phone numbers."New value: +"When `true`, returns only text-enabled phone numbers." - changed
Input schema / requiredPrevious value: -[ - "country", - "city" -]New value: +[ + "country_id", + "city_id" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / didsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Phone numbers available for purchase that match the search criteria.", + "items": { + "additionalProperties": false, + "description": "Phone number available for purchase.", + "properties": { + "activation_fee": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "One-time activation fee in USD.", + "example": "15.0" + }, + "channels": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Maximum number of concurrent inbound calls.", + "example": "4", + "format": "int32" + }, + "city": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "City where the phone number originates.", + "example": "Buenos Aires" + }, + "cnam": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether CNAM can be activated.", + "example": false + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Country where the phone number originates.", + "example": "Argentina" + }, + "country_short_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Two-letter ISO country code.", + "example": "AR" + }, + "domestic_cli": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the number can be used as the Caller ID for local calls.", + "example": true + }, + "free_min": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of free inbound minutes.", + "example": 0, + "format": "int32" + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Phone number ID.", + "example": 541139862174, + "format": "int64" + }, + "monthly_fee": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Monthly fee in USD.", + "example": "10.0" + }, + "number": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number in E.164 format.", + "example": "541139862174" + }, + "per_min": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Price per inbound minute in USD.", + "example": "0.01" + }, + "require_docs": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Documents required to activate the phone number.", + "example": [ + 1, + 3 + ], + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "format": "int32" + } + }, + "sms_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number can receive inbound\n SMS and MMS messages.", + "example": false + }, + "sms_price": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Price per inbound SMS segment in USD.", + "example": 0, + "format": "float" + } + }, + "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" + } +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "dids", + "pagination" +] - added
Output schema / titleAdded value: +"AvailableNumberListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
buy_region_cities_list12 fields changed- removed
Input schema / properties / countryRemoved value: -{ - "description": "Country ID.", - "example": 1891, - "format": "int32", - "type": "integer" -} - added
Input schema / properties / country_idAdded value: +{ + "description": "The unique ID of the country.", + "example": 1891, + "format": "int32", + "type": "integer" +} - removed
Input schema / properties / regionRemoved value: -{ - "description": "Region ID.", - "example": 821, - "format": "int32", - "type": "integer" -} - added
Input schema / properties / region_idAdded value: +{ + "description": "The unique ID of the region.", + "example": 821, + "format": "int32", + "type": "integer" +} - changed
Input schema / properties / text_enabled_only / descriptionPrevious value: -"Indicates whether to return only cities with text-enabled numbers."New value: +"When `true`, returns only cities that offer text-enabled numbers." - changed
Input schema / requiredPrevious value: -[ - "country", - "region" -]New value: +[ + "country_id", + "region_id" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / citiesAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Cities available for the requested country or region.", + "items": { + "additionalProperties": false, + "properties": { + "area_code": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Rate center." + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "City ID.", + "example": 3213, + "format": "int32" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "City name.", + "example": "Paris" + } + }, + "required": [ + "id", + "name", + "area_code" + ], + "title": "City", + "type": "object" + } +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "cities" +] - added
Output schema / titleAdded value: +"CityListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
buy_regions_list10 fields changed- removed
Input schema / properties / countryRemoved value: -{ - "description": "Country ID.", - "example": 1892, - "format": "int32", - "type": "integer" -} - added
Input schema / properties / country_idAdded value: +{ + "description": "The unique ID of the country.", + "example": 1892, + "format": "int32", + "type": "integer" +} - changed
Input schema / properties / text_enabled_only / descriptionPrevious value: -"Indicates whether to return only regions with text-enabled numbers."New value: +"When `true`, returns only regions that offer text-enabled numbers." - changed
Input schema / requiredPrevious value: -[ - "country" -]New value: +[ + "country_id" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / regionsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "States or provinces available for the requested country.", + "items": { + "additionalProperties": false, + "description": "State or province of the country, if applicable.", + "properties": { + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Region ID.", + "example": 17, + "format": "int32" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Region name.", + "example": "California" + } + }, + "required": [ + "id", + "name" + ], + "title": "Region", + "type": "object" + } +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "regions" +] - added
Output schema / titleAdded value: +"RegionListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
call_control_answer9 fields changed- added
Input schema / properties / idAdded value: +{ + "description": "The `uuid` of the call.", + "format": "uuid", + "type": "string" +} - added
Input schema / properties / stream_channel / descriptionAdded value: +"Audio channel streamed to `stream_url`." - added
Input schema / properties / stream_type / descriptionAdded value: +"Direction of audio streamed to `stream_url`." - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "id" +] - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
call_control_audio_play8 fields changed- changed
Input schema / properties / audio_file / descriptionPrevious value: -"URL of the audio file to play"New value: +"URL of the audio file to play to the call." - added
Input schema / properties / idAdded value: +{ + "description": "The `uuid` of the call.", + "format": "uuid", + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid", - "audio_file" -]New value: +[ + "id", + "audio_file" +] - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
call_control_audio_stop7 fields changed- added
Input schema / properties / idAdded value: +{ + "description": "The `uuid` of the call.", + "format": "uuid", + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "id" +] - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
call_control_collect11 fields changed- added
Input schema / properties / idAdded value: +{ + "description": "The `uuid` of the call.", + "format": "uuid", + "type": "string" +} - changed
Input schema / properties / prompt / properties / say / descriptionPrevious value: -"Text to speak and voice to use."New value: +"Text to speak and voice to use. Pick `voice` from the language family matching `language` (for example, a German voice such as `Hans` for `ge`, a Spanish voice such as `Conchita` for `sp`) — Wavix does not validate the pairing itself." - changed
Input schema / properties / prompt / properties / say / properties / language / descriptionPrevious value: -"Language"New value: +"Language used for text-to-speech synthesis. One of `ru` (Russian), `en` (English), `sp` (Spanish), or `ge` (German). `sp` and `ge` are Wavix-specific codes, not the standard ISO 639-1 codes for Spanish (`es`) and German (`de`)." - changed
Input schema / properties / prompt / properties / say / properties / text / examplePrevious value: -"Please enter your PIN"New value: +"Press 1 for sales, press 2 for support, or press 3 to repeat this menu." - changed
Input schema / properties / prompt / properties / say / properties / voice / descriptionPrevious value: -"Voice"New value: +"Named text-to-speech voice used to read the message. Each value selects a distinct synthesized voice. One of `Ivy`, `Joanna`, `Kendra`, `Kimberly`, `Salli`, `Joey`, `Justin`, or `Matthew` (English voices); `Conchita`, `Lucia`, or `Enrique` (Spanish voices); `Marlene`, `Vicki`, or `Hans` (German voices); or `Tatyana` or `Maxim` (Russian voices)." - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "id" +] - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
call_control_create30 fields changed- changed
Input schema / properties / from / descriptionPrevious value: -"Caller ID. Must be an active or verified phone number in your account."New value: +"Caller ID. Must be an active or verified phone number on the account." - added
Output schema / properties / call_answered / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call_answered / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / call_completed / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call_completed / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / call_started / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call_started / typeRemoved value: -"string" - added
Output schema / properties / direction / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / direction / descriptionPrevious value: -"Call direction - inbound or outbound"New value: +"Direction of the call. One of `inbound` (call received by the account) or `outbound` (call placed by the account)." - changed
Output schema / properties / direction / enumPrevious value: -[ - "inbound", - "outbound" -]New value: +[ + "inbound", + "outbound", + null +] - removed
Output schema / properties / direction / typeRemoved value: -"string" - changed
Output schema / properties / event_payload / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Payload for the `on_call_event` event type.", + "properties": { + "payload": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Type of in-call sub-event. One of `audio` (audio playback progress) or `collect` (DTMF digit collection progress).", + "enum": [ + "audio", + "collect", + null + ], + "example": "audio" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + { + "type": "null" + } +] - added
Output schema / properties / event_time / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / event_time / typeRemoved value: -"string" - added
Output schema / properties / event_type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / event_type / descriptionPrevious value: -"The latest call event"New value: +"Most recent lifecycle event for the call. One of:\n\n- `call_setup` — the call is being initiated.\n- `ringing` — the destination is ringing.\n- `early_media` — early media (such as ringback) is playing before answer.\n- `answered` — the destination answered the call.\n- `completed` — the call ended normally.\n- `busy` — the destination was busy.\n- `cancelled` — the call was cancelled before answer.\n- `rejected` — the destination rejected the call.\n- `on_call_event` — an in-call event occurred (see `event_payload`)." - changed
Output schema / properties / event_type / enumPrevious value: -[ - "call_setup", - "ringing", - "early_media", - "answered", - "completed", - "busy", - "cancelled", - "rejected", - "on_call_event" -]New value: +[ + "call_setup", + "ringing", + "early_media", + "answered", + "completed", + "busy", + "cancelled", + "rejected", + "on_call_event", + null +] - removed
Output schema / properties / event_type / typeRemoved value: -"string" - added
Output schema / properties / from / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / from / typeRemoved value: -"string" - added
Output schema / properties / idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call ID. Alias of `uuid`.", + "example": "5dccb6b0-f35c-488c-867b-86fb012c4415", + "format": "uuid" +} - added
Output schema / properties / machine_detected / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / machine_detected / typeRemoved value: -"boolean" - added
Output schema / properties / tag / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / tag / typeRemoved value: -"string" - added
Output schema / properties / to / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / to / typeRemoved value: -"string" - added
Output schema / properties / uuid / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / uuid / descriptionPrevious value: -"Call ID"New value: +"Call ID. Deprecated — use `id` instead." - removed
Output schema / properties / uuid / typeRemoved value: -"string"
- Changed
call_control_delete7 fields changed- added
Input schema / properties / idAdded value: +{ + "description": "The `uuid` of the call.", + "format": "uuid", + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "id" +] - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
call_control_get35 fields changed- added
Input schema / properties / idAdded value: +{ + "description": "The `uuid` of the call.", + "format": "uuid", + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "id" +] - added
Output schema / properties / call / properties / call_answered / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call / properties / call_answered / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / call / properties / call_completed / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call / properties / call_completed / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / call / properties / call_started / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call / properties / call_started / typeRemoved value: -"string" - added
Output schema / properties / call / properties / direction / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / call / properties / direction / descriptionPrevious value: -"Call direction - inbound or outbound"New value: +"Direction of the call. One of `inbound` (call received by the account) or `outbound` (call placed by the account)." - changed
Output schema / properties / call / properties / direction / enumPrevious value: -[ - "inbound", - "outbound" -]New value: +[ + "inbound", + "outbound", + null +] - removed
Output schema / properties / call / properties / direction / typeRemoved value: -"string" - changed
Output schema / properties / call / properties / event_payload / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Payload for the `on_call_event` event type.", + "properties": { + "payload": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Type of in-call sub-event. One of `audio` (audio playback progress) or `collect` (DTMF digit collection progress).", + "enum": [ + "audio", + "collect", + null + ], + "example": "audio" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + { + "type": "null" + } +] - added
Output schema / properties / call / properties / event_time / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call / properties / event_time / typeRemoved value: -"string" - added
Output schema / properties / call / properties / event_type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / call / properties / event_type / descriptionPrevious value: -"Latest call event."New value: +"Most recent lifecycle event for the call. One of:\n\n- `call_setup` — the call is being initiated.\n- `ringing` — the destination is ringing.\n- `early_media` — early media (such as ringback) is playing before answer.\n- `answered` — the destination answered the call.\n- `completed` — the call ended normally.\n- `busy` — the destination was busy.\n- `cancelled` — the call was cancelled before answer.\n- `rejected` — the destination rejected the call.\n- `on_call_event` — an in-call event occurred (see `event_payload`)." - changed
Output schema / properties / call / properties / event_type / enumPrevious value: -[ - "call_setup", - "ringing", - "early_media", - "answered", - "completed", - "busy", - "cancelled", - "rejected", - "on_call_event" -]New value: +[ + "call_setup", + "ringing", + "early_media", + "answered", + "completed", + "busy", + "cancelled", + "rejected", + "on_call_event", + null +] - removed
Output schema / properties / call / properties / event_type / typeRemoved value: -"string" - added
Output schema / properties / call / properties / from / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call / properties / from / typeRemoved value: -"string" - added
Output schema / properties / call / properties / idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call ID. Alias of `uuid`.", + "example": "5dccb6b0-f35c-488c-867b-86fb012c4415", + "format": "uuid" +} - added
Output schema / properties / call / properties / machine_detected / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call / properties / machine_detected / typeRemoved value: -"boolean" - added
Output schema / properties / call / properties / tag / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call / properties / tag / typeRemoved value: -"string" - added
Output schema / properties / call / properties / to / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call / properties / to / typeRemoved value: -"string" - added
Output schema / properties / call / properties / uuid / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / call / properties / uuid / descriptionPrevious value: -"Call ID."New value: +"Call ID. Deprecated — use `id` instead." - removed
Output schema / properties / call / properties / uuid / typeRemoved value: -"string" - changed
Output schema / properties / call / requiredPrevious value: -[ - "uuid", - "event_type", - "event_time", - "event_payload", - "from", - "to", - "call_started", - "call_answered", - "call_completed", - "machine_detected", - "tag" -]New value: +[ + "uuid", + "id", + "event_type", + "event_time", + "event_payload", + "from", + "to", + "call_started", + "call_answered", + "call_completed", + "machine_detected", + "tag" +] - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean"
- Changed
call_control_list34 fields changed- added
Output schema / properties / calls / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / calls / items / properties / call_answered / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / calls / items / properties / call_answered / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / calls / items / properties / call_completed / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / calls / items / properties / call_completed / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / calls / items / properties / call_started / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / calls / items / properties / call_started / typeRemoved value: -"string" - added
Output schema / properties / calls / items / properties / direction / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / calls / items / properties / direction / descriptionPrevious value: -"Call direction - inbound or outbound"New value: +"Direction of the call. One of `inbound` (call received by the account) or `outbound` (call placed by the account)." - changed
Output schema / properties / calls / items / properties / direction / enumPrevious value: -[ - "inbound", - "outbound" -]New value: +[ + "inbound", + "outbound", + null +] - removed
Output schema / properties / calls / items / properties / direction / typeRemoved value: -"string" - changed
Output schema / properties / calls / items / properties / event_payload / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "description": "Payload for the `on_call_event` event type.", + "properties": { + "payload": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Type of in-call sub-event. One of `audio` (audio playback progress) or `collect` (DTMF digit collection progress).", + "enum": [ + "audio", + "collect", + null + ], + "example": "audio" + } + }, + "required": [ + "type" + ], + "type": "object" + }, + { + "type": "null" + } +] - added
Output schema / properties / calls / items / properties / event_time / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / calls / items / properties / event_time / typeRemoved value: -"string" - added
Output schema / properties / calls / items / properties / event_type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / calls / items / properties / event_type / descriptionPrevious value: -"Latest call event."New value: +"Most recent lifecycle event for the call. One of:\n\n- `call_setup` — the call is being initiated.\n- `ringing` — the destination is ringing.\n- `early_media` — early media (such as ringback) is playing before answer.\n- `answered` — the destination answered the call.\n- `completed` — the call ended normally.\n- `busy` — the destination was busy.\n- `cancelled` — the call was cancelled before answer.\n- `rejected` — the destination rejected the call.\n- `on_call_event` — an in-call event occurred (see `event_payload`)." - changed
Output schema / properties / calls / items / properties / event_type / enumPrevious value: -[ - "call_setup", - "ringing", - "early_media", - "answered", - "completed", - "busy", - "cancelled", - "rejected", - "on_call_event" -]New value: +[ + "call_setup", + "ringing", + "early_media", + "answered", + "completed", + "busy", + "cancelled", + "rejected", + "on_call_event", + null +] - removed
Output schema / properties / calls / items / properties / event_type / typeRemoved value: -"string" - added
Output schema / properties / calls / items / properties / from / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / calls / items / properties / from / typeRemoved value: -"string" - added
Output schema / properties / calls / items / properties / idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call ID. Alias of `uuid`.", + "example": "5dccb6b0-f35c-488c-867b-86fb012c4415", + "format": "uuid" +} - added
Output schema / properties / calls / items / properties / machine_detected / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / calls / items / properties / machine_detected / typeRemoved value: -"boolean" - added
Output schema / properties / calls / items / properties / tag / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / calls / items / properties / tag / typeRemoved value: -"string" - added
Output schema / properties / calls / items / properties / to / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / calls / items / properties / to / typeRemoved value: -"string" - added
Output schema / properties / calls / items / properties / uuid / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / calls / items / properties / uuid / descriptionPrevious value: -"Call ID."New value: +"Call ID. Deprecated — use `id` instead." - removed
Output schema / properties / calls / items / properties / uuid / typeRemoved value: -"string" - changed
Output schema / properties / calls / items / requiredPrevious value: -[ - "uuid", - "event_type", - "event_time", - "event_payload", - "from", - "to", - "call_started", - "call_answered", - "call_completed", - "machine_detected", - "tag" -]New value: +[ + "uuid", + "id", + "event_type", + "event_time", + "event_payload", + "from", + "to", + "call_started", + "call_answered", + "call_completed", + "machine_detected", + "tag" +] - removed
Output schema / properties / calls / typeRemoved value: -"array" - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean"
- Changed
call_control_streams_create9 fields changed- added
Input schema / properties / call_idAdded value: +{ + "description": "The `uuid` of the call.", + "format": "uuid", + "type": "string" +} - added
Input schema / properties / stream_channel / descriptionAdded value: +"Audio channel streamed to `stream_url`." - added
Input schema / properties / stream_type / descriptionAdded value: +"Direction of audio streamed to `stream_url`." - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid", - "stream_url", - "stream_type", - "stream_channel" -]New value: +[ + "call_id", + "stream_url", + "stream_type", + "stream_channel" +] - added
Output schema / properties / stream_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / stream_id / typeRemoved value: -"string" - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean"
- Changed
call_control_streams_delete9 fields changed- added
Input schema / properties / call_idAdded value: +{ + "description": "The `uuid` of the call.", + "format": "uuid", + "type": "string" +} - added
Input schema / properties / idAdded value: +{ + "description": "The `uuid` of the media stream to stop.", + "format": "uuid", + "type": "string" +} - removed
Input schema / properties / stream_uuidRemoved value: -{ - "description": "Stream ID.", - "format": "uuid", - "type": "string" -} - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid", - "stream_uuid" -]New value: +[ + "call_id", + "id" +] - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
call_control_update6 fields changed- added
Input schema / properties / idAdded value: +{ + "description": "The `uuid` of the call.", + "format": "uuid", + "type": "string" +} - changed
Input schema / properties / tag / descriptionPrevious value: -"Call metadata."New value: +"User-defined label attached to the Call for tracking or reporting." - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid", - "tag" -]New value: +[ + "id", + "tag" +] - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean"
- Changed
call_recording_delete6 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"Recording ID."New value: +"The unique ID of the call recording." - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - changed
Output schema / properties / success / descriptionPrevious value: -"Indicates whether the request succeeded."New value: +"Indicates whether the request was successful." - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
call_recording_get9 fields changed- removed
Input schema / additionalPropertiesRemoved value: -false - removed
Input schema / properties / call_uuidRemoved value: -{ - "type": "string" -} - added
Input schema / properties / idAdded value: +{ + "description": "The unique ID of the call recording.", + "example": 123, + "format": "int32", + "type": "integer" +} - changed
Input schema / requiredPrevious value: -[ - "call_uuid" -]New value: +[ + "id" +] - changed
Output schema / additionalPropertiesPrevious value: -trueNew value: +false - added
Output schema / descriptionAdded value: +"A call recording response" - added
Output schema / propertiesAdded value: +{ + "call_uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call ID.", + "example": "aa566501-c591-4a8b-b3b9-cc1295398b72" + }, + "created_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time when the recording was created in ISO 8601 format.", + "example": "2023-06-15T10:30:00Z", + "format": "date-time" + }, + "duration": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Recording duration in seconds.", + "example": 120, + "format": "int32" + }, + "from": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Originating phone number.", + "example": "1234567890" + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Recording ID.", + "example": 123, + "format": "int32" + }, + "to": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Destination phone number.", + "example": "0987654321" + }, + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Recording file URL.", + "example": "https://api.wavix.com/v1/recordings/uuid" + } +} - added
Output schema / requiredAdded value: +[ + "id", + "created_at", + "duration", + "from", + "to", + "call_uuid", + "url" +] - added
Output schema / titleAdded value: +"Recording"
- Added
call_recording_get_by_call - Changed
call_recording_list43 fields changed- changed
Input schema / properties / call_uuid / descriptionPrevious value: -"Call ID for filtering."New value: +"Filters recordings by the unique call ID." - changed
Input schema / properties / from / descriptionPrevious value: -"Originating phone number for filtering. Full or partial input accepted."New value: +"Filters recordings by originating phone number. Accepts a full or partial number." - changed
Input schema / properties / from_date / descriptionPrevious value: -"Start date in `YYYY-MM-DD` format."New value: +"Start of the date range to query, in `YYYY-MM-DD` format. Inclusive." - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / sip_trunks / descriptionPrevious value: -"List of SIP trunk logins to filter outbound calls."New value: +"Filters recordings of outbound calls placed through the listed SIP trunk logins." - changed
Input schema / properties / to / descriptionPrevious value: -"Destination phone number for filtering. Full or partial input accepted."New value: +"Filters recordings by destination phone number. Accepts a full or partial number." - changed
Input schema / properties / to_date / descriptionPrevious value: -"End date in `YYYY-MM-DD` format."New value: +"End of the date range to query, in `YYYY-MM-DD` format. Inclusive." - added
Output schema / properties / invalid / properties / dids / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / invalid / properties / dids / descriptionPrevious value: -"Invalid DID IDs"New value: +"Phone number IDs that did not match any recording." - added
Output schema / properties / invalid / properties / dids / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / invalid / properties / dids / items / typeRemoved value: -"string" - removed
Output schema / properties / invalid / properties / dids / typeRemoved value: -"array" - added
Output schema / properties / invalid / properties / sip_trunks / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / invalid / properties / sip_trunks / descriptionPrevious value: -"Invalid SIP trunk IDs"New value: +"SIP trunk IDs that did not match any recording." - added
Output schema / properties / invalid / properties / sip_trunks / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / invalid / properties / sip_trunks / items / typeRemoved value: -"string" - removed
Output schema / properties / invalid / properties / sip_trunks / typeRemoved value: -"array" - added
Output schema / properties / pagination / properties / current_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / current_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / per_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / per_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / total / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total_pages / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / total_pages / typeRemoved value: -"integer" - added
Output schema / properties / recordings / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / recordings / descriptionAdded value: +"Call recordings that match the request." - added
Output schema / properties / recordings / items / properties / call_uuid / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / recordings / items / properties / call_uuid / typeRemoved value: -"string" - added
Output schema / properties / recordings / items / properties / created_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / recordings / items / properties / created_at / typeRemoved value: -"string" - added
Output schema / properties / recordings / items / properties / duration / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / recordings / items / properties / duration / typeRemoved value: -"integer" - added
Output schema / properties / recordings / items / properties / from / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / recordings / items / properties / from / typeRemoved value: -"string" - added
Output schema / properties / recordings / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / recordings / items / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / recordings / items / properties / to / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / recordings / items / properties / to / typeRemoved value: -"string" - added
Output schema / properties / recordings / items / properties / url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / recordings / items / properties / url / typeRemoved value: -"string" - removed
Output schema / properties / recordings / typeRemoved value: -"array"
- Changed
call_webhooks_create9 fields changed- added
Output schema / properties / event_type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / event_type / descriptionPrevious value: -"Type of call events"New value: +"Type of call event the webhook subscribes to. One of `post-call` (delivered once after the call ends) or `on-call` (delivered for in-call events while the call is active)." - changed
Output schema / properties / event_type / enumPrevious value: -[ - "post-call", - "on-call" -]New value: +[ + "post-call", + "on-call", + null +] - removed
Output schema / properties / event_type / typeRemoved value: -"string" - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - added
Output schema / properties / success / descriptionAdded value: +"Indicates whether the request was successful." - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / properties / url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / url / typeRemoved value: -"string"
- Changed
call_webhooks_delete6 fields changed- changed
Input schema / properties / event_type / descriptionPrevious value: -"Use `post-call` to stop receiving post-call callbacks.\nUse `on-call` to stop receiving real-time call status updates."New value: +"Event type of the webhook to delete. One of `post-call` (callbacks sent after a call ends) or `on-call` (real-time call status callbacks during a call)." - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - added
Output schema / properties / success / descriptionAdded value: +"Indicates whether the request was successful." - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
call_webhooks_list8 fields changed- added
Output schema / properties / result / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / event_type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / event_type / descriptionPrevious value: -"Call event type."New value: +"Type of call event the webhook subscribes to. One of `post-call` (delivered once after the call ends) or `on-call` (delivered for in-call events while the call is active)." - changed
Output schema / properties / result / items / properties / event_type / enumPrevious value: -[ - "post-call", - "on-call" -]New value: +[ + "post-call", + "on-call", + null +] - removed
Output schema / properties / result / items / properties / event_type / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / url / typeRemoved value: -"string" - removed
Output schema / properties / result / typeRemoved value: -"array"
- Changed
cart_add5 fields changed- changed
Input schema / properties / ids / descriptionPrevious value: -"List of phone numbers to add to the cart."New value: +"Phone numbers to add to the cart." - removed
Output schema / properties / result / additionalPropertiesRemoved value: -false - added
Output schema / properties / result / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / itemsAdded value: +{ + "additionalProperties": false, + "description": "Phone number available for purchase.", + "properties": { + "activation_fee": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "One-time activation fee in USD.", + "example": "15.0" + }, + "channels": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Maximum number of concurrent inbound calls.", + "example": "4", + "format": "int32" + }, + "city": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "City where the phone number originates.", + "example": "Buenos Aires" + }, + "cnam": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether CNAM can be activated.", + "example": false + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Country where the phone number originates.", + "example": "Argentina" + }, + "country_short_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Two-letter ISO country code.", + "example": "AR" + }, + "domestic_cli": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the number can be used as the Caller ID for local calls.", + "example": true + }, + "free_min": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of free inbound minutes.", + "example": 0, + "format": "int32" + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Phone number ID.", + "example": 541139862174, + "format": "int64" + }, + "monthly_fee": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Monthly fee in USD.", + "example": "10.0" + }, + "number": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number in E.164 format.", + "example": "541139862174" + }, + "per_min": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Price per inbound minute in USD.", + "example": "0.01" + }, + "require_docs": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Documents required to activate the phone number.", + "example": [ + 1, + 3 + ], + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "format": "int32" + } + }, + "sms_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number can receive inbound\n SMS and MMS messages.", + "example": false + }, + "sms_price": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Price per inbound SMS segment in USD.", + "example": 0, + "format": "float" + } + }, + "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" +} - removed
Output schema / properties / result / typeRemoved value: -"array"
- Changed
cart_checkout6 fields changed- changed
Input schema / properties / ids / descriptionPrevious value: -"List of phone numbers to check out from the cart."New value: +"Phone numbers from the cart to purchase." - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
cart_get7 fields changed- added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / didsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "List of phone numbers in the cart.", + "items": { + "additionalProperties": false, + "description": "Phone number available for purchase.", + "properties": { + "activation_fee": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "One-time activation fee in USD.", + "example": "15.0" + }, + "channels": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Maximum number of concurrent inbound calls.", + "example": "4", + "format": "int32" + }, + "city": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "City where the phone number originates.", + "example": "Buenos Aires" + }, + "cnam": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether CNAM can be activated.", + "example": false + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Country where the phone number originates.", + "example": "Argentina" + }, + "country_short_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Two-letter ISO country code.", + "example": "AR" + }, + "domestic_cli": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the number can be used as the Caller ID for local calls.", + "example": true + }, + "free_min": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of free inbound minutes.", + "example": 0, + "format": "int32" + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Phone number ID.", + "example": 541139862174, + "format": "int64" + }, + "monthly_fee": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Monthly fee in USD.", + "example": "10.0" + }, + "number": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number in E.164 format.", + "example": "541139862174" + }, + "per_min": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Price per inbound minute in USD.", + "example": "0.01" + }, + "require_docs": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Documents required to activate the phone number.", + "example": [ + 1, + 3 + ], + "items": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "format": "int32" + } + }, + "sms_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number can receive inbound\n SMS and MMS messages.", + "example": false + }, + "sms_price": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Price per inbound SMS segment in USD.", + "example": 0, + "format": "float" + } + }, + "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" + } +} - added
Output schema / properties / doc_typesAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Document types required to activate phone numbers.", + "items": { + "additionalProperties": false, + "properties": { + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Document type ID.", + "example": 2, + "format": "int32" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Document type name.", + "example": "address" + }, + "title": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Human-readable document type name.", + "example": "Proof of address" + } + }, + "required": [ + "id", + "name", + "title" + ], + "title": "DocumentType", + "type": "object" + } +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "dids", + "doc_types" +] - added
Output schema / titleAdded value: +"CartResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
cart_remove6 fields changed- changed
Input schema / properties / ids / descriptionPrevious value: -"List of phone numbers to remove."New value: +"Phone numbers to remove from the cart." - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
cdrs_get26 fields changed- added
Input schema / properties / call_idAdded value: +{ + "description": "The unique ID of the call.", + "example": "aa566501-c591-4a8b-b3b9-cc1295398b72", + "format": "uuid", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" +} - changed
Input schema / properties / show_transcription / descriptionPrevious value: -"Indicates whether to include transcription."New value: +"When `true`, includes the call transcription in the response." - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "example": "aa566501-c591-4a8b-b3b9-cc1295398b72", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "call_id" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / answered_byAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Who answered the call. Possible values are `human`, `machine`.", + "example": "human" +} - added
Output schema / properties / call_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call ID. Alias of `uuid`.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" +} - added
Output schema / properties / chargeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Total charge for the call in USD.", + "example": "0.162" +} - added
Output schema / properties / dateAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call date and time in ISO 8601 format.", + "example": "2023-08-21T06:43:36.000Z", + "format": "date-time" +} - added
Output schema / properties / destinationAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / dispositionAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Final disposition of the call. One of `answered` (the called party answered), `noanswer` (no answer within the ring timeout), `busy` (the called party was busy), `failed` (the call could not be routed), or `all` (matches any disposition when used as a filter).", + "enum": [ + "answered", + "noanswer", + "busy", + "failed", + "all", + null + ], + "title": "CallDisposition" +} - added
Output schema / properties / durationAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Call duration in seconds.", + "example": 6, + "format": "int32" +} - added
Output schema / properties / forward_feeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "PSTN forwarding price in USD. For inbound calls only\n when forwarded to PSTN.", + "example": "0.0" +} - added
Output schema / properties / fromAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Caller ID (ANI).", + "example": "14302287001" +} - added
Output schema / properties / parent_call_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Parent call ID. Alias of `parent_uuid`.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" +} - added
Output schema / properties / parent_uuidAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Parent call ID. Deprecated — use `parent_call_id` instead.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" +} - added
Output schema / properties / per_minuteAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Price per minute in USD.", + "example": "0.027" +} - added
Output schema / properties / recording_urlAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - added
Output schema / properties / sip_trunkAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "System-generated SIP trunk login. For outbound calls only.", + "example": "32882" +} - added
Output schema / properties / toAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Dialed number (DNIS).", + "example": "33170363950" +} - added
Output schema / properties / transcriptionAdded value: +{ + "additionalProperties": false, + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "properties": { + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "URL for retrieving the full call transcription.", + "example": "https://api.wavix.com/v1/cdrs/40d6f322-048d-490b-95c7-4fc5c76a74db/transcription?appid=secret" + }, + "uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the call transcription.", + "example": "40d6f322-048d-490b-95c7-4fc5c76a74db" + } + }, + "required": [ + "uuid", + "url" + ], + "title": "TranscriptionReference" +} - added
Output schema / properties / uuidAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call ID. Deprecated — use `call_id` instead.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "date", + "from", + "to", + "disposition", + "duration", + "destination", + "per_minute", + "charge", + "uuid", + "call_id" +] - added
Output schema / titleAdded value: +"CDRResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
cdrs_list21 fields changed- removed
Input schema / properties / disposition / allOfRemoved value: -[ - { - "description": "Call disposition.", - "enum": [ - "answered", - "noanswer", - "busy", - "failed", - "all" - ], - "title": "CallDisposition", - "type": "string" - } -] - added
Input schema / properties / disposition / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / disposition / descriptionPrevious value: -"Call disposition to filter results. Allowed values: `answered`, `busy`, `rejected`,\n `failed`, `all`."New value: +"Final disposition of the call. One of `answered` (the called party answered), `noanswer` (no answer within the ring timeout), `busy` (the called party was busy), `failed` (the call could not be routed), or `all` (matches any disposition when used as a filter)." - added
Input schema / properties / disposition / enumAdded value: +[ + "answered", + "noanswer", + "busy", + "failed", + "all", + null +] - added
Input schema / properties / disposition / titleAdded value: +"CallDisposition" - changed
Input schema / properties / from / descriptionPrevious value: -"Start date in `YYYY-MM-DD` format."New value: +"Start of the date range to query, in `YYYY-MM-DD` format. Inclusive." - changed
Input schema / properties / from_search / descriptionPrevious value: -"Originating phone number for filtering. Full or partial input accepted."New value: +"Filters CDRs by originating phone number. Accepts a full or partial number." - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / sip_trunk / descriptionPrevious value: -"SIP trunk login to filter outbound calls. Ignored for inbound calls."New value: +"Filters outbound CDRs by SIP trunk login. Ignored for inbound calls." - changed
Input schema / properties / to / descriptionPrevious value: -"End date in `YYYY-MM-DD` format."New value: +"End of the date range to query, in `YYYY-MM-DD` format. Inclusive." - changed
Input schema / properties / to_search / descriptionPrevious value: -"Destination phone number for filtering. Full or partial input accepted."New value: +"Filters CDRs by destination phone number. Accepts a full or partial number." - changed
Input schema / properties / type / descriptionPrevious value: -"Call direction to filter results. Allowed values: `placed`, `received`."New value: +"Filters CDRs by call direction. One of `placed` (outbound calls dialed by the account) or `received` (inbound calls answered by the account)." - changed
Input schema / properties / uuid / descriptionPrevious value: -"Call ID to filter results."New value: +"Filters CDRs by the unique call ID." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / itemsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "List of CDRs", + "items": { + "additionalProperties": false, + "description": "Call detail record (CDR) for an individual call.", + "properties": { + "answered_by": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Who answered the call. Possible values are `human`, `machine`.", + "example": "human" + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call ID. Alias of `uuid`.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" + }, + "charge": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Total charge for the call in USD.", + "example": "0.822" + }, + "date": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time of the call in ISO 8601 format.", + "example": "2023-08-21T06:43:36.000Z", + "format": "date-time" + }, + "destination": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "disposition": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Final disposition of the call. One of `answered` (the called party answered), `noanswer` (no answer within the ring timeout), `busy` (the called party was busy), `failed` (the call could not be routed), or `all` (matches any disposition when used as a filter).", + "enum": [ + "answered", + "noanswer", + "busy", + "failed", + "all", + null + ], + "title": "CallDisposition" + }, + "duration": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Call duration in seconds.", + "example": 6, + "format": "int32" + }, + "forward_fee": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "PSTN forwarding price in USD. For inbound calls only when forwarded to PSTN.", + "example": "0.0" + }, + "from": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Originating phone number (ANI).", + "example": "14302287001" + }, + "parent_call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Parent call ID. Alias of `parent_uuid`.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" + }, + "parent_uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Parent call ID. Deprecated — use `parent_call_id` instead.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" + }, + "per_minute": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Price per minute in USD.", + "example": "0.027" + }, + "sip_trunk": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "System-generated SIP trunk login. For outbound calls only.", + "example": "32882" + }, + "to": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Destination phone number (DNIS).", + "example": "33170363950" + }, + "uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call ID. Deprecated — use `call_id` instead.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" + } + }, + "required": [ + "date", + "from", + "to", + "disposition", + "duration", + "destination", + "per_minute", + "charge", + "uuid", + "call_id" + ], + "title": "CDR", + "type": "object" + } +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "items", + "pagination" +] - added
Output schema / titleAdded value: +"CDRListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Removed
cdrs_list_all - Changed
cdrs_retranscribe10 fields changed- added
Input schema / properties / call_idAdded value: +{ + "description": "The unique ID of the call.", + "example": "bbaa37bf-430a-46da-ade3-c248e4070160", + "format": "uuid", + "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$", + "type": "string" +} - added
Input schema / properties / language / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / language / descriptionPrevious value: -"Language."New value: +"Language of the transcription, as a two-letter ISO 639-1 code. One of `en` (English), `de` (German), `es` (Spanish), `fr` (French), or `it` (Italian). `null` lets the platform auto-detect the language." - removed
Input schema / properties / language / typeRemoved value: -[ - "string", - "null" -] - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Call ID.", - "example": "bbaa37bf-430a-46da-ade3-c248e407016", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "call_id" +] - removed
Output schema / additionalPropertiesRemoved value: -false - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
cdrs_search18 fields changed- removed
Input schema / properties / disposition / allOfRemoved value: -[ - { - "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" - } -] - added
Input schema / properties / disposition / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - added
Input schema / properties / disposition / descriptionAdded value: +"Final disposition of the call. One of `answered` (the called party answered), `noanswer` (no answer within the ring timeout), `busy` (the called party was busy), `failed` (the call could not be routed), or `all` (matches any disposition when used as a filter)." - added
Input schema / properties / disposition / enumAdded value: +[ + "answered", + "noanswer", + "busy", + "failed", + "all", + null +] - added
Input schema / properties / disposition / titleAdded value: +"CallDisposition" - added
Input schema / properties / page / defaultAdded value: +1 - added
Input schema / properties / per_page / defaultAdded value: +25 - changed
Input schema / properties / per_page / examplePrevious value: -50New value: +25 - removed
Input schema / properties / transcription / requiredRemoved value: -[ - "agent", - "client", - "any" -] - changed
Input schema / properties / type / descriptionPrevious value: -"Search transcriptions by call type."New value: +"Filters by call type. One of `placed` (outbound calls dialed by the account) or `received` (inbound calls answered by the account)." - changed
Input schema / requiredPrevious value: -[ - "type", - "from", - "to", - "page", - "per_page" -]New value: +[ + "type", + "from", + "to" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / itemsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "List of CDRs with transcription links.", + "items": { + "additionalProperties": false, + "description": "A CDR of a single call with call transcription", + "properties": { + "answered_by": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Who answered the call. Allowed values are `human`, `machine`.", + "example": "human" + }, + "call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call ID. Alias of `uuid`.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" + }, + "charge": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Total charge for the call, in USD" + }, + "date": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time of the call", + "example": "2023-08-21T06:43:36.000Z", + "format": "date-time" + }, + "destination": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "disposition": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Final disposition of the call. One of `answered` (the called party answered), `noanswer` (no answer within the ring timeout), `busy` (the called party was busy), `failed` (the call could not be routed), or `all` (matches any disposition when used as a filter).", + "enum": [ + "answered", + "noanswer", + "busy", + "failed", + "all", + null + ], + "title": "CallDisposition" + }, + "duration": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Duration of the call, in seconds", + "example": 6, + "format": "int32" + }, + "forward_fee": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "PSTN forwarding price, in USD. For `received` calls only when forwarded to PSTN.", + "example": "0.0" + }, + "from": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ANI/From attribute of the call", + "example": "14302287001" + }, + "parent_call_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Parent call ID. Alias of `parent_uuid`.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" + }, + "parent_uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Parent call ID. Deprecated — use `parent_call_id` instead.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" + }, + "per_minute": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Price per minute, in USD", + "example": "0.027" + }, + "sip_trunk": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "System-generated login of a SIP trunk. For `placed` calls only.", + "example": "32882" + }, + "to": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "DNIS/To attribute of the call", + "example": "33170363950" + }, + "transcription": { + "additionalProperties": false, + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "properties": { + "url": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "URL for retrieving the full call transcription.", + "example": "https://api.wavix.com/v1/cdrs/40d6f322-048d-490b-95c7-4fc5c76a74db/transcription?appid=secret" + }, + "uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the call transcription.", + "example": "40d6f322-048d-490b-95c7-4fc5c76a74db" + } + }, + "required": [ + "uuid", + "url" + ], + "title": "TranscriptionReference" + }, + "uuid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Call ID. Deprecated — use `call_id` instead.", + "example": "99df5ffd-962a-410f-bcce-d08f1f7f328c" + } + }, + "required": [ + "date", + "from", + "to", + "disposition", + "duration", + "destination", + "per_minute", + "charge", + "uuid", + "call_id", + "transcription" + ], + "title": "CDRWithTranscription", + "type": "object" + } +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "items", + "pagination" +] - added
Output schema / titleAdded value: +"CDRTranscriptionSearchResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Removed
cdrs_transcription_get - Added
cdrs_transcriptions - Changed
link_shortener_create13 fields changed- changed
Input schema / properties / fallback_url / descriptionPrevious value: -"Fallback URL for expired or invalid links."New value: +"Fallback URL for expired or invalid links. Must be `https://` — same open-redirect/phishing considerations as `link` apply." - added
Input schema / properties / fallback_url / formatAdded value: +"uri" - added
Input schema / properties / fallback_url / patternAdded value: +"^https://" - changed
Input schema / properties / link / descriptionPrevious value: -"Target URL to shorten."New value: +"Target URL to shorten. Must be `https://` — the short link is publicly resolvable and redirects any visitor here, so only pass URLs you trust; this endpoint is a common target for open-redirect and phishing abuse." - added
Input schema / properties / link / formatAdded value: +"uri" - added
Input schema / properties / link / patternAdded value: +"^https://" - changed
Input schema / properties / phone / descriptionPrevious value: -"Phone number for the short link."New value: +"Phone number the short link is associated with, in E.164 format (without the leading `+`). Used to attribute click metrics returned by short link metrics list." - added
Output schema / additionalPropertiesAdded value: +false - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "additionalProperties": false, - "properties": { - "short_link": { - "description": "Generated short URL.", - "example": "https://wx.com/hd82Jhs21", - "type": "string" - } - }, - "required": [ - "short_link" - ], - "title": "ShortLinkResponse", - "type": "object" - } - ] -} - added
Output schema / properties / short_linkAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Generated short URL.", + "example": "https://wx.com/hd82Jhs21" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "short_link" +] - added
Output schema / titleAdded value: +"ShortLinkResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
link_shortener_metrics_list13 fields changed- changed
Input schema / properties / from / descriptionPrevious value: -"Start date in `YYYY-MM-DD` format."New value: +"Start of the date range to query, in `YYYY-MM-DD` format. Inclusive." - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / phone / descriptionPrevious value: -"Phone number for filtering."New value: +"Filters metrics by the phone number associated with the click, in E.164 format." - changed
Input schema / properties / to / descriptionPrevious value: -"End date in `YYYY-MM-DD` format."New value: +"End of the date range to query, in `YYYY-MM-DD` format. Inclusive." - changed
Input schema / properties / utm_campaign / descriptionPrevious value: -"UTM campaign name for filtering."New value: +"Filters metrics by `utm_campaign` name." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / metricsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "List of short link metrics matching search criteria.", + "items": { + "additionalProperties": false, + "properties": { + "browser": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Browser used to open the short link.", + "example": "Firefox" + }, + "created_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time when short link was opened.", + "example": "2023-07-19 18:23:42" + }, + "language": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Browser language preference.", + "example": "English" + }, + "latitude": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Latitude of the location derived from the IP address\n used to open the short link.", + "example": 59.3247 + }, + "link_hash": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Hash of the short link.", + "example": "hd82Jhs21" + }, + "longitude": { + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Longitude of the location derived from the IP address\n used to open the short link.", + "example": 18.056 + }, + "operating_system": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Operating system of the device that opened the short link.", + "example": "Mac OS X 10.15" + }, + "phone": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number associated with the short link.", + "example": "12762025555" + }, + "user_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Account ID.", + "example": 100017 + }, + "utm_campaign": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "UTM campaign name associated with the short link.", + "example": "summer" + } + }, + "required": [ + "latitude", + "longitude", + "operating_system", + "browser", + "language", + "phone", + "utm_campaign", + "created_at", + "user_id", + "link_hash" + ], + "title": "ShortLinkMetricsItem", + "type": "object" + } +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "metrics", + "pagination" +] - added
Output schema / titleAdded value: +"ShortLinkMetricsResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Added
my_numbers_bulk_update - Changed
my_numbers_delete7 fields changed- changed
Input schema / properties / dids / descriptionPrevious value: -"List of phone numbers to release."New value: +"Comma-separated phone numbers to release. Mutually exclusive with `ids`." - changed
Input schema / properties / ids / descriptionPrevious value: -"List of phone number IDs to release."New value: +"Record IDs of the phone numbers to release. Mutually exclusive with `dids`." - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Removed
my_numbers_destinations_update - Changed
my_numbers_get100 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"Phone number ID."New value: +"The unique ID of the phone number." - added
Output schema / properties / activation_fee / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / activation_fee / typeRemoved value: -"string" - added
Output schema / properties / added / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / added / typeRemoved value: -"string" - added
Output schema / properties / call_recording_enabled / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call_recording_enabled / typeRemoved value: -"boolean" - added
Output schema / properties / call_status_url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call_status_url / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / channels / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / channels / typeRemoved value: -"integer" - added
Output schema / properties / city / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / city / typeRemoved value: -"string" - added
Output schema / properties / cnam / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / cnam / typeRemoved value: -[ - "boolean", - "null" -] - added
Output schema / properties / country / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / country / typeRemoved value: -"string" - added
Output schema / properties / country_short_name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / country_short_name / typeRemoved value: -"string" - added
Output schema / properties / destination / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / destination / items / properties / destination / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / destination / items / properties / destination / typeRemoved value: -"string" - added
Output schema / properties / destination / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / destination / items / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / destination / items / properties / priority / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / destination / items / properties / priority / descriptionPrevious value: -"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."New value: +"For phone numbers with several destinations, sets the order in which the platform routes inbound calls. The lower the value, the higher the priority." - removed
Output schema / properties / destination / items / properties / priority / typeRemoved value: -"integer" - added
Output schema / properties / destination / items / properties / srtp / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - added
Output schema / properties / destination / items / properties / srtp / descriptionAdded value: +"Indicates whether SRTP media encryption is enabled for this destination." - removed
Output schema / properties / destination / items / properties / srtp / typeRemoved value: -"boolean" - added
Output schema / properties / destination / items / properties / transport / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / destination / items / properties / transport / descriptionPrevious value: -"Inbound call transport"New value: +"Transport used to route the inbound call to its destination. One of `1` (SIP URI), `4` (PSTN phone number), or `5` (SIP trunk on the platform)." - changed
Output schema / properties / destination / items / properties / transport / enumPrevious value: -[ - 1, - 4, - 5 -]New value: +[ + 1, + 4, + 5, + null +] - removed
Output schema / properties / destination / items / properties / transport / typeRemoved value: -"integer" - added
Output schema / properties / destination / items / properties / transport / x-enum-varnamesAdded value: +[ + "SIP_URI", + "PSTN", + "SIP_TRUNK" +] - added
Output schema / properties / destination / items / properties / trunk_id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / destination / items / properties / trunk_id / typeRemoved value: -[ - "integer", - "null" -] - added
Output schema / properties / destination / items / properties / trunk_label / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / destination / items / properties / trunk_label / typeRemoved value: -[ - "string", - "null" -] - removed
Output schema / properties / destination / typeRemoved value: -"array" - added
Output schema / properties / documents / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / documents / items / example / urlPrevious value: -"https://api.wavix.com/v1/mydids/24882/papers/1"New value: +"https://api.wavix.com/v1/numbers/24882/papers/1" - added
Output schema / properties / documents / items / properties / allow_replace / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - changed
Output schema / properties / documents / items / properties / allow_replace / descriptionPrevious value: -"Indicates if the document can be replaced. You can only replace documents with `rejected` status."New value: +"Indicates whether the document can be replaced. Only documents with `rejected` status can be replaced." - removed
Output schema / properties / documents / items / properties / allow_replace / typeRemoved value: -"boolean" - added
Output schema / properties / documents / items / properties / did_number / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / documents / items / properties / did_number / typeRemoved value: -"string" - added
Output schema / properties / documents / items / properties / doc_content_type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / documents / items / properties / doc_content_type / typeRemoved value: -"string" - added
Output schema / properties / documents / items / properties / doc_file_name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / documents / items / properties / doc_file_name / typeRemoved value: -"string" - added
Output schema / properties / documents / items / properties / doc_type_id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / documents / items / properties / doc_type_id / enumPrevious value: -[ - 1, - 2, - 3 -]New value: +[ + 1, + 2, + 3, + null +] - changed
Output schema / properties / documents / items / properties / doc_type_id / titlePrevious value: -"DocumentTypeId"New value: +"DocumentTypeID" - removed
Output schema / properties / documents / items / properties / doc_type_id / typeRemoved value: -"integer" - added
Output schema / properties / documents / items / properties / doc_type_id / x-enum-varnamesAdded value: +[ + "PROOF_OF_IDENTITY", + "PROOF_OF_ADDRESS", + "PROOF_OF_BUSINESS_REGISTRATION" +] - added
Output schema / properties / documents / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / documents / items / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / documents / items / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / documents / items / properties / status / typeRemoved value: -"string" - added
Output schema / properties / documents / items / properties / url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / documents / items / properties / url / examplePrevious value: -"https://api.wavix.com/v1/mydids/24882/papers/1\""New value: +"https://api.wavix.com/v1/numbers/24882/papers/1\"" - removed
Output schema / properties / documents / items / properties / url / typeRemoved value: -"string" - removed
Output schema / properties / documents / typeRemoved value: -"array" - added
Output schema / properties / domestic_cli / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / domestic_cli / typeRemoved value: -"boolean" - added
Output schema / properties / free_min / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / free_min / typeRemoved value: -"integer" - added
Output schema / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / label / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / label / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / monthly_fee / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / monthly_fee / typeRemoved value: -"string" - added
Output schema / properties / number / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / number / typeRemoved value: -"string" - added
Output schema / properties / paid_until / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / paid_until / typeRemoved value: -"string" - added
Output schema / properties / per_min / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / per_min / typeRemoved value: -"string" - added
Output schema / properties / require_docs / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / require_docs / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / require_docs / items / typeRemoved value: -"string" - removed
Output schema / properties / require_docs / typeRemoved value: -"array" - added
Output schema / properties / seconds / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / seconds / typeRemoved value: -"string" - added
Output schema / properties / sms_enabled / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sms_enabled / typeRemoved value: -"boolean" - added
Output schema / properties / sms_relay_url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sms_relay_url / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / state / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / state / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / status / typeRemoved value: -"string" - added
Output schema / properties / transcription_enabled / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / transcription_enabled / typeRemoved value: -"boolean" - added
Output schema / properties / transcription_threshold / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / transcription_threshold / typeRemoved value: -"integer" - added
Output schema / properties / unlimited / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / unlimited / typeRemoved value: -"boolean"
- Changed
my_numbers_list123 fields changed- changed
Input schema / properties / city_id / descriptionPrevious value: -"City or rate center for filtering."New value: +"Filters numbers by the ID of their city or rate center." - changed
Input schema / properties / label / descriptionPrevious value: -"Label for filtering."New value: +"Filters numbers by `label`." - changed
Input schema / properties / label_present / descriptionPrevious value: -"Indicates whether to return only numbers with or without labels."New value: +"When `true`, returns only numbers that have a label; when `false`, only numbers without one." - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / search / descriptionPrevious value: -"Phone number or partial number for filtering."New value: +"Filters numbers by a full or partial phone number." - added
Output schema / properties / doc_types / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / doc_types / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / doc_types / items / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / doc_types / items / properties / name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / doc_types / items / properties / name / typeRemoved value: -"string" - added
Output schema / properties / doc_types / items / properties / title / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / doc_types / items / properties / title / typeRemoved value: -"string" - removed
Output schema / properties / doc_types / typeRemoved value: -"array" - added
Output schema / properties / items / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / items / items / properties / activation_fee / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / activation_fee / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / added / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / added / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / call_recording_enabled / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / call_recording_enabled / typeRemoved value: -"boolean" - added
Output schema / properties / items / items / properties / call_status_url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / call_status_url / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / items / items / properties / channels / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / channels / typeRemoved value: -"integer" - added
Output schema / properties / items / items / properties / city / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / city / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / cnam / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / cnam / typeRemoved value: -[ - "boolean", - "null" -] - added
Output schema / properties / items / items / properties / country / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / country / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / country_short_name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / country_short_name / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / destination / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / items / items / properties / destination / items / properties / destination / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / destination / items / properties / destination / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / destination / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / destination / items / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / items / items / properties / destination / items / properties / priority / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / properties / destination / items / properties / priority / descriptionPrevious value: -"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."New value: +"For phone numbers with several destinations, sets the order in which the platform routes inbound calls. The lower the value, the higher the priority." - removed
Output schema / properties / items / items / properties / destination / items / properties / priority / typeRemoved value: -"integer" - added
Output schema / properties / items / items / properties / destination / items / properties / srtp / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - added
Output schema / properties / items / items / properties / destination / items / properties / srtp / descriptionAdded value: +"Indicates whether SRTP media encryption is enabled for this destination." - removed
Output schema / properties / items / items / properties / destination / items / properties / srtp / typeRemoved value: -"boolean" - added
Output schema / properties / items / items / properties / destination / items / properties / transport / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / properties / destination / items / properties / transport / descriptionPrevious value: -"Inbound call transport"New value: +"Transport used to route the inbound call to its destination. One of `1` (SIP URI), `4` (PSTN phone number), or `5` (SIP trunk on the platform)." - changed
Output schema / properties / items / items / properties / destination / items / properties / transport / enumPrevious value: -[ - 1, - 4, - 5 -]New value: +[ + 1, + 4, + 5, + null +] - removed
Output schema / properties / items / items / properties / destination / items / properties / transport / typeRemoved value: -"integer" - added
Output schema / properties / items / items / properties / destination / items / properties / transport / x-enum-varnamesAdded value: +[ + "SIP_URI", + "PSTN", + "SIP_TRUNK" +] - added
Output schema / properties / items / items / properties / destination / items / properties / trunk_id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / destination / items / properties / trunk_id / typeRemoved value: -[ - "integer", - "null" -] - added
Output schema / properties / items / items / properties / destination / items / properties / trunk_label / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / destination / items / properties / trunk_label / typeRemoved value: -[ - "string", - "null" -] - removed
Output schema / properties / items / items / properties / destination / typeRemoved value: -"array" - added
Output schema / properties / items / items / properties / documents / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / properties / documents / items / example / urlPrevious value: -"https://api.wavix.com/v1/mydids/24882/papers/1"New value: +"https://api.wavix.com/v1/numbers/24882/papers/1" - added
Output schema / properties / items / items / properties / documents / items / properties / allow_replace / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / properties / documents / items / properties / allow_replace / descriptionPrevious value: -"Indicates if the document can be replaced. You can only replace documents with `rejected` status."New value: +"Indicates whether the document can be replaced. Only documents with `rejected` status can be replaced." - removed
Output schema / properties / items / items / properties / documents / items / properties / allow_replace / typeRemoved value: -"boolean" - added
Output schema / properties / items / items / properties / documents / items / properties / did_number / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / documents / items / properties / did_number / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / documents / items / properties / doc_content_type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / documents / items / properties / doc_content_type / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / documents / items / properties / doc_file_name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / documents / items / properties / doc_file_name / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / documents / items / properties / doc_type_id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / properties / documents / items / properties / doc_type_id / enumPrevious value: -[ - 1, - 2, - 3 -]New value: +[ + 1, + 2, + 3, + null +] - changed
Output schema / properties / items / items / properties / documents / items / properties / doc_type_id / titlePrevious value: -"DocumentTypeId"New value: +"DocumentTypeID" - removed
Output schema / properties / items / items / properties / documents / items / properties / doc_type_id / typeRemoved value: -"integer" - added
Output schema / properties / items / items / properties / documents / items / properties / doc_type_id / x-enum-varnamesAdded value: +[ + "PROOF_OF_IDENTITY", + "PROOF_OF_ADDRESS", + "PROOF_OF_BUSINESS_REGISTRATION" +] - added
Output schema / properties / items / items / properties / documents / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / documents / items / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / items / items / properties / documents / items / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / documents / items / properties / status / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / documents / items / properties / url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / properties / documents / items / properties / url / examplePrevious value: -"https://api.wavix.com/v1/mydids/24882/papers/1\""New value: +"https://api.wavix.com/v1/numbers/24882/papers/1\"" - removed
Output schema / properties / items / items / properties / documents / items / properties / url / typeRemoved value: -"string" - removed
Output schema / properties / items / items / properties / documents / typeRemoved value: -"array" - added
Output schema / properties / items / items / properties / domestic_cli / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / domestic_cli / typeRemoved value: -"boolean" - added
Output schema / properties / items / items / properties / free_min / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / free_min / typeRemoved value: -"integer" - added
Output schema / properties / items / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / items / items / properties / label / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / label / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / items / items / properties / monthly_fee / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / monthly_fee / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / number / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / number / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / paid_until / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / paid_until / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / per_min / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / per_min / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / require_docs / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / items / items / properties / require_docs / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / require_docs / items / typeRemoved value: -"string" - removed
Output schema / properties / items / items / properties / require_docs / typeRemoved value: -"array" - added
Output schema / properties / items / items / properties / seconds / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / seconds / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / sms_enabled / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / sms_enabled / typeRemoved value: -"boolean" - added
Output schema / properties / items / items / properties / sms_relay_url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / sms_relay_url / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / items / items / properties / state / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / state / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / items / items / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / status / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / transcription_enabled / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / transcription_enabled / typeRemoved value: -"boolean" - added
Output schema / properties / items / items / properties / transcription_threshold / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / transcription_threshold / typeRemoved value: -"integer" - added
Output schema / properties / items / items / properties / unlimited / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / unlimited / typeRemoved value: -"boolean" - removed
Output schema / properties / items / typeRemoved value: -"array" - added
Output schema / properties / pagination / properties / current_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / current_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / per_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / per_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / total / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total_pages / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / total_pages / typeRemoved value: -"integer"
- Removed
my_numbers_papers_upload - Removed
my_numbers_sms_update - Changed
my_numbers_update108 fields changed- added
Input schema / properties / call_status_url / formatAdded value: +"uri" - added
Input schema / properties / destinationsAdded value: +{ + "description": "Inbound call routing destinations for the phone number.", + "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": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Transport used to route the inbound call to its destination. One of `1` (SIP URI), `4` (PSTN phone number), or `5` (SIP trunk on the platform).", + "enum": [ + 1, + 4, + 5, + null + ], + "title": "InboundCallTransport", + "x-enum-varnames": [ + "SIP_URI", + "PSTN", + "SIP_TRUNK" + ] + }, + "trunk_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "SIP trunk ID when `transport` is 5, otherwise null.", + "example": 23123, + "format": "int32" + } + }, + "required": [ + "destination", + "priority", + "transport" + ], + "title": "NumberDestination", + "type": "object" + }, + "type": "array" +} - changed
Input schema / properties / id / descriptionPrevious value: -"Phone number ID."New value: +"The unique ID of the phone number." - added
Input schema / properties / sms_enabledAdded value: +{ + "description": "Indicates whether SMS is enabled for the phone number.", + "example": true, + "type": "boolean" +} - changed
Input schema / properties / sms_relay_url / descriptionPrevious value: -"Callback URL for inbound messages. Set to `null`\n to remove routing."New value: +"Callback URL for inbound messages." - changed
Input schema / properties / sms_relay_url / examplePrevious value: -"https://you-site.com/sms"New value: +"https://your-site.com/sms" - added
Input schema / properties / sms_relay_url / formatAdded value: +"uri" - changed
Input schema / properties / transcription_enabled / descriptionPrevious value: -"Indicates whether transcription is enabled."New value: +"Indicates whether call transcription is enabled." - changed
Input schema / properties / transcription_threshold / descriptionPrevious value: -"Transcription threshold in seconds."New value: +"Minimum call duration in seconds before transcription runs." - added
Output schema / properties / activation_fee / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / activation_fee / typeRemoved value: -"string" - added
Output schema / properties / added / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / added / typeRemoved value: -"string" - added
Output schema / properties / call_recording_enabled / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call_recording_enabled / typeRemoved value: -"boolean" - added
Output schema / properties / call_status_url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / call_status_url / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / channels / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / channels / typeRemoved value: -"integer" - added
Output schema / properties / city / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / city / typeRemoved value: -"string" - added
Output schema / properties / cnam / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / cnam / typeRemoved value: -[ - "boolean", - "null" -] - added
Output schema / properties / country / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / country / typeRemoved value: -"string" - added
Output schema / properties / country_short_name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / country_short_name / typeRemoved value: -"string" - added
Output schema / properties / destination / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / destination / items / properties / destination / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / destination / items / properties / destination / typeRemoved value: -"string" - added
Output schema / properties / destination / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / destination / items / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / destination / items / properties / priority / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / destination / items / properties / priority / descriptionPrevious value: -"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."New value: +"For phone numbers with several destinations, sets the order in which the platform routes inbound calls. The lower the value, the higher the priority." - removed
Output schema / properties / destination / items / properties / priority / typeRemoved value: -"integer" - added
Output schema / properties / destination / items / properties / srtp / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - added
Output schema / properties / destination / items / properties / srtp / descriptionAdded value: +"Indicates whether SRTP media encryption is enabled for this destination." - removed
Output schema / properties / destination / items / properties / srtp / typeRemoved value: -"boolean" - added
Output schema / properties / destination / items / properties / transport / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / destination / items / properties / transport / descriptionPrevious value: -"Inbound call transport"New value: +"Transport used to route the inbound call to its destination. One of `1` (SIP URI), `4` (PSTN phone number), or `5` (SIP trunk on the platform)." - changed
Output schema / properties / destination / items / properties / transport / enumPrevious value: -[ - 1, - 4, - 5 -]New value: +[ + 1, + 4, + 5, + null +] - removed
Output schema / properties / destination / items / properties / transport / typeRemoved value: -"integer" - added
Output schema / properties / destination / items / properties / transport / x-enum-varnamesAdded value: +[ + "SIP_URI", + "PSTN", + "SIP_TRUNK" +] - added
Output schema / properties / destination / items / properties / trunk_id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / destination / items / properties / trunk_id / typeRemoved value: -[ - "integer", - "null" -] - added
Output schema / properties / destination / items / properties / trunk_label / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / destination / items / properties / trunk_label / typeRemoved value: -[ - "string", - "null" -] - removed
Output schema / properties / destination / typeRemoved value: -"array" - added
Output schema / properties / documents / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / documents / items / example / urlPrevious value: -"https://api.wavix.com/v1/mydids/24882/papers/1"New value: +"https://api.wavix.com/v1/numbers/24882/papers/1" - added
Output schema / properties / documents / items / properties / allow_replace / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - changed
Output schema / properties / documents / items / properties / allow_replace / descriptionPrevious value: -"Indicates if the document can be replaced. You can only replace documents with `rejected` status."New value: +"Indicates whether the document can be replaced. Only documents with `rejected` status can be replaced." - removed
Output schema / properties / documents / items / properties / allow_replace / typeRemoved value: -"boolean" - added
Output schema / properties / documents / items / properties / did_number / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / documents / items / properties / did_number / typeRemoved value: -"string" - added
Output schema / properties / documents / items / properties / doc_content_type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / documents / items / properties / doc_content_type / typeRemoved value: -"string" - added
Output schema / properties / documents / items / properties / doc_file_name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / documents / items / properties / doc_file_name / typeRemoved value: -"string" - added
Output schema / properties / documents / items / properties / doc_type_id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / documents / items / properties / doc_type_id / enumPrevious value: -[ - 1, - 2, - 3 -]New value: +[ + 1, + 2, + 3, + null +] - changed
Output schema / properties / documents / items / properties / doc_type_id / titlePrevious value: -"DocumentTypeId"New value: +"DocumentTypeID" - removed
Output schema / properties / documents / items / properties / doc_type_id / typeRemoved value: -"integer" - added
Output schema / properties / documents / items / properties / doc_type_id / x-enum-varnamesAdded value: +[ + "PROOF_OF_IDENTITY", + "PROOF_OF_ADDRESS", + "PROOF_OF_BUSINESS_REGISTRATION" +] - added
Output schema / properties / documents / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / documents / items / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / documents / items / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / documents / items / properties / status / typeRemoved value: -"string" - added
Output schema / properties / documents / items / properties / url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / documents / items / properties / url / examplePrevious value: -"https://api.wavix.com/v1/mydids/24882/papers/1\""New value: +"https://api.wavix.com/v1/numbers/24882/papers/1\"" - removed
Output schema / properties / documents / items / properties / url / typeRemoved value: -"string" - removed
Output schema / properties / documents / typeRemoved value: -"array" - added
Output schema / properties / domestic_cli / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / domestic_cli / typeRemoved value: -"boolean" - added
Output schema / properties / free_min / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / free_min / typeRemoved value: -"integer" - added
Output schema / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / label / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / label / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / monthly_fee / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / monthly_fee / typeRemoved value: -"string" - added
Output schema / properties / number / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / number / typeRemoved value: -"string" - added
Output schema / properties / paid_until / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / paid_until / typeRemoved value: -"string" - added
Output schema / properties / per_min / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / per_min / typeRemoved value: -"string" - added
Output schema / properties / require_docs / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / require_docs / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / require_docs / items / typeRemoved value: -"string" - removed
Output schema / properties / require_docs / typeRemoved value: -"array" - added
Output schema / properties / seconds / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / seconds / typeRemoved value: -"string" - added
Output schema / properties / sms_enabled / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sms_enabled / typeRemoved value: -"boolean" - added
Output schema / properties / sms_relay_url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sms_relay_url / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / state / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / state / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / status / typeRemoved value: -"string" - added
Output schema / properties / transcription_enabled / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / transcription_enabled / typeRemoved value: -"boolean" - added
Output schema / properties / transcription_threshold / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / transcription_threshold / typeRemoved value: -"integer" - added
Output schema / properties / unlimited / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / unlimited / typeRemoved value: -"boolean"
- Changed
number_validator_create_bulk9 fields changed- added
Input schema / properties / async / defaultAdded value: +false - changed
Input schema / properties / async / descriptionPrevious value: -"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."New value: +"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` (default), the response will include validation results directly." - added
Input schema / properties / force / defaultAdded value: +false - changed
Input schema / properties / force / descriptionPrevious value: -"Force"New value: +"Indicates whether to force a fresh validation instead of returning a previously cached result. Defaults to `false`." - changed
Input schema / properties / phone_numbers / descriptionPrevious value: -"List of phone numbers to get detailed information about."New value: +"List of phone numbers to get detailed information about. Maximum 1000 numbers per request." - added
Input schema / properties / phone_numbers / maxItemsAdded value: +1000 - added
Input schema / properties / type / descriptionAdded value: +"Depth of validation to perform on the phone number. One of `format` (checks number syntax only), `analysis` (returns number metadata such as type and country), or `validation` (performs a live network lookup of the number's current status)." - changed
Input schema / requiredPrevious value: -[ - "phone_numbers", - "type", - "async", - "force" -]New value: +[ + "phone_numbers", + "type" +] - changed
Output schema / properties / result / anyOfPrevious value: -[ - { - "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" - } -]New value: +[ + { + "additionalProperties": false, + "properties": { + "count": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of phone numbers in the request.", + "example": 1000, + "format": "int32" + }, + "items": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "List of validation results for each phone number.", + "items": { + "additionalProperties": false, + "description": "Number validator response details.", + "properties": { + "carrier_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Carrier name. `null` if the phone number is invalid.", + "example": "Etisalat" + }, + "charge": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Charge for the validation.", + "example": "0.015" + }, + "country_code": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number country code in ISO 3166-1 alpha-2 format. `null` if the number is invalid.", + "example": "AE" + }, + "e164_format": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number in international E.164 format.", + "example": "+971569483322" + }, + "error_code": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Result code for the validation. `000` indicates success. Possible values:\n- `013` — internal service error, uncategorized.\n- `021` — invalid phone number length or format.\n- `041` — remote timeout.\n- `042` — remote query failed.\n- `091` — insufficient funds.", + "example": "000" + }, + "mcc": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile Country Code (MCC). Applies to mobile numbers only. `null` if the phone number is invalid.", + "example": "424" + }, + "mnc": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile Network Code (MNC). Applies to mobile numbers only. `null` if the phone number is invalid.", + "example": "004" + }, + "national_format": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number in the national format of the identified country.", + "example": "056 948 3322" + }, + "number_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number type. Allowed values: `mobile`, `landline`, `toll-free`. `null` if the phone number is invalid.", + "example": "mobile" + }, + "phone_number": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number.", + "example": "971569483322" + }, + "ported": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number is ported. `null` if the phone number is invalid.", + "example": false + }, + "reachable": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "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 + }, + "risky_destination": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number belongs to a range associated with traffic pumping. `null` if the phone number is invalid.", + "example": false + }, + "roaming": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the number is roaming. Applies to mobile numbers only.\n `null` if the phone number is invalid.", + "example": false + }, + "timezone": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Time zone identified based on the country and area code. `null` if the phone number is invalid.", + "example": "UTC+04:00" + }, + "unallocated_range": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number belongs to an unallocated range.\n `null` if the phone number is invalid.", + "example": false + }, + "valid": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number is valid.", + "example": true + } + }, + "required": [ + "phone_number", + "valid", + "country_code", + "e164_format", + "national_format", + "charge", + "error_code" + ], + "title": "PhoneValidationResultResponse", + "type": "object" + } + }, + "pending": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of validations still in progress.", + "example": 0 + }, + "status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Validation request status.", + "example": "success" + } + }, + "required": [ + "count", + "items", + "status", + "pending" + ], + "title": "PhoneValidationBatchResponse", + "type": "object" + }, + { + "description": "Returned when validation runs asynchronously; poll results using `request_id`.", + "properties": { + "request_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Request ID. Use to poll validation results when `async` is `true`.", + "example": "15323ba4-80c1-41be-b8e7-07bb435c7445" + } + }, + "title": "Async Request", + "type": "object" + } +]
- Changed
number_validator_get28 fields changed- changed
Input schema / properties / phone_number / descriptionPrevious value: -"Phone number in E.164 format or without \"+\"."New value: +"The phone number to validate, in E.164 format with or without the leading `+`." - removed
Input schema / properties / type / allOfRemoved value: -[ - { - "enum": [ - "format", - "analysis", - "validation" - ], - "title": "PhoneNumberValidationType", - "type": "string" - } -] - changed
Input schema / properties / type / descriptionPrevious value: -"Validation type."New value: +"Depth of validation to perform on the phone number. One of `format` (checks number syntax only), `analysis` (returns number metadata such as type and country), or `validation` (performs a live network lookup of the number's current status)." - added
Input schema / properties / type / enumAdded value: +[ + "format", + "analysis", + "validation" +] - added
Input schema / properties / type / titleAdded value: +"PhoneNumberValidationType" - added
Input schema / properties / type / typeAdded value: +"string" - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / carrier_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Name of the phone number carrier. `null` if the phone number is invalid.", + "example": "Etisalat" +} - added
Output schema / properties / chargeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Charge for the validation.", + "example": "0.015" +} - added
Output schema / properties / country_codeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ISO 3166-1 alpha-2 country code of the phone number.\n `null` if the number is invalid.", + "example": "AE" +} - added
Output schema / properties / e164_formatAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number in international E.164 format.", + "example": "+971569483322" +} - added
Output schema / properties / error_codeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / mccAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile Country Code of the phone number carrier. For mobile phone numbers only. `null` if the phone number is invalid.", + "example": "424" +} - added
Output schema / properties / mncAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile Network Code of the phone number carrier. For mobile phone numbers only. `null` if the phone number is invalid", + "example": "004" +} - added
Output schema / properties / national_formatAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number in the national format of the identified country.", + "example": "056 948 3322" +} - added
Output schema / properties / number_typeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Number type. Possible values are `mobile`, `landline`, or `toll-free`. `null` if the phone number is invalid.", + "example": "mobile" +} - added
Output schema / properties / phone_numberAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number.", + "example": "971569483322" +} - added
Output schema / properties / portedAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number was ported or not. `null` if the phone number is invalid.", + "example": false +} - added
Output schema / properties / reachableAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the number is registered in a mobile network. For mobile phone numbers only. `null` if the number is invalid", + "example": true +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - } - ] -} - added
Output schema / properties / risky_destinationAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number belongs to a number range associated with traffic pumping. `null` if the number is invalid.", + "example": false +} - added
Output schema / properties / roamingAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the number is roaming. For mobile phone numbers only. `null` if the number is invalid", + "example": false +} - added
Output schema / properties / timezoneAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Time zone based on the phone number's country and area code.\n `null` if the number is invalid.", + "example": "UTC+04:00" +} - added
Output schema / properties / unallocated_rangeAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number belongs to an unallocated number range. `null` if the number is invalid", + "example": false +} - added
Output schema / properties / validAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number is valid.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "phone_number", + "valid", + "country_code", + "e164_format", + "national_format", + "charge", + "error_code" +] - added
Output schema / titleAdded value: +"PhoneValidationResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
number_validator_results_get10 fields changed- changed
Input schema / properties / request_id / descriptionPrevious value: -"Request ID."New value: +"The `request_id` returned by the asynchronous bulk validation request." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / countAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The quantity of phone numbers passed in the request.", + "example": 1000, + "format": "int32" +} - added
Output schema / properties / itemsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Carrier name. `null` if the phone number is invalid.", + "example": "Etisalat" + }, + "charge": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Charge for the validation.", + "example": "0.015" + }, + "country_code": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number country code in ISO 3166-1 alpha-2 format. `null` if the number is invalid.", + "example": "AE" + }, + "e164_format": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number in international E.164 format.", + "example": "+971569483322" + }, + "error_code": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Result code for the validation. `000` indicates success. Possible values:\n- `013` — internal service error, uncategorized.\n- `021` — invalid phone number length or format.\n- `041` — remote timeout.\n- `042` — remote query failed.\n- `091` — insufficient funds.", + "example": "000" + }, + "mcc": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile Country Code (MCC). Applies to mobile numbers only. `null` if the phone number is invalid.", + "example": "424" + }, + "mnc": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile Network Code (MNC). Applies to mobile numbers only. `null` if the phone number is invalid.", + "example": "004" + }, + "national_format": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number in the national format of the identified country.", + "example": "056 948 3322" + }, + "number_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number type. Allowed values: `mobile`, `landline`, `toll-free`. `null` if the phone number is invalid.", + "example": "mobile" + }, + "phone_number": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number.", + "example": "971569483322" + }, + "ported": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number is ported. `null` if the phone number is invalid.", + "example": false + }, + "reachable": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "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 + }, + "risky_destination": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number belongs to a range associated with traffic pumping. `null` if the phone number is invalid.", + "example": false + }, + "roaming": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the number is roaming. Applies to mobile numbers only.\n `null` if the phone number is invalid.", + "example": false + }, + "timezone": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Time zone identified based on the country and area code. `null` if the phone number is invalid.", + "example": "UTC+04:00" + }, + "unallocated_range": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number belongs to an unallocated range.\n `null` if the phone number is invalid.", + "example": false + }, + "valid": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the phone number is valid.", + "example": true + } + }, + "required": [ + "phone_number", + "valid", + "country_code", + "e164_format", + "national_format", + "charge", + "error_code" + ], + "title": "PhoneValidationResultResponse", + "type": "object" + } +} - added
Output schema / properties / pendingAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The quantity of phone numbers that are pending to be processed.", + "example": 10, + "format": "int32" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - added
Output schema / properties / statusAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "status", + "pending", + "count", + "items" +] - added
Output schema / titleAdded value: +"PhoneValidationBatchResultResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
profile_config_get7 fields changed- added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / balanceAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Funds available on the account balance, in USD", + "example": "100" +} - added
Output schema / properties / global_limitsAdded value: +{ + "additionalProperties": false, + "properties": { + "max_call_duration": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum outbound call duration, in seconds", + "example": 3600, + "format": "int32" + }, + "max_call_rate": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Maximum outbound call rate, in cents", + "example": "0.18" + }, + "max_sip_channels": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Maximum number of concurrent outbound calls.", + "example": 2, + "format": "int32" + } + }, + "required": [ + "max_call_duration", + "max_sip_channels", + "max_call_rate" + ], + "title": "AccountLimits", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "balance", + "global_limits" +] - added
Output schema / titleAdded value: +"ProfileConfigResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
profile_get17 fields changed- added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / additional_infoAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Additional info associated with the account.", + "example": "Additional info" +} - added
Output schema / properties / company_infoAdded value: +{ + "additionalProperties": false, + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Company details.", + "properties": { + "address": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Company address.", + "example": "Baker street" + }, + "attn_contact_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Billing contact name.", + "example": "James Scott" + }, + "country": { + "additionalProperties": false, + "description": "Country.", + "properties": { + "country_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Country ID.", + "example": 1 + }, + "country_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Country name.", + "example": "United States" + } + }, + "type": "object" + }, + "industry": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Industry the company operates in. One of `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`, or `other`. Each value names the company's sector. `null` when the industry is not set.", + "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" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Company name.", + "example": "Awesome company" + }, + "vat_number": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "VAT number.", + "example": "VAT123456789" + } + } +} - added
Output schema / properties / contact_emailAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Additional email address for billing notifications.", + "example": "billing@awesome.com" +} - added
Output schema / properties / default_destinationsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Default destinations configured for the account.", + "example": [ + { + "transport": "sms", + "value": "https://webhook.address.com/inboundSMS" + } + ], + "items": { + "additionalProperties": false, + "properties": { + "transport": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Transport type.", + "example": "sms" + }, + "value": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Destination value", + "example": "https://webhook.address.com/inboundSMS" + } + }, + "type": "object" + } +} - added
Output schema / properties / default_short_link_endpointAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Default short link endpoint.", + "example": "https://short.examples.com" +} - added
Output schema / properties / emailAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Email associated with the account.", + "example": "info@awesome.com" +} - added
Output schema / properties / first_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Account owner's first name.", + "example": "Jason" +} - added
Output schema / properties / idAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Account ID.", + "example": 1, + "format": "int32" +} - added
Output schema / properties / job_titleAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Account owner's job title.", + "example": "Manager" +} - added
Output schema / properties / last_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Account owner's last name.", + "example": "Androux" +} - added
Output schema / properties / phoneAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Account owner's phone number.", + "example": "13291019312" +} - removed
Output schema / properties / resultRemoved value: -{ - "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": "billing@awesome.com", - "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": "info@awesome.com", - "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" - } - ] -} - added
Output schema / properties / timezoneAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timezone configured on the account.", + "example": "Pacific/Wallis" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "id", + "email", + "first_name", + "last_name", + "phone", + "additional_info", + "contact_email", + "timezone", + "job_title", + "default_short_link_endpoint", + "default_destinations", + "company_info" +] - added
Output schema / titleAdded value: +"ProfileResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
profile_update18 fields changed- changed
Input schema / properties / company_info / properties / industry / descriptionPrevious value: -"Industry."New value: +"Industry the company operates in. One of `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`, or `other`. Each value names the company's sector." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / additional_infoAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Additional info associated with the account.", + "example": "Additional info" +} - added
Output schema / properties / company_infoAdded value: +{ + "additionalProperties": false, + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Company details.", + "properties": { + "address": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Company address.", + "example": "Baker street" + }, + "attn_contact_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Billing contact name.", + "example": "James Scott" + }, + "country": { + "additionalProperties": false, + "description": "Country.", + "properties": { + "country_id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Country ID.", + "example": 1 + }, + "country_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Country name.", + "example": "United States" + } + }, + "type": "object" + }, + "industry": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Industry the company operates in. One of `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`, or `other`. Each value names the company's sector. `null` when the industry is not set.", + "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" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Company name.", + "example": "Awesome company" + }, + "vat_number": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "VAT number.", + "example": "VAT123456789" + } + } +} - added
Output schema / properties / contact_emailAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Additional email address for billing notifications.", + "example": "billing@awesome.com" +} - added
Output schema / properties / default_destinationsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Default destinations configured for the account.", + "example": [ + { + "transport": "sms", + "value": "https://webhook.address.com/inboundSMS" + } + ], + "items": { + "additionalProperties": false, + "properties": { + "transport": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Transport type.", + "example": "sms" + }, + "value": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Destination value", + "example": "https://webhook.address.com/inboundSMS" + } + }, + "type": "object" + } +} - added
Output schema / properties / default_short_link_endpointAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Default short link endpoint.", + "example": "https://short.examples.com" +} - added
Output schema / properties / emailAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Email associated with the account.", + "example": "info@awesome.com" +} - added
Output schema / properties / first_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Account owner's first name.", + "example": "Jason" +} - added
Output schema / properties / idAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Account ID.", + "example": 1, + "format": "int32" +} - added
Output schema / properties / job_titleAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Account owner's job title.", + "example": "Manager" +} - added
Output schema / properties / last_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Account owner's last name.", + "example": "Androux" +} - added
Output schema / properties / phoneAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Account owner's phone number.", + "example": "13291019312" +} - removed
Output schema / properties / resultRemoved value: -{ - "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": "billing@awesome.com", - "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": "info@awesome.com", - "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" - } - ] -} - added
Output schema / properties / timezoneAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timezone configured on the account.", + "example": "Pacific/Wallis" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "id", + "email", + "first_name", + "last_name", + "phone", + "additional_info", + "contact_email", + "timezone", + "job_title", + "default_short_link_endpoint", + "default_destinations", + "company_info" +] - added
Output schema / titleAdded value: +"ProfileResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sip_trunks_create41 fields changed- added
Input schema / properties / allowed_ips / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Input schema / properties / allowed_ips / items / properties / ip / descriptionAdded value: +"Public static IP address allowed to register with the SIP trunk." - removed
Input schema / properties / allowed_ips / typeRemoved value: -[ - "array", - "null" -] - changed
Input schema / properties / call_limit / descriptionPrevious value: -"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`."New value: +"Maximum call duration for the SIP trunk, in seconds. Must not exceed the maximum duration set for the account. Ignored when `call_restrict` is `false`." - changed
Input schema / properties / callerid / descriptionPrevious value: -"Caller ID associated with the SIP trunk. Must be an active or verified number on your account."New value: +"Caller ID associated with the SIP trunk. Must be an active or verified number on the account." - added
Input schema / properties / encrypted_media / descriptionAdded value: +"Indicates whether SRTP media encryption is enabled for the SIP trunk." - changed
Input schema / properties / max_channels / descriptionPrevious value: -"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`."New value: +"Maximum number of concurrent outbound calls for the SIP trunk. Must not exceed the outbound channel capacity set for the account. Ignored when `channels_restrict` is `false`." - changed
Input schema / properties / multiple_numbers / descriptionPrevious value: -"Indicates whether any active or verified phone number in your account can be used as the Caller ID for the SIP trunk"New value: +"Indicates whether any active or verified phone number on the account can be used as the Caller ID for the SIP trunk." - changed
Input schema / properties / password / descriptionPrevious value: -"Password set for the SIP trunk. Use a strong password to help keep your SIP trunk secure."New value: +"Password set for the SIP trunk. A strong password helps keep the trunk secure." - changed
Input schema / requiredPrevious value: -[ - "label", - "password", - "callerid", - "ip_restrict", - "didinfo_enabled", - "call_restrict", - "cost_limit", - "channels_restrict", - "rewrite_enabled", - "transcription_enabled", - "transcription_threshold" -]New value: +[ + "label", + "password", + "callerid", + "ip_restrict", + "didinfo_enabled", + "call_restrict", + "channels_restrict", + "rewrite_enabled", + "transcription_enabled", + "transcription_threshold" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / access_tokenAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Static authentication token for the SIP trunk.", + "example": "123easwqe321132" +} - added
Output schema / properties / allowed_ipsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "items": { + "additionalProperties": false, + "properties": { + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "IP address ID.", + "example": 6712, + "format": "int32" + }, + "ip": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Public static IP address.", + "example": "127.0.0.1" + } + }, + "required": [ + "id", + "ip" + ], + "type": "object" + }, + "title": "AllowedIPs" +} - added
Output schema / properties / call_limitAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / call_recording_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if outbound call recording is enabled on the SIP trunk. Available for `Flex Pro` customers only.", + "example": true +} - added
Output schema / properties / call_restrictAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if maximum call duration limit is activated for the SIP trunk.", + "example": false +} - added
Output schema / properties / calleridAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / channels_restrictAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if the max number of concurrent outbound calls limit is activated for the SIP trunk.", + "example": false +} - added
Output schema / properties / cost_limitAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.", + "example": true +} - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time the SIP trunk was created", + "example": "2023-05-16T17:13:25.000Z", + "format": "date-time" +} - added
Output schema / properties / didinfo_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": true, + "description": "Indicates if inbound calls carry dialed number information in the 'To' header of SIP Invites", + "example": true +} - added
Output schema / properties / encrypted_mediaAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether SRTP media encryption is enabled for the SIP trunk.", + "example": true +} - added
Output schema / properties / hostAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registration host for the SIP trunk. `dynamic` for credential-based registration, or a public static IP address for IP authentication.", + "example": "dynamic" +} - added
Output schema / properties / idAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the SIP trunk on the platform", + "example": 293, + "format": "int32" +} - added
Output schema / properties / ip_restrictAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates whether IP restriction must be enabled on the SIP trunk", + "example": false +} - added
Output schema / properties / labelAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "User-defined name of the SIP trunk", + "example": "My trunk" +} - added
Output schema / properties / machine_detection_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if automatic voicemail detection is enabled on the SIP trunk. Available for `Flex Pro` customers only.", + "example": true +} - added
Output schema / properties / max_call_costAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "A maximum cost of an outbound call, in USD.", + "example": "0.18" +} - added
Output schema / properties / max_channelsAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / multiple_numbersAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether any active or verified phone number on the account can be used as the Caller ID for the SIP trunk.", + "example": true +} - added
Output schema / properties / nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "System-generated login name of the SIP trunk", + "example": "67758" +} - added
Output schema / properties / passthroughAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether Caller ID passthrough is enabled.", + "example": true +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - added
Output schema / properties / rewrite_condAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Leading digits to be deleted from the dialed phone numbers." +} - added
Output schema / properties / rewrite_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if a custom dial plan is activated for the SIP trunk.", + "example": true +} - added
Output schema / properties / rewrite_prefixAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Leading digits to be added before the dialed phone numbers.", + "example": "1" +} - added
Output schema / properties / transcription_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if automatic call transcription is enabled on the SIP trunk. Available for `Flex Pro` customers only.", + "example": false +} - added
Output schema / properties / transcription_thresholdAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "id", + "name", + "callerid", + "label", + "allowed_ips", + "created_at" +] - added
Output schema / titleAdded value: +"SIPTrunkResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sip_trunks_delete6 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"SIP trunk ID."New value: +"The unique ID of the SIP trunk." - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sip_trunks_get32 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"SIP trunk ID."New value: +"The unique ID of the SIP trunk." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / access_tokenAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Static authentication token for the SIP trunk.", + "example": "123easwqe321132" +} - added
Output schema / properties / allowed_ipsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "items": { + "additionalProperties": false, + "properties": { + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "IP address ID.", + "example": 6712, + "format": "int32" + }, + "ip": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Public static IP address.", + "example": "127.0.0.1" + } + }, + "required": [ + "id", + "ip" + ], + "type": "object" + }, + "title": "AllowedIPs" +} - added
Output schema / properties / call_limitAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / call_recording_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if outbound call recording is enabled on the SIP trunk. Available for `Flex Pro` customers only.", + "example": true +} - added
Output schema / properties / call_restrictAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if maximum call duration limit is activated for the SIP trunk.", + "example": false +} - added
Output schema / properties / calleridAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / channels_restrictAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if the max number of concurrent outbound calls limit is activated for the SIP trunk.", + "example": false +} - added
Output schema / properties / cost_limitAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.", + "example": true +} - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time the SIP trunk was created", + "example": "2023-05-16T17:13:25.000Z", + "format": "date-time" +} - added
Output schema / properties / didinfo_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": true, + "description": "Indicates if inbound calls carry dialed number information in the 'To' header of SIP Invites", + "example": true +} - added
Output schema / properties / encrypted_mediaAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether SRTP media encryption is enabled for the SIP trunk.", + "example": true +} - added
Output schema / properties / hostAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registration host for the SIP trunk. `dynamic` for credential-based registration, or a public static IP address for IP authentication.", + "example": "dynamic" +} - added
Output schema / properties / idAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the SIP trunk on the platform", + "example": 293, + "format": "int32" +} - added
Output schema / properties / ip_restrictAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates whether IP restriction must be enabled on the SIP trunk", + "example": false +} - added
Output schema / properties / labelAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "User-defined name of the SIP trunk", + "example": "My trunk" +} - added
Output schema / properties / machine_detection_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if automatic voicemail detection is enabled on the SIP trunk. Available for `Flex Pro` customers only.", + "example": true +} - added
Output schema / properties / max_call_costAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "A maximum cost of an outbound call, in USD.", + "example": "0.18" +} - added
Output schema / properties / max_channelsAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / multiple_numbersAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether any active or verified phone number on the account can be used as the Caller ID for the SIP trunk.", + "example": true +} - added
Output schema / properties / nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "System-generated login name of the SIP trunk", + "example": "67758" +} - added
Output schema / properties / passthroughAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether Caller ID passthrough is enabled.", + "example": true +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - added
Output schema / properties / rewrite_condAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Leading digits to be deleted from the dialed phone numbers." +} - added
Output schema / properties / rewrite_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if a custom dial plan is activated for the SIP trunk.", + "example": true +} - added
Output schema / properties / rewrite_prefixAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Leading digits to be added before the dialed phone numbers.", + "example": "1" +} - added
Output schema / properties / transcription_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if automatic call transcription is enabled on the SIP trunk. Available for `Flex Pro` customers only.", + "example": false +} - added
Output schema / properties / transcription_thresholdAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "id", + "name", + "callerid", + "label", + "allowed_ips", + "created_at" +] - added
Output schema / titleAdded value: +"SIPTrunkResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sip_trunks_list10 fields changed- changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / exampleAdded value: +{ + "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 + } + ] +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - added
Output schema / properties / sip_trunksAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "SIP trunks associated with the account.", + "items": { + "additionalProperties": false, + "description": "A SIP trunk associated with the 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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Static authentication token for the SIP trunk.", + "example": "siped7a3f5c1b9e042d6f8a4c2e7b9d1f3a5c8e0b2d4f6a8c0e2d4b6f8a1c3e5d7" + }, + "auth_method": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "SIP trunk authentication method. Can be either `Digest` or `IP auth`." + }, + "call_recording_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates whether outbound call recording is enabled for the SIP trunk" + }, + "callerid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "charge": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "encrypted_media": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether SRTP media encryption is enabled for the SIP trunk.", + "example": true + }, + "host_request": { + "anyOf": [ + { + "type": "object" + }, + { + "type": "null" + } + ], + "description": "For SIP trunks with IP-based authentication, contains the status of the IP authentication request.", + "properties": { + "host": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The IP address submitted for authentication", + "example": "127.0.0.1" + }, + "status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Status of the IP authentication request", + "example": "pending" + } + } + }, + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the SIP trunk on the platform", + "example": 293, + "format": "int32" + }, + "label": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "User-defined name of the SIP trunk", + "example": "My trunk" + }, + "machine_detection_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates whether automatic voicemail detection is enabled for the SIP trunk.\nAvailable for `Flex Pro` customers only." + }, + "multiple_numbers": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether multiple Caller IDs are enabled for the SIP trunk", + "example": false + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "System-generated login name of the SIP trunk", + "example": "67758" + }, + "passthrough": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether Caller ID passthrough is enabled for the SIP trunk", + "example": false + }, + "status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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." + }, + "talk_time": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" + }, + "transcription_enabled": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates whether automatic call transcription is enabled for the SIP trunk.\nAvailable for `Flex Pro` customers only." + }, + "transcription_threshold": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" + } + }, + "required": [ + "id", + "name", + "callerid", + "multiple_numbers", + "label", + "auth_method", + "host_request", + "status", + "talk_time", + "charge", + "access_token" + ], + "title": "SIPTrunkSummary", + "type": "object" + } +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "sip_trunks", + "pagination" +] - added
Output schema / titleAdded value: +"SIPTrunkListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sip_trunks_update42 fields changed- added
Input schema / properties / allowed_ips / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Input schema / properties / allowed_ips / items / properties / ip / descriptionAdded value: +"Public static IP address allowed to register with the SIP trunk." - removed
Input schema / properties / allowed_ips / typeRemoved value: -[ - "array", - "null" -] - changed
Input schema / properties / call_limit / descriptionPrevious value: -"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`."New value: +"Maximum call duration for the SIP trunk, in seconds. Must not exceed the maximum duration set for the account. Ignored when `call_restrict` is `false`." - changed
Input schema / properties / callerid / descriptionPrevious value: -"Caller ID associated with the SIP trunk. Must be an active or verified number on your account."New value: +"Caller ID associated with the SIP trunk. Must be an active or verified number on the account." - added
Input schema / properties / encrypted_media / descriptionAdded value: +"Indicates whether SRTP media encryption is enabled for the SIP trunk." - changed
Input schema / properties / id / descriptionPrevious value: -"SIP trunk ID."New value: +"The unique ID of the SIP trunk." - changed
Input schema / properties / max_channels / descriptionPrevious value: -"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`."New value: +"Maximum number of concurrent outbound calls for the SIP trunk. Must not exceed the outbound channel capacity set for the account. Ignored when `channels_restrict` is `false`." - changed
Input schema / properties / multiple_numbers / descriptionPrevious value: -"Indicates whether any active or verified phone number in your account can be used as the Caller ID for the SIP trunk"New value: +"Indicates whether any active or verified phone number on the account can be used as the Caller ID for the SIP trunk." - changed
Input schema / properties / password / descriptionPrevious value: -"Password set for the SIP trunk. Use a strong password to help keep your SIP trunk secure."New value: +"Password set for the SIP trunk. A strong password helps keep the trunk secure." - changed
Input schema / requiredPrevious value: -[ - "id", - "label", - "password", - "callerid", - "ip_restrict", - "didinfo_enabled", - "call_restrict", - "cost_limit", - "channels_restrict", - "rewrite_enabled", - "transcription_enabled", - "transcription_threshold" -]New value: +[ + "id", + "label", + "password", + "callerid", + "ip_restrict", + "didinfo_enabled", + "call_restrict", + "channels_restrict", + "rewrite_enabled", + "transcription_enabled", + "transcription_threshold" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / access_tokenAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Static authentication token for the SIP trunk.", + "example": "123easwqe321132" +} - added
Output schema / properties / allowed_ipsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "items": { + "additionalProperties": false, + "properties": { + "id": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "IP address ID.", + "example": 6712, + "format": "int32" + }, + "ip": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Public static IP address.", + "example": "127.0.0.1" + } + }, + "required": [ + "id", + "ip" + ], + "type": "object" + }, + "title": "AllowedIPs" +} - added
Output schema / properties / call_limitAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / call_recording_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if outbound call recording is enabled on the SIP trunk. Available for `Flex Pro` customers only.", + "example": true +} - added
Output schema / properties / call_restrictAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if maximum call duration limit is activated for the SIP trunk.", + "example": false +} - added
Output schema / properties / calleridAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / channels_restrictAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if the max number of concurrent outbound calls limit is activated for the SIP trunk.", + "example": false +} - added
Output schema / properties / cost_limitAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.", + "example": true +} - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time the SIP trunk was created", + "example": "2023-05-16T17:13:25.000Z", + "format": "date-time" +} - added
Output schema / properties / didinfo_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": true, + "description": "Indicates if inbound calls carry dialed number information in the 'To' header of SIP Invites", + "example": true +} - added
Output schema / properties / encrypted_mediaAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether SRTP media encryption is enabled for the SIP trunk.", + "example": true +} - added
Output schema / properties / hostAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registration host for the SIP trunk. `dynamic` for credential-based registration, or a public static IP address for IP authentication.", + "example": "dynamic" +} - added
Output schema / properties / idAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the SIP trunk on the platform", + "example": 293, + "format": "int32" +} - added
Output schema / properties / ip_restrictAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates whether IP restriction must be enabled on the SIP trunk", + "example": false +} - added
Output schema / properties / labelAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "User-defined name of the SIP trunk", + "example": "My trunk" +} - added
Output schema / properties / machine_detection_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if automatic voicemail detection is enabled on the SIP trunk. Available for `Flex Pro` customers only.", + "example": true +} - added
Output schema / properties / max_call_costAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "A maximum cost of an outbound call, in USD.", + "example": "0.18" +} - added
Output schema / properties / max_channelsAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / multiple_numbersAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether any active or verified phone number on the account can be used as the Caller ID for the SIP trunk.", + "example": true +} - added
Output schema / properties / nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "System-generated login name of the SIP trunk", + "example": "67758" +} - added
Output schema / properties / passthroughAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether Caller ID passthrough is enabled.", + "example": true +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - added
Output schema / properties / rewrite_condAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Leading digits to be deleted from the dialed phone numbers." +} - added
Output schema / properties / rewrite_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if a custom dial plan is activated for the SIP trunk.", + "example": true +} - added
Output schema / properties / rewrite_prefixAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Leading digits to be added before the dialed phone numbers.", + "example": "1" +} - added
Output schema / properties / transcription_enabledAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates if automatic call transcription is enabled on the SIP trunk. Available for `Flex Pro` customers only.", + "example": false +} - added
Output schema / properties / transcription_thresholdAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "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" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "id", + "name", + "callerid", + "label", + "allowed_ips", + "created_at" +] - added
Output schema / titleAdded value: +"SIPTrunkResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sms_and_mms_messages_get25 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"Message ID."New value: +"The unique ID of the message." - added
Input schema / properties / id / formatAdded value: +"uuid" - added
Input schema / properties / id / patternAdded value: +"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / carrier_feesAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile carrier fees in USD.", + "example": "0.0" +} - added
Output schema / properties / chargeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Total charge for the message in USD.", + "example": "0.01" +} - added
Output schema / properties / delivered_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / directionAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Message direction. Possible values are `outbound`, `inbound`.", + "example": "outbound" +} - added
Output schema / properties / error_messageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Human-readable error message." +} - added
Output schema / properties / fromAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sender ID.", + "example": "Wavix" +} - added
Output schema / properties / mccAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile country code.", + "example": "301" +} - added
Output schema / properties / message_bodyAdded value: +{ + "additionalProperties": false, + "properties": { + "media": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "maxItems": 5, + "minItems": 0 + }, + "text": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Message text.", + "example": "Hi there, this is a sample message" + } + }, + "required": [ + "text" + ], + "title": "MessageBody", + "type": "object" +} - added
Output schema / properties / message_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Message ID.", + "example": "871b4eeb-f798-4105-be23-32df9e991456" +} - added
Output schema / properties / message_typeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Message type. Possible values are `sms`, `mms`.", + "example": "sms" +} - added
Output schema / properties / mncAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile network code.", + "example": "204" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - } - ] -} - added
Output schema / properties / segmentsAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of SMS segments. Always 1 for MMS.", + "example": 1, + "format": "int32" +} - added
Output schema / properties / sent_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time the message was sent in ISO 8601 format. For mobile-terminated messages only.", + "example": "2022-04-14T13:51:16.096Z" +} - added
Output schema / properties / statusAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Current delivery status of the message. One of:\n\n- `accepted` — the message was accepted by the platform for sending.\n- `pending` — the message is queued and awaiting a carrier response.\n- `sent` — the message was handed to the carrier.\n- `delivered` — the carrier confirmed delivery to the handset.\n- `undelivered` — the carrier reported that delivery failed.\n- `expired` — the validity period elapsed before the message was sent.\n- `rejected` — the message was rejected before sending.\n- `dlr_expired` — no delivery receipt arrived from the carrier within the expected window.", + "enum": [ + "accepted", + "pending", + "sent", + "delivered", + "undelivered", + "expired", + "rejected", + "dlr_expired", + null + ], + "title": "MessageDeliveryStatus" +} - added
Output schema / properties / submitted_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time the message was accepted in ISO 8601 format.", + "example": "2022-04-14T13:51:16.096Z" +} - added
Output schema / properties / tagAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Tag to group messages, such as for a specific campaign.", + "example": "Fall sale" +} - added
Output schema / properties / toAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Recipient phone number.", + "example": "447537151866" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "message_id", + "message_type", + "from", + "to", + "direction", + "mcc", + "mnc", + "message_body", + "tag", + "status", + "segments", + "charge", + "submitted_at", + "sent_at", + "delivered_at", + "error_message" +] - added
Output schema / titleAdded value: +"MessageResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sms_and_mms_messages_list23 fields changed- changed
Input schema / properties / from / descriptionPrevious value: -"Message sender. For `outbound` messages,\n the Sender ID used to send the message;\n for `inbound` messages, the originating phone number."New value: +"Filters by message sender. For `outbound` messages, the Sender ID used to send the message; for `inbound` messages, the originating phone number." - changed
Input schema / properties / message_type / descriptionPrevious value: -"Message type for filtering. Allowed values are `sms`, `mms`."New value: +"Filters messages by type. One of `sms` (text message) or `mms` (multimedia message)." - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / sent_after / descriptionPrevious value: -"Start date in `YYYY-MM-DD` format."New value: +"Returns messages sent on or after this date, in `YYYY-MM-DD` format." - added
Input schema / properties / sent_after / formatAdded value: +"date" - changed
Input schema / properties / sent_before / descriptionPrevious value: -"End date in `YYYY-MM-DD` format."New value: +"Returns messages sent on or before this date, in `YYYY-MM-DD` format." - added
Input schema / properties / sent_before / formatAdded value: +"date" - removed
Input schema / properties / status / allOfRemoved value: -[ - { - "description": "Message delivery status.", - "enum": [ - "accepted", - "pending", - "sent", - "delivered", - "undelivered", - "expired", - "rejected", - "dlr_expired" - ], - "title": "MessageDeliveryStatus", - "type": "string" - } -] - added
Input schema / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / status / descriptionPrevious value: -"Message delivery status for filtering."New value: +"Current delivery status of the message. One of:\n\n- `accepted` — the message was accepted by the platform for sending.\n- `pending` — the message is queued and awaiting a carrier response.\n- `sent` — the message was handed to the carrier.\n- `delivered` — the carrier confirmed delivery to the handset.\n- `undelivered` — the carrier reported that delivery failed.\n- `expired` — the validity period elapsed before the message was sent.\n- `rejected` — the message was rejected before sending.\n- `dlr_expired` — no delivery receipt arrived from the carrier within the expected window." - added
Input schema / properties / status / enumAdded value: +[ + "accepted", + "pending", + "sent", + "delivered", + "undelivered", + "expired", + "rejected", + "dlr_expired", + null +] - added
Input schema / properties / status / titleAdded value: +"MessageDeliveryStatus" - changed
Input schema / properties / tag / descriptionPrevious value: -"Tag for filtering. Supported for outbound messages only."New value: +"Filters messages by `tag`. Supported for outbound messages only." - changed
Input schema / properties / to / descriptionPrevious value: -"Recipient phone number. For `outbound` messages,\n the destination phone number;\n for `inbound` messages, an SMS-enabled number on the Wavix platform."New value: +"Filters by message recipient. For `outbound` messages, the destination phone number; for `inbound` messages, an SMS-enabled number on the Wavix platform." - changed
Input schema / properties / type / descriptionPrevious value: -"Message direction for filtering. Allowed values are `inbound`, `outbound`."New value: +"Filters messages by direction. One of `inbound` (messages received by the account) or `outbound` (messages sent by the account)." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / itemsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Messages that match the request.", + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Carrier fees for the message in USD.", + "example": "0.0", + "format": "float" + }, + "charge": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Total charge for the message in USD.", + "example": "0.01" + }, + "delivered_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "direction": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Message direction. Possible values are `outbound` or `inbound`.", + "example": "outbound" + }, + "error_message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "A human-readable error description." + }, + "from": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sender ID. Can be numeric or alphanumeric.", + "example": "Wavix" + }, + "mcc": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile country code.", + "example": "301" + }, + "message_body": { + "additionalProperties": false, + "properties": { + "media": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + }, + "maxItems": 5, + "minItems": 0 + }, + "text": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Message text.", + "example": "Hi there, this is a sample message" + } + }, + "required": [ + "text" + ], + "title": "MessageBody", + "type": "object" + }, + "message_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Message ID.", + "example": "871b4eeb-f798-4105-be23-32df9e991456" + }, + "message_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Message type. Possible values are `sms` or `mms`", + "example": "sms" + }, + "mnc": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Mobile network code.", + "example": "204" + }, + "segments": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of SMS segments. Always 1 for MMS.", + "example": 1, + "format": "int32" + }, + "sent_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time the message was sent in ISO 8601 format. For mobile terminated messages only.", + "example": "2022-04-14T13:51:16.096Z" + }, + "status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Current delivery status of the message. One of:\n\n- `accepted` — the message was accepted by the platform for sending.\n- `pending` — the message is queued and awaiting a carrier response.\n- `sent` — the message was handed to the carrier.\n- `delivered` — the carrier confirmed delivery to the handset.\n- `undelivered` — the carrier reported that delivery failed.\n- `expired` — the validity period elapsed before the message was sent.\n- `rejected` — the message was rejected before sending.\n- `dlr_expired` — no delivery receipt arrived from the carrier within the expected window.", + "enum": [ + "accepted", + "pending", + "sent", + "delivered", + "undelivered", + "expired", + "rejected", + "dlr_expired", + null + ], + "title": "MessageDeliveryStatus" + }, + "submitted_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time the message was accepted in ISO 8601 format.", + "example": "2022-04-14T13:51:16.096Z" + }, + "tag": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Tag to group messages, such as for a specific campaign.", + "example": "Fall sale" + }, + "to": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Recipient phone number.", + "example": "447537151866" + } + }, + "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" + } +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "items", + "pagination" +] - added
Output schema / titleAdded value: +"MessageListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Removed
sms_and_mms_messages_list_all - Changed
sms_and_mms_messages_send54 fields changed- added
Input schema / properties / message_body / properties / media / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Input schema / properties / message_body / properties / media / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Input schema / properties / message_body / properties / media / items / typeRemoved value: -"string" - removed
Input schema / properties / message_body / properties / media / typeRemoved value: -[ - "array", - "null" -] - added
Input schema / properties / message_body / properties / text / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Input schema / properties / message_body / properties / text / typeRemoved value: -"string" - changed
Input schema / properties / message_body / requiredPrevious value: -[ - "text", - "media" -]New value: +[ + "text" +] - added
Output schema / properties / carrier_fees / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / carrier_fees / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / charge / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / charge / typeRemoved value: -"string" - added
Output schema / properties / delivered_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / delivered_at / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / direction / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / direction / typeRemoved value: -"string" - added
Output schema / properties / error_message / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / error_message / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / from / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / from / typeRemoved value: -"string" - added
Output schema / properties / mcc / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / mcc / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / message_body / properties / media / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / message_body / properties / media / descriptionPrevious value: -"List of media URLs."New value: +"List of media URLs.\n If provided, the message is sent as an MMS;\n otherwise, it is sent as an SMS." - added
Output schema / properties / message_body / properties / media / exampleAdded value: +[ + "https://you-site.com/media" +] - added
Output schema / properties / message_body / properties / media / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / message_body / properties / media / items / exampleRemoved value: -"https://api.examples.com/v3/messages/file1" - removed
Output schema / properties / message_body / properties / media / items / formatRemoved value: -"uri" - removed
Output schema / properties / message_body / properties / media / items / typeRemoved value: -"string" - added
Output schema / properties / message_body / properties / media / maxItemsAdded value: +5 - added
Output schema / properties / message_body / properties / media / minItemsAdded value: +0 - removed
Output schema / properties / message_body / properties / media / typeRemoved value: -"array" - added
Output schema / properties / message_body / properties / text / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / message_body / properties / text / examplePrevious value: -"Hi there, this is a message from Wavix"New value: +"Hi there, this is a sample message" - removed
Output schema / properties / message_body / properties / text / typeRemoved value: -"string" - added
Output schema / properties / message_body / requiredAdded value: +[ + "text" +] - added
Output schema / properties / message_body / titleAdded value: +"MessageBody" - added
Output schema / properties / message_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / message_id / typeRemoved value: -"string" - added
Output schema / properties / message_type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / message_type / typeRemoved value: -"string" - added
Output schema / properties / mnc / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / mnc / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / segments / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / segments / typeRemoved value: -"integer" - added
Output schema / properties / sent_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sent_at / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / status / typeRemoved value: -"string" - added
Output schema / properties / submitted_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / submitted_at / typeRemoved value: -"string" - added
Output schema / properties / tag / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / tag / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / to / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / to / typeRemoved value: -"string"
- Changed
sms_and_mms_opt_outs_create5 fields changed- removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sms_and_mms_opt_outs_list25 fields changed- changed
Input schema / properties / campaign_id / descriptionPrevious value: -"10DLC campaign for filtering."New value: +"Filters opt-outs by the 10DLC campaign ID they apply to." - changed
Input schema / properties / created_after / descriptionPrevious value: -"Start date in `YYYY-MM-DD` format."New value: +"Returns opt-outs created on or after this date, in `YYYY-MM-DD` format." - changed
Input schema / properties / created_before / descriptionPrevious value: -"End date in `YYYY-MM-DD` format."New value: +"Returns opt-outs created on or before this date, in `YYYY-MM-DD` format." - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Minimum `1`, default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`, maximum `100`." - changed
Input schema / properties / sender_id / descriptionPrevious value: -"Sender ID for filtering."New value: +"Filters opt-outs by the Sender ID they apply to." - added
Output schema / properties / items / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / items / descriptionAdded value: +"Opt-out records that match the request." - added
Output schema / properties / items / items / properties / campaign_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / campaign_id / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / items / items / properties / created_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / created_at / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / phone_number / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / phone_number / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / sender_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / sender_id / typeRemoved value: -[ - "string", - "null" -] - removed
Output schema / properties / items / typeRemoved value: -"array" - added
Output schema / properties / pagination / properties / current_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / current_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / per_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / per_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / total / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total_pages / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / total_pages / typeRemoved value: -"integer"
- Changed
sms_and_mms_sender_ids_create18 fields changed- changed
Input schema / properties / monthly_volume / descriptionPrevious value: -"Expected monthly volume."New value: +"Expected number of messages sent per month from the Sender ID. One of `1-1000`, `1001-20000`, `20001-50000`, `50001-100000`, or `More than 100000`. Each value is the message-count band for the month." - added
Input schema / properties / type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / type / descriptionPrevious value: -"Sender ID type."New value: +"Format of the Sender ID. One of `numeric` (a phone number) or `alphanumeric` (a text sender name)." - changed
Input schema / properties / type / enumPrevious value: -[ - "numeric", - "alphanumeric" -]New value: +[ + "numeric", + "alphanumeric", + null +] - changed
Input schema / properties / type / titlePrevious value: -"SenderIdType"New value: +"SenderIDType" - removed
Input schema / properties / type / typeRemoved value: -"string" - changed
Input schema / properties / usecase / descriptionPrevious value: -"Use case for the Sender ID"New value: +"Primary use case for the Sender ID. One of `transactional` (account or order notifications), `promo` (marketing and promotional messages), or `authentication` (one-time passcodes and verification codes)." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / allowlisted_inAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "List of countries where the Sender ID is allowlisted.", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } +} - added
Output schema / properties / idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sender ID ID.", + "example": "3c7a5a90-43e0-43e0-b006-fdfea30c5a7c" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - added
Output schema / properties / samplesAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Message samples.", + "example": [ + "Sample message 1", + "Sample message 2" + ], + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } +} - added
Output schema / properties / sender_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sender ID name.", + "example": "Wavix" +} - added
Output schema / properties / typeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Format of the Sender ID. One of `numeric` (a phone number) or `alphanumeric` (a text sender name).", + "enum": [ + "numeric", + "alphanumeric", + null + ], + "title": "SenderIDType" +} - added
Output schema / properties / usecaseAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Primary use case declared for the Sender ID, such as `transactional`, `promo`, or `authentication`.", + "example": "promo" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "id", + "sender_id", + "type", + "allowlisted_in" +] - added
Output schema / titleAdded value: +"SenderIDDetails" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sms_and_mms_sender_ids_delete6 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"Sender ID ID."New value: +"The unique ID of the Sender ID." - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sms_and_mms_sender_ids_get11 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"Sender ID ID."New value: +"The unique ID of the Sender ID." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / allowlisted_inAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "List of countries where the Sender ID is allowlisted.", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "example": "GB" + } +} - added
Output schema / properties / idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sender ID ID.", + "example": "3c7a5a90-43e0-43e0-b006-fdfea30c5a7c", + "format": "uuid" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - added
Output schema / properties / samplesAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Message samples.", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "example": "Sample" + } +} - added
Output schema / properties / sender_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sender ID.", + "example": "Wavix" +} - added
Output schema / properties / typeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Format of the Sender ID. One of `alphanumeric` (a text sender name), `numeric` (a phone number), or `shortcode` (a short code).", + "enum": [ + "alphanumeric", + "numeric", + "shortcode", + null + ], + "example": "alphanumeric" +} - added
Output schema / properties / usecaseAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Use case for the Sender ID.", + "example": "promo" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "id", + "sender_id", + "type" +] - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
sms_and_mms_sender_ids_list6 fields changed- added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / itemsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "List of Sender IDs.", + "items": { + "additionalProperties": false, + "description": "SMS Sender ID.", + "properties": { + "allowlisted_in": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Two-letter ISO country codes where the Sender ID is allowlisted.", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sender ID ID.", + "example": "3c7a5a90-43e0-43e0-b006-fdfea30c5a7c" + }, + "samples": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Message samples.", + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "example": "sample" + } + }, + "sender_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sender ID name.", + "example": "Wavix" + }, + "type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Format of the Sender ID. One of `numeric` (a phone number) or `alphanumeric` (a text sender name).", + "enum": [ + "numeric", + "alphanumeric", + null + ], + "title": "SenderIDType" + }, + "usecase": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Primary use case declared for the Sender ID, such as `transactional`, `promo`, or `authentication`.", + "example": "promo" + } + }, + "required": [ + "id", + "sender_id", + "type", + "allowlisted_in" + ], + "title": "SenderID", + "type": "object" + } +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "items" +] - added
Output schema / titleAdded value: +"SenderIDListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Removed
speech_analytics_create - Changed
speech_analytics_file_get3 fields changed- added
Input schema / properties / request_idAdded value: +{ + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "request_id" +]
- Changed
speech_analytics_get19 fields changed- added
Input schema / properties / request_idAdded value: +{ + "description": "The `request_id` of the transcription, returned when the file was uploaded.", + "example": "e865ea07-25af-4fdd-876e-04b0d41d5ebd", + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Transcription request ID.", - "example": "e865ea07-25af-4fdd-876e-04b0d41d5ebd", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "request_id" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / chargeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Total transcription charge in USD.", + "example": "0.01" +} - added
Output schema / properties / durationAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "File duration in seconds.", + "example": 102, + "format": "int32" +} - added
Output schema / properties / languageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Language of the transcription, as a two-letter ISO 639-1 code. One of `en` (English), `de` (German), `es` (Spanish), `fr` (French), or `it` (Italian). `null` lets the platform auto-detect the language.", + "enum": [ + "en", + "de", + "es", + "fr", + "it", + null + ], + "example": "en", + "title": "TranscriptionLanguage" +} - added
Output schema / properties / original_fileAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Uploaded file URL.", + "example": "https://api.wavix.com/v1/files/uuid" +} - added
Output schema / properties / request_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Transcription request ID.", + "example": "e84f350f-6da7-4b56-80eb-41dec572626b" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] - } - } - ] -} - added
Output schema / properties / statusAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Outcome of the transcription. One of `completed` (the transcript was produced) or `failed` (the transcription could not be produced).", + "enum": [ + "completed", + "failed", + null + ], + "example": "completed", + "title": "TranscriptionStatus" +} - added
Output schema / properties / transcriptAdded value: +{ + "anyOf": [ + { + "additionalProperties": false, + "properties": { + "channel_1": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Transcription of speaker one.", + "example": "Hi there" + }, + "channel_2": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Transcription of speaker two.", + "example": "Hello" + } + }, + "required": [ + "channel_1", + "channel_2" + ], + "title": "FileTranscriptResponse", + "type": "object" + }, + { + "type": "null" + } + ], + "description": "Complete transcription text attributed to each channel." +} - added
Output schema / properties / transcription_dateAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time of the transcription in ISO 8601 format.", + "example": "2023-01-09T10:04:39.734Z", + "format": "date-time" +} - added
Output schema / properties / transcription_scoreAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / transcription_summaryAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Transcription summary.", + "example": "The agent and client discussed call recording and call transcription" +} - added
Output schema / properties / turnsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "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": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Turn end time in milliseconds from the beginning of the file.", + "example": 18000, + "format": "int32" + }, + "s": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Turn start time in milliseconds from the beginning of the file.", + "example": 3000, + "format": "int32" + }, + "sentiment": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sentiment associated with the turn. Possible values are `positive`, `neutral`, `negative`.", + "example": "positive" + }, + "speaker": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Speaker identifier.", + "example": "channel_1" + }, + "text": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Transcription text attributed to the speaker.", + "example": "Hi there, how are you?" + } + }, + "required": [ + "speaker", + "s", + "e", + "text", + "sentiment" + ], + "title": "FileTranscriptTurn", + "type": "object" + } +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "transcript", + "turns", + "request_id", + "language", + "duration", + "charge", + "status", + "transcription_date", + "transcription_score", + "transcription_summary", + "original_file" +] - added
Output schema / titleAdded value: +"FileTranscriptionResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
speech_analytics_retranscribe7 fields changed- added
Input schema / properties / request_idAdded value: +{ + "description": "The `request_id` of the transcription, returned when the file was uploaded.", + "example": "e865ea07-25af-4fdd-876e-04b0d41d5ebd", + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Transcription request ID.", - "example": "e865ea07-25af-4fdd-876e-04b0d41d5ebd", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "request_id" +] - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
sub_accounts_create18 fields changed- added
Output schema / properties / api_key / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / api_key / typeRemoved value: -"string" - added
Output schema / properties / created_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / created_at / typeRemoved value: -"string" - added
Output schema / properties / default_destinations / properties / dlr_endpoint / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / default_destinations / properties / dlr_endpoint / typeRemoved value: -"string" - added
Output schema / properties / default_destinations / properties / sms_endpoint / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / default_destinations / properties / sms_endpoint / typeRemoved value: -"string" - added
Output schema / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / master_organization / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / master_organization / typeRemoved value: -"integer" - added
Output schema / properties / name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / name / typeRemoved value: -"string" - added
Output schema / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / status / descriptionPrevious value: -"Sub-account status."New value: +"Status of the subaccount. One of `enabled` (the subaccount is active and can be used) or `disabled` (the subaccount is suspended)." - changed
Output schema / properties / status / enumPrevious value: -[ - "enabled", - "disabled" -]New value: +[ + "enabled", + "disabled", + null +] - removed
Output schema / properties / status / typeRemoved value: -"string"
- Changed
sub_accounts_get19 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"Sub-account ID."New value: +"The unique ID of the sub-account." - added
Output schema / properties / api_key / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / api_key / typeRemoved value: -"string" - added
Output schema / properties / created_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / created_at / typeRemoved value: -"string" - added
Output schema / properties / default_destinations / properties / dlr_endpoint / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / default_destinations / properties / dlr_endpoint / typeRemoved value: -"string" - added
Output schema / properties / default_destinations / properties / sms_endpoint / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / default_destinations / properties / sms_endpoint / typeRemoved value: -"string" - added
Output schema / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / master_organization / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / master_organization / typeRemoved value: -"integer" - added
Output schema / properties / name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / name / typeRemoved value: -"string" - added
Output schema / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / status / descriptionPrevious value: -"Sub-account status."New value: +"Status of the subaccount. One of `enabled` (the subaccount is active and can be used) or `disabled` (the subaccount is suspended)." - changed
Output schema / properties / status / enumPrevious value: -[ - "enabled", - "disabled" -]New value: +[ + "enabled", + "disabled", + null +] - removed
Output schema / properties / status / typeRemoved value: -"string"
- Changed
sub_accounts_list32 fields changed- added
Input schema / properties / pageAdded value: +{ + "description": "Page number to retrieve. Default `1`.", + "format": "int32", + "type": "integer" +} - added
Input schema / properties / per_pageAdded value: +{ + "description": "Number of records to return per page. Default `25`.", + "format": "int32", + "type": "integer" +} - changed
Input schema / properties / status / descriptionPrevious value: -"Account status to filter results."New value: +"Filters sub-accounts by status. One of `enabled` (the sub-account is active) or `disabled` (the sub-account is suspended)." - added
Output schema / properties / pagination / properties / current_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / current_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / per_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / per_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / total / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total_pages / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / total_pages / typeRemoved value: -"integer" - added
Output schema / properties / sub_organizations / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / sub_organizations / descriptionAdded value: +"Subaccounts belonging to the authenticated account." - added
Output schema / properties / sub_organizations / items / properties / api_key / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sub_organizations / items / properties / api_key / typeRemoved value: -"string" - added
Output schema / properties / sub_organizations / items / properties / created_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sub_organizations / items / properties / created_at / typeRemoved value: -"string" - added
Output schema / properties / sub_organizations / items / properties / default_destinations / properties / dlr_endpoint / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sub_organizations / items / properties / default_destinations / properties / dlr_endpoint / typeRemoved value: -"string" - added
Output schema / properties / sub_organizations / items / properties / default_destinations / properties / sms_endpoint / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sub_organizations / items / properties / default_destinations / properties / sms_endpoint / typeRemoved value: -"string" - added
Output schema / properties / sub_organizations / items / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sub_organizations / items / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / sub_organizations / items / properties / master_organization / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sub_organizations / items / properties / master_organization / typeRemoved value: -"integer" - added
Output schema / properties / sub_organizations / items / properties / name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / sub_organizations / items / properties / name / typeRemoved value: -"string" - added
Output schema / properties / sub_organizations / items / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / sub_organizations / items / properties / status / descriptionPrevious value: -"Sub-account status."New value: +"Status of the subaccount. One of `enabled` (the subaccount is active and can be used) or `disabled` (the subaccount is suspended)." - changed
Output schema / properties / sub_organizations / items / properties / status / enumPrevious value: -[ - "enabled", - "disabled" -]New value: +[ + "enabled", + "disabled", + null +] - removed
Output schema / properties / sub_organizations / items / properties / status / typeRemoved value: -"string" - removed
Output schema / properties / sub_organizations / typeRemoved value: -"array"
- Changed
sub_accounts_transactions_list39 fields changed- changed
Input schema / properties / from_date / descriptionPrevious value: -"Start date in `YYYY-MM-DD` format."New value: +"Start of the date range to query, in `YYYY-MM-DD` format. Inclusive." - changed
Input schema / properties / id / descriptionPrevious value: -"Sub-account ID."New value: +"The unique ID of the sub-account." - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / to_date / descriptionPrevious value: -"End date in `YYYY-MM-DD` format."New value: +"End of the date range to query, in `YYYY-MM-DD` format. Inclusive." - changed
Input schema / properties / type / anyOfPrevious value: -[ - { - "example": 1, - "format": "int32", - "type": "integer" - }, - { - "example": [ - 1, - 2, - 3 - ], - "items": { - "format": "int32", - "type": "integer" - }, - "type": "array" - } -]New value: +[ + { + "example": 1, + "format": "int32", + "title": "Single type", + "type": "integer" + }, + { + "example": [ + 1, + 2, + 3 + ], + "items": { + "format": "int32", + "type": "integer" + }, + "title": "Multiple types", + "type": "array" + } +] - changed
Input schema / properties / type / descriptionPrevious value: -"Transaction types to filter results."New value: +"Filters transactions by type. Accepts a single transaction type code or an array of codes." - added
Output schema / properties / pagination / properties / current_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / pagination / properties / current_page / examplePrevious value: -1New value: +2 - added
Output schema / properties / pagination / properties / current_page / formatAdded value: +"int32" - removed
Output schema / properties / pagination / properties / current_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / per_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - added
Output schema / properties / pagination / properties / per_page / formatAdded value: +"int32" - removed
Output schema / properties / pagination / properties / per_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / pagination / properties / total / examplePrevious value: -1New value: +101 - added
Output schema / properties / pagination / properties / total / formatAdded value: +"int32" - removed
Output schema / properties / pagination / properties / total / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total_pages / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - added
Output schema / properties / pagination / properties / total_pages / exampleAdded value: +5 - added
Output schema / properties / pagination / properties / total_pages / formatAdded value: +"int32" - removed
Output schema / properties / pagination / properties / total_pages / typeRemoved value: -"integer" - added
Output schema / properties / pagination / requiredAdded value: +[ + "current_page", + "per_page", + "total", + "total_pages" +] - added
Output schema / properties / pagination / titleAdded value: +"Pagination" - added
Output schema / properties / transactions / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / transactions / descriptionAdded value: +"Financial transactions for the subaccount." - added
Output schema / properties / transactions / items / properties / amount / anyOfAdded value: +[ + { + "type": "number" + }, + { + "type": "null" + } +] - removed
Output schema / properties / transactions / items / properties / amount / typeRemoved value: -"number" - added
Output schema / properties / transactions / items / properties / balance_after / anyOfAdded value: +[ + { + "type": "number" + }, + { + "type": "null" + } +] - removed
Output schema / properties / transactions / items / properties / balance_after / typeRemoved value: -"number" - added
Output schema / properties / transactions / items / properties / date / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / transactions / items / properties / date / typeRemoved value: -"string" - added
Output schema / properties / transactions / items / properties / details / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / transactions / items / properties / details / typeRemoved value: -"string" - added
Output schema / properties / transactions / items / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / transactions / items / properties / status / typeRemoved value: -"string" - added
Output schema / properties / transactions / items / properties / type / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / transactions / items / properties / type / typeRemoved value: -"integer" - removed
Output schema / properties / transactions / typeRemoved value: -"array"
- Changed
sub_accounts_update21 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"Sub-account ID."New value: +"The unique ID of the sub-account." - changed
Input schema / properties / status / descriptionPrevious value: -"Sub-account status."New value: +"Status of the subaccount. One of `enabled` (the subaccount is active and can be used) or `disabled` (the subaccount is suspended)." - changed
Input schema / requiredPrevious value: -[ - "id", - "name" -]New value: +[ + "id" +] - added
Output schema / properties / api_key / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / api_key / typeRemoved value: -"string" - added
Output schema / properties / created_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / created_at / typeRemoved value: -"string" - added
Output schema / properties / default_destinations / properties / dlr_endpoint / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / default_destinations / properties / dlr_endpoint / typeRemoved value: -"string" - added
Output schema / properties / default_destinations / properties / sms_endpoint / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / default_destinations / properties / sms_endpoint / typeRemoved value: -"string" - added
Output schema / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / master_organization / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / master_organization / typeRemoved value: -"integer" - added
Output schema / properties / name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / name / typeRemoved value: -"string" - added
Output schema / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / status / descriptionPrevious value: -"Sub-account status."New value: +"Status of the subaccount. One of `enabled` (the subaccount is active and can be used) or `disabled` (the subaccount is suspended)." - changed
Output schema / properties / status / enumPrevious value: -[ - "enabled", - "disabled" -]New value: +[ + "enabled", + "disabled", + null +] - removed
Output schema / properties / status / typeRemoved value: -"string"
- Changed
ten_dlc_brand_appeals_create8 fields changed- added
Input schema / properties / appeal_categories / items / enumAdded value: +[ + "VERIFY_TAX_ID", + "VERIFY_NON_PROFIT", + "VERIFY_GOVERNMENT" +] - changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brand_appeals_list35 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - added
Output schema / properties / result / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / examplePrevious value: -[ - { - "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" - } -]New value: +[ + { + "categories": [ + "VERIFY_TAX_ID" + ], + "created_at": "2024-08-01T14:09:43", + "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:15" + } +] - changed
Output schema / properties / result / items / example / created_atPrevious value: -"2024-08-01T14:09:43Z"New value: +"2024-08-01T14:09:43" - changed
Output schema / properties / result / items / example / updated_atPrevious value: -"2024-08-01T18:33:15Z"New value: +"2024-08-01T18:33:15" - added
Output schema / properties / result / items / properties / categories / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / categories / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / categories / items / typeRemoved value: -"string" - removed
Output schema / properties / result / items / properties / categories / typeRemoved value: -"array" - added
Output schema / properties / result / items / properties / created_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / created_at / examplePrevious value: -"2024-08-01T14:09:43Z"New value: +"2024-08-01T14:09:43" - removed
Output schema / properties / result / items / properties / created_at / formatRemoved value: -"date-time" - removed
Output schema / properties / result / items / properties / created_at / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / evidence / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / evidence / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / evidence / items / typeRemoved value: -"string" - removed
Output schema / properties / result / items / properties / evidence / typeRemoved value: -"array" - added
Output schema / properties / result / items / properties / explanation / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / explanation / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / outcome / additionalPropertiesAdded value: +false - removed
Output schema / properties / result / items / properties / outcome / allOfRemoved value: -[ - { - "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" - } -] - added
Output schema / properties / result / items / properties / outcome / descriptionAdded value: +"The appeal outcome details" - added
Output schema / properties / result / items / properties / outcome / propertiesAdded value: +{ + "feedback": { + "additionalProperties": false, + "description": "Brand Identity Verification appeal feedback, if any", + "properties": { + "category": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "The feedback category", + "items": { + "additionalProperties": false, + "description": "TCR returns the feedback per submitted appeal category", + "properties": { + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The description of the category", + "example": "Select this category if the record is UNVERIFIED due to an inability to match the tax ID." + }, + "display_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The display name of the category", + "example": "Verify tax ID" + }, + "errors": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "An array of verification errors, if any", + "items": { + "additionalProperties": false, + "example": { + "code": "TFTI01", + "message": "The submitted US EIN is invalid." + }, + "properties": { + "code": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "TCR error code" + }, + "message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "A human-readable error description" + } + }, + "required": [ + "code", + "message" + ], + "title": "TCRErrorMessage", + "type": "object" + } + }, + "fields": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "An array of Brand attributes" + }, + "id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The submitted appeal category", + "example": "VERIFY_TAX_ID" + } + }, + "required": [ + "id", + "display_name", + "description", + "fields", + "errors" + ], + "title": "TCRFeedbackCategory", + "type": "object" + } + } + }, + "required": [ + "category" + ], + "title": "TCRFeedback", + "type": "object" + }, + "optional_attributes": { + "additionalProperties": false, + "description": "An optional attributes that might be returned from TCR", + "type": "object" + }, + "vetting_status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Identity verification status of the 10DLC Brand. One of:\n\n- `REVIEW` — verification is in progress.\n- `VERIFIED` — the Brand passed standard verification.\n- `UNVERIFIED` — verification has not succeeded.\n- `VETTED_VERIFIED` — the Brand also passed third-party vetting.\n- `SUSPENDED` — the Brand is blocked from sending.", + "enum": [ + "REVIEW", + "VERIFIED", + "UNVERIFIED", + "VETTED_VERIFIED", + "SUSPENDED", + null + ], + "example": "UNVERIFIED", + "title": "TenDLCBrandIdentityVerificationStatus" + } +} - added
Output schema / properties / result / items / properties / outcome / requiredAdded value: +[ + "optional_attributes", + "vetting_status", + "feedback" +] - added
Output schema / properties / result / items / properties / outcome / titleAdded value: +"TenDLCBrandAppealOutcome" - added
Output schema / properties / result / items / properties / outcome / typeAdded value: +"object" - added
Output schema / properties / result / items / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / status / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / updated_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / updated_at / examplePrevious value: -"2024-08-01T14:09:43Z"New value: +"2024-08-01T14:09:43" - removed
Output schema / properties / result / items / properties / updated_at / formatRemoved value: -"date-time" - removed
Output schema / properties / result / items / properties / updated_at / typeRemoved value: -"string" - changed
Output schema / properties / result / items / titlePrevious value: -"TenDlcBrandAppeal"New value: +"TenDLCBrandAppeal" - removed
Output schema / properties / result / typeRemoved value: -"array"
- Changed
ten_dlc_brand_campaigns_create88 fields changed- changed
Input schema / properties / affiliate_marketing / descriptionPrevious value: -"Indicates whether the Campaign is used for affiliate marketing"New value: +"Indicates whether the Campaign is used for affiliate marketing." - changed
Input schema / properties / age_gated / descriptionPrevious value: -"Indicates whether the Campaign messages contain age-gated content"New value: +"Indicates whether the Campaign messages contain age-gated content." - changed
Input schema / properties / auto_renewal / descriptionPrevious value: -"Indicates whether the Campaign should be automatically renewed"New value: +"Indicates whether the Campaign is automatically renewed at the end of each billing period." - changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / description / descriptionPrevious value: -"The Campaign description"New value: +"Description of the Campaign and its messaging purpose." - changed
Input schema / properties / direct_lending / descriptionPrevious value: -"Indicates whether the Campaign messages contain direct lending content"New value: +"Indicates whether the Campaign messages contain direct lending content." - added
Input schema / properties / embedded_link_sample / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / embedded_link_sample / descriptionPrevious value: -"An embedded link sample"New value: +"Sample of an embedded link used in Campaign messages." - removed
Input schema / properties / embedded_link_sample / typeRemoved value: -[ - "string", - "null" -] - changed
Input schema / properties / embedded_links / descriptionPrevious value: -"Indicates whether the Campaign messages contain embedded links"New value: +"Indicates whether the Campaign messages contain embedded links." - added
Input schema / properties / embedded_phones / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - changed
Input schema / properties / embedded_phones / descriptionPrevious value: -"Indicates whether the Campaign messages contain embedded phone numbers"New value: +"Indicates whether the Campaign messages contain embedded phone numbers." - removed
Input schema / properties / embedded_phones / typeRemoved value: -[ - "boolean", - "null" -] - changed
Input schema / properties / help / descriptionPrevious value: -"Indicates whether the campaign has a help system (e.g. keyword: HELP, INFO) that subscribers can use or not."New value: +"Indicates whether the Campaign provides a help system that subscribers can trigger with a keyword such as HELP or INFO." - changed
Input schema / properties / help_keywords / descriptionPrevious value: -"A comma-separated list of HELP keywords. The HELP keywords are case-insensitive."New value: +"Comma-separated list of help keywords. Keywords are case-insensitive." - changed
Input schema / properties / help_message / descriptionPrevious value: -"An acknowledgement to be sent when a HELP keyword is received"New value: +"Acknowledgement sent when a subscriber texts a help keyword." - changed
Input schema / properties / mock / descriptionPrevious value: -"Indicates a mock Campaign. The mock Campaigns cannot be used to send production traffic"New value: +"Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic." - changed
Input schema / properties / name / descriptionPrevious value: -"A user-defined Campaign name"New value: +"Display name of the Campaign." - changed
Input schema / properties / optin / descriptionPrevious value: -"Indicates whether the campaign requires a subscriber to opt-in before receiving messages or not."New value: +"Indicates whether the Campaign requires subscribers to opt in before receiving messages." - changed
Input schema / properties / optin_keywords / descriptionPrevious value: -"A comma-separated list of OPT-IN keywords. The OPT-IN keywords are case-insensitive."New value: +"Comma-separated list of opt-in keywords. Keywords are case-insensitive." - changed
Input schema / properties / optin_message / descriptionPrevious value: -"An acknowledgement to be sent when an OPT-IN keyword is received"New value: +"Acknowledgement sent when a subscriber texts an opt-in keyword." - changed
Input schema / properties / optin_workflow / descriptionPrevious value: -"The opt-in workflow - the process through which consumers opt-in to the Campaign"New value: +"Description of the workflow through which subscribers opt in to the Campaign." - changed
Input schema / properties / optout / descriptionPrevious value: -"Indicates whether the campaign has an opt-out system (e.g. keyword: STOP, QUIT) that subscribers can use or not."New value: +"Indicates whether the Campaign provides an opt-out system that subscribers can trigger with a keyword such as STOP or QUIT." - changed
Input schema / properties / optout_keywords / descriptionPrevious value: -"A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive."New value: +"Comma-separated list of opt-out keywords. Keywords are case-insensitive." - changed
Input schema / properties / optout_message / descriptionPrevious value: -"An acknowledgement to be sent when an OPT-OUT keyword is received"New value: +"Acknowledgement sent when a subscriber texts an opt-out keyword." - changed
Input schema / properties / privacy_policy / descriptionPrevious value: -"A link to the Campaign privacy policy"New value: +"URL of the Campaign privacy policy." - changed
Input schema / properties / sample1 / descriptionPrevious value: -"Message sample"New value: +"Sample message demonstrating the content sent through the Campaign." - added
Input schema / properties / sample2 / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / sample2 / descriptionPrevious value: -"Message sample"New value: +"Sample message demonstrating the content sent through the Campaign." - removed
Input schema / properties / sample2 / typeRemoved value: -[ - "string", - "null" -] - added
Input schema / properties / sample3 / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / sample3 / descriptionPrevious value: -"Message sample"New value: +"Sample message demonstrating the content sent through the Campaign." - removed
Input schema / properties / sample3 / typeRemoved value: -[ - "string", - "null" -] - added
Input schema / properties / sample4 / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / sample4 / descriptionPrevious value: -"Message sample"New value: +"Sample message demonstrating the content sent through the Campaign." - removed
Input schema / properties / sample4 / typeRemoved value: -[ - "string", - "null" -] - added
Input schema / properties / sample5 / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / sample5 / descriptionPrevious value: -"Message sample"New value: +"Sample message demonstrating the content sent through the Campaign." - removed
Input schema / properties / sample5 / typeRemoved value: -[ - "string", - "null" -] - changed
Input schema / properties / terms_conditions / descriptionPrevious value: -"A link to the Campaign terms and conditions"New value: +"URL of the Campaign terms and conditions." - changed
Input schema / properties / usecase / descriptionPrevious value: -"The Campaign use case"New value: +"Registered use case for the Campaign, such as `2FA` or `MARKETING`." - changed
Input schema / requiredPrevious value: -[ - "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" -]New value: +[ + "brand_id", + "affiliate_marketing", + "age_gated", + "auto_renewal", + "direct_lending", + "embedded_links", + "description", + "optin_workflow", + "help", + "help_keywords", + "help_message", + "optin", + "optin_keywords", + "optin_message", + "optout", + "optout_keywords", + "optout_message", + "name", + "sample1", + "mock", + "usecase", + "terms_conditions" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"Represents a 10DLC campaign registered under a Brand. A Campaign defines the messaging use case, opt-in and opt-out flows, and the phone numbers permitted to send its traffic." - added
Output schema / exampleAdded value: +{ + "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" +} - added
Output schema / properties / affiliate_marketingAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign is used for affiliate marketing.", + "example": false +} - added
Output schema / properties / age_gatedAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain age-gated content.", + "example": false +} - added
Output schema / properties / auto_renewalAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign should be automatically renewed.", + "example": true +} - added
Output schema / properties / brand_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Brand that owns the Campaign.", + "example": "BM20QP9" +} - added
Output schema / properties / campaign_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Campaign assigned by the registry.", + "example": "CKLCK95" +} - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Campaign was created, in ISO 8601 format.", + "example": "2024-08-14T11:57:41" +} - added
Output schema / properties / descriptionAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Description of the Campaign and its messaging purpose.", + "example": "Our campaign aims to …" +} - added
Output schema / properties / direct_lendingAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain direct lending content.", + "example": true +} - added
Output schema / properties / embedded_link_sampleAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample of an embedded link used in Campaign messages." +} - added
Output schema / properties / embedded_linksAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain embedded links.", + "example": true +} - added
Output schema / properties / embedded_phonesAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain embedded phone numbers.", + "example": true +} - added
Output schema / properties / feedbackAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Feedback from the registry explaining the current `status`." +} - added
Output schema / properties / helpAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).", + "example": true +} - added
Output schema / properties / help_keywordsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of help keywords. Keywords are case-insensitive.", + "example": "help" +} - added
Output schema / properties / help_messageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Help message sent upon receiving a help keyword.", + "example": "For help, please visit www.site.com. To opt out, reply STOP." +} - added
Output schema / properties / last_bill_dateAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / mockAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.", + "example": false +} - added
Output schema / properties / monthly_feeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Recurring monthly fee charged for the Campaign, as a decimal string.", + "example": "10.0" +} - added
Output schema / properties / nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Display name of the Campaign.", + "example": "My first campaign" +} - added
Output schema / properties / next_bill_dateAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / optinAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign requires subscriber opt-in.", + "example": true +} - added
Output schema / properties / optin_keywordsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of opt-in keywords. Keywords are case-insensitive.", + "example": "begin,start" +} - added
Output schema / properties / optin_messageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / optin_workflowAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Description of the workflow through which subscribers opt in to the Campaign.", + "example": "Our SMS ..." +} - added
Output schema / properties / optoutAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).", + "example": true +} - added
Output schema / properties / optout_keywordsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of opt-out keywords. Keywords are case-insensitive.", + "example": "stop,quit,unsubscribe" +} - added
Output schema / properties / optout_messageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Opt-out message sent upon receiving an opt-out keyword.", + "example": "You are now opted out and will receive no further messages" +} - added
Output schema / properties / phone_numbersAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Phone numbers assigned to the Campaign, in E.164 format.", + "example": [ + "14358684439", + "13193337776", + "12673296046" + ], + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } +} - added
Output schema / properties / privacy_policyAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Privacy policy URL.", + "example": "https://site.com/privacy-policy" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - } - ] -} - added
Output schema / properties / sample1Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign.", + "example": "Your verification code is XXXXXX" +} - added
Output schema / properties / sample2Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / sample3Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / sample4Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / sample5Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / statusAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Current registration status of the Campaign, such as `APPROVED` or `PENDING`.", + "example": "APPROVED" +} - added
Output schema / properties / terms_conditionsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Terms and conditions URL.", + "example": "https://site.com/terms-and-conditions" +} - added
Output schema / properties / updated_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Campaign was last updated, in ISO 8601 format.", + "example": "2024-08-14T11:57:47" +} - added
Output schema / properties / usecaseAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registered use case for the Campaign, such as `2FA` or `MARKETING`.", + "example": "2FA" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "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" +] - added
Output schema / titleAdded value: +"TenDLCCampaign" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brand_campaigns_delete8 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / campaign_id / descriptionPrevious value: -"Campaign ID."New value: +"The unique ID of the 10DLC Campaign." - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brand_campaigns_get48 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / campaign_id / descriptionPrevious value: -"Campaign ID."New value: +"The unique ID of the 10DLC Campaign." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"Represents a 10DLC campaign registered under a Brand. A Campaign defines the messaging use case, opt-in and opt-out flows, and the phone numbers permitted to send its traffic." - added
Output schema / exampleAdded value: +{ + "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" +} - added
Output schema / properties / affiliate_marketingAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign is used for affiliate marketing.", + "example": false +} - added
Output schema / properties / age_gatedAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain age-gated content.", + "example": false +} - added
Output schema / properties / auto_renewalAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign should be automatically renewed.", + "example": true +} - added
Output schema / properties / brand_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Brand that owns the Campaign.", + "example": "BM20QP9" +} - added
Output schema / properties / campaign_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Campaign assigned by the registry.", + "example": "CKLCK95" +} - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Campaign was created, in ISO 8601 format.", + "example": "2024-08-14T11:57:41" +} - added
Output schema / properties / descriptionAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Description of the Campaign and its messaging purpose.", + "example": "Our campaign aims to …" +} - added
Output schema / properties / direct_lendingAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain direct lending content.", + "example": true +} - added
Output schema / properties / embedded_link_sampleAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample of an embedded link used in Campaign messages." +} - added
Output schema / properties / embedded_linksAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain embedded links.", + "example": true +} - added
Output schema / properties / embedded_phonesAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain embedded phone numbers.", + "example": true +} - added
Output schema / properties / feedbackAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Feedback from the registry explaining the current `status`." +} - added
Output schema / properties / helpAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).", + "example": true +} - added
Output schema / properties / help_keywordsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of help keywords. Keywords are case-insensitive.", + "example": "help" +} - added
Output schema / properties / help_messageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Help message sent upon receiving a help keyword.", + "example": "For help, please visit www.site.com. To opt out, reply STOP." +} - added
Output schema / properties / last_bill_dateAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / mockAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.", + "example": false +} - added
Output schema / properties / monthly_feeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Recurring monthly fee charged for the Campaign, as a decimal string.", + "example": "10.0" +} - added
Output schema / properties / nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Display name of the Campaign.", + "example": "My first campaign" +} - added
Output schema / properties / next_bill_dateAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / optinAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign requires subscriber opt-in.", + "example": true +} - added
Output schema / properties / optin_keywordsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of opt-in keywords. Keywords are case-insensitive.", + "example": "begin,start" +} - added
Output schema / properties / optin_messageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / optin_workflowAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Description of the workflow through which subscribers opt in to the Campaign.", + "example": "Our SMS ..." +} - added
Output schema / properties / optoutAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).", + "example": true +} - added
Output schema / properties / optout_keywordsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of opt-out keywords. Keywords are case-insensitive.", + "example": "stop,quit,unsubscribe" +} - added
Output schema / properties / optout_messageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Opt-out message sent upon receiving an opt-out keyword.", + "example": "You are now opted out and will receive no further messages" +} - added
Output schema / properties / phone_numbersAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Phone numbers assigned to the Campaign, in E.164 format.", + "example": [ + "14358684439", + "13193337776", + "12673296046" + ], + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } +} - added
Output schema / properties / privacy_policyAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Privacy policy URL.", + "example": "https://site.com/privacy-policy" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - } - ] -} - added
Output schema / properties / sample1Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign.", + "example": "Your verification code is XXXXXX" +} - added
Output schema / properties / sample2Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / sample3Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / sample4Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / sample5Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / statusAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Current registration status of the Campaign, such as `APPROVED` or `PENDING`.", + "example": "APPROVED" +} - added
Output schema / properties / terms_conditionsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Terms and conditions URL.", + "example": "https://site.com/terms-and-conditions" +} - added
Output schema / properties / updated_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Campaign was last updated, in ISO 8601 format.", + "example": "2024-08-14T11:57:47" +} - added
Output schema / properties / usecaseAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registered use case for the Campaign, such as `2FA` or `MARKETING`.", + "example": "2FA" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "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" +] - added
Output schema / titleAdded value: +"TenDLCCampaign" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brand_campaigns_list19 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / created_after / descriptionPrevious value: -"Campaign creation start date in `YYYY-MM-DD` format."New value: +"Returns Campaigns created on or after this date, in `YYYY-MM-DD` format." - changed
Input schema / properties / created_before / descriptionPrevious value: -"Campaign creation end date in `YYYY-MM-DD` format."New value: +"Returns Campaigns created on or before this date, in `YYYY-MM-DD` format." - changed
Input schema / properties / mock / descriptionPrevious value: -"Indicates whether to include mock Campaigns only."New value: +"When `true`, returns only mock Campaigns used for testing. Default `false`." - changed
Input schema / properties / name / descriptionPrevious value: -"Campaign name."New value: +"Filters Campaigns by name. Matches partial values." - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / status / descriptionPrevious value: -"Campaign status."New value: +"Filters Campaigns by status." - changed
Input schema / properties / usecase / descriptionPrevious value: -"Use case."New value: +"Filters Campaigns by use case." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"Paginated list of 10DLC Campaigns." - added
Output schema / exampleAdded value: +{ + "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 + } +} - added
Output schema / properties / itemsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "10DLC Campaigns on the current page that match the filter criteria.", + "items": { + "additionalProperties": false, + "description": "Represents a 10DLC campaign registered under a Brand. A Campaign defines the messaging use case, opt-in and opt-out flows, and the phone numbers permitted to send its traffic.", + "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": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign is used for affiliate marketing.", + "example": false + }, + "age_gated": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain age-gated content.", + "example": false + }, + "auto_renewal": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign should be automatically renewed.", + "example": true + }, + "brand_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Brand that owns the Campaign.", + "example": "BM20QP9" + }, + "campaign_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Campaign assigned by the registry.", + "example": "CKLCK95" + }, + "created_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Campaign was created, in ISO 8601 format.", + "example": "2024-08-14T11:57:41" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Description of the Campaign and its messaging purpose.", + "example": "Our campaign aims to …" + }, + "direct_lending": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain direct lending content.", + "example": true + }, + "embedded_link_sample": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample of an embedded link used in Campaign messages." + }, + "embedded_links": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain embedded links.", + "example": true + }, + "embedded_phones": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain embedded phone numbers.", + "example": true + }, + "feedback": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Feedback from the registry explaining the current `status`." + }, + "help": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).", + "example": true + }, + "help_keywords": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of help keywords. Keywords are case-insensitive.", + "example": "help" + }, + "help_message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Help message sent upon receiving a help keyword.", + "example": "For help, please visit www.site.com. To opt out, reply STOP." + }, + "last_bill_date": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "mock": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.", + "example": false + }, + "monthly_fee": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Recurring monthly fee charged for the Campaign, as a decimal string.", + "example": "10.0" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Display name of the Campaign.", + "example": "My first campaign" + }, + "next_bill_date": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "optin": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign requires subscriber opt-in.", + "example": true + }, + "optin_keywords": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of opt-in keywords. Keywords are case-insensitive.", + "example": "begin,start" + }, + "optin_message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "optin_workflow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Description of the workflow through which subscribers opt in to the Campaign.", + "example": "Our SMS ..." + }, + "optout": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).", + "example": true + }, + "optout_keywords": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of opt-out keywords. Keywords are case-insensitive.", + "example": "stop,quit,unsubscribe" + }, + "optout_message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Opt-out message sent upon receiving an opt-out keyword.", + "example": "You are now opted out and will receive no further messages" + }, + "phone_numbers": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Phone numbers assigned to the Campaign, in E.164 format.", + "example": [ + "14358684439", + "13193337776", + "12673296046" + ], + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "privacy_policy": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Privacy policy URL.", + "example": "https://site.com/privacy-policy" + }, + "sample1": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign.", + "example": "Your verification code is XXXXXX" + }, + "sample2": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." + }, + "sample3": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." + }, + "sample4": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." + }, + "sample5": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." + }, + "status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Current registration status of the Campaign, such as `APPROVED` or `PENDING`.", + "example": "APPROVED" + }, + "terms_conditions": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Terms and conditions URL.", + "example": "https://site.com/terms-and-conditions" + }, + "updated_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Campaign was last updated, in ISO 8601 format.", + "example": "2024-08-14T11:57:47" + }, + "usecase": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registered use case for the Campaign, such as `2FA` or `MARKETING`.", + "example": "2FA" + } + }, + "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" + } +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "description": "Pagination metadata for the result set.", + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "items", + "pagination" +] - added
Output schema / titleAdded value: +"TenDLCCampaignListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brand_campaigns_update76 fields changed- changed
Input schema / properties / age_gated / descriptionPrevious value: -"Indicates whether the Campaign messages contain age-gated content"New value: +"Indicates whether the Campaign messages contain age-gated content." - changed
Input schema / properties / auto_renewal / descriptionPrevious value: -"Indicates whether the Campaign should be automatically renewed"New value: +"Indicates whether the Campaign is automatically renewed at the end of each billing period." - changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / campaign_id / descriptionPrevious value: -"Campaign ID."New value: +"The unique ID of the 10DLC Campaign." - changed
Input schema / properties / description / descriptionPrevious value: -"The Campaign description"New value: +"Description of the Campaign and its messaging purpose." - changed
Input schema / properties / direct_lending / descriptionPrevious value: -"Indicates whether the Campaign messages contain direct lending content"New value: +"Indicates whether the Campaign messages contain direct lending content." - changed
Input schema / properties / embedded_link_sample / descriptionPrevious value: -"An embedded link sample"New value: +"Sample of an embedded link used in Campaign messages." - changed
Input schema / properties / embedded_links / descriptionPrevious value: -"Indicates whether the Campaign messages contain embedded links"New value: +"Indicates whether the Campaign messages contain embedded links." - changed
Input schema / properties / embedded_phones / descriptionPrevious value: -"Indicates whether the Campaign messages contain embedded phone numbers"New value: +"Indicates whether the Campaign messages contain embedded phone numbers." - changed
Input schema / properties / help / descriptionPrevious value: -"Indicates whether the Campaign provides HELP responses"New value: +"Indicates whether the Campaign provides a help system that subscribers can trigger with a keyword." - changed
Input schema / properties / help_keywords / descriptionPrevious value: -"A comma-separated list of HELP keywords. The HELP keywords are case-insensitive."New value: +"Comma-separated list of help keywords. Keywords are case-insensitive." - changed
Input schema / properties / help_message / descriptionPrevious value: -"An acknowledgement to be sent when a HELP keyword is received"New value: +"Acknowledgement sent when a subscriber texts a help keyword." - changed
Input schema / properties / name / descriptionPrevious value: -"A user-defined Campaign name"New value: +"Display name of the Campaign." - changed
Input schema / properties / optin / descriptionPrevious value: -"Indicates whether the Campaign supports opt-in functionality"New value: +"Indicates whether the Campaign requires subscribers to opt in before receiving messages." - changed
Input schema / properties / optin_keywords / descriptionPrevious value: -"A comma-separated list of OPT-IN keywords. The OPT-IN keywords are case-insensitive."New value: +"Comma-separated list of opt-in keywords. Keywords are case-insensitive." - changed
Input schema / properties / optin_message / descriptionPrevious value: -"An acknowledgement to be sent when an OPT-IN keyword is received"New value: +"Acknowledgement sent when a subscriber texts an opt-in keyword." - changed
Input schema / properties / optin_workflow / descriptionPrevious value: -"The opt-in workflow - the process through which consumers opt-in to the Campaign"New value: +"Description of the workflow through which subscribers opt in to the Campaign." - changed
Input schema / properties / optout / descriptionPrevious value: -"Indicates whether the Campaign supports opt-out functionality"New value: +"Indicates whether the Campaign provides an opt-out system that subscribers can trigger with a keyword." - changed
Input schema / properties / optout_keywords / descriptionPrevious value: -"A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive."New value: +"Comma-separated list of opt-out keywords. Keywords are case-insensitive." - changed
Input schema / properties / optout_message / descriptionPrevious value: -"An acknowledgement to be sent when an OPT-OUT keyword is received"New value: +"Acknowledgement sent when a subscriber texts an opt-out keyword." - changed
Input schema / properties / optout_message / examplePrevious value: -"A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive."New value: +"You have been unsubscribed and will receive no further messages." - changed
Input schema / properties / privacy_policy / descriptionPrevious value: -"A link to the Campaign privacy policy"New value: +"URL of the Campaign privacy policy." - changed
Input schema / properties / privacy_policy / examplePrevious value: -"PROFESSIONAL"New value: +"https://site.com/privacy-policy" - changed
Input schema / properties / sample1 / descriptionPrevious value: -"Message sample"New value: +"Sample message demonstrating the content sent through the Campaign." - changed
Input schema / properties / sample2 / descriptionPrevious value: -"Message sample"New value: +"Sample message demonstrating the content sent through the Campaign." - changed
Input schema / properties / sample3 / descriptionPrevious value: -"Message sample"New value: +"Sample message demonstrating the content sent through the Campaign." - changed
Input schema / properties / sample4 / descriptionPrevious value: -"Message sample"New value: +"Sample message demonstrating the content sent through the Campaign." - changed
Input schema / properties / sample5 / descriptionPrevious value: -"Message sample"New value: +"Sample message demonstrating the content sent through the Campaign." - changed
Input schema / properties / terms_conditions / descriptionPrevious value: -"A link to the Campaign terms and conditions"New value: +"URL of the Campaign terms and conditions." - changed
Input schema / properties / usecase / descriptionPrevious value: -"Campaign use case"New value: +"Registered use case for the Campaign. One of `CUSTOMER_CARE` (customer support messaging), `MARKETING` (promotional content), `ACCOUNT_NOTIFICATION` (account-related alerts), `FRAUD_ALERT` (fraud and suspicious-activity warnings), `PUBLIC_SERVICE_ANNOUNCEMENT` (public-interest notices), or `SECURITY_ALERT` (security-related warnings).\n" - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"Represents a 10DLC campaign registered under a Brand. A Campaign defines the messaging use case, opt-in and opt-out flows, and the phone numbers permitted to send its traffic." - added
Output schema / exampleAdded value: +{ + "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" +} - added
Output schema / properties / affiliate_marketingAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign is used for affiliate marketing.", + "example": false +} - added
Output schema / properties / age_gatedAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain age-gated content.", + "example": false +} - added
Output schema / properties / auto_renewalAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign should be automatically renewed.", + "example": true +} - added
Output schema / properties / brand_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Brand that owns the Campaign.", + "example": "BM20QP9" +} - added
Output schema / properties / campaign_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Campaign assigned by the registry.", + "example": "CKLCK95" +} - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Campaign was created, in ISO 8601 format.", + "example": "2024-08-14T11:57:41" +} - added
Output schema / properties / descriptionAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Description of the Campaign and its messaging purpose.", + "example": "Our campaign aims to …" +} - added
Output schema / properties / direct_lendingAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain direct lending content.", + "example": true +} - added
Output schema / properties / embedded_link_sampleAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample of an embedded link used in Campaign messages." +} - added
Output schema / properties / embedded_linksAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain embedded links.", + "example": true +} - added
Output schema / properties / embedded_phonesAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain embedded phone numbers.", + "example": true +} - added
Output schema / properties / feedbackAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Feedback from the registry explaining the current `status`." +} - added
Output schema / properties / helpAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).", + "example": true +} - added
Output schema / properties / help_keywordsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of help keywords. Keywords are case-insensitive.", + "example": "help" +} - added
Output schema / properties / help_messageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Help message sent upon receiving a help keyword.", + "example": "For help, please visit www.site.com. To opt out, reply STOP." +} - added
Output schema / properties / last_bill_dateAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / mockAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.", + "example": false +} - added
Output schema / properties / monthly_feeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Recurring monthly fee charged for the Campaign, as a decimal string.", + "example": "10.0" +} - added
Output schema / properties / nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Display name of the Campaign.", + "example": "My first campaign" +} - added
Output schema / properties / next_bill_dateAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / optinAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign requires subscriber opt-in.", + "example": true +} - added
Output schema / properties / optin_keywordsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of opt-in keywords. Keywords are case-insensitive.", + "example": "begin,start" +} - added
Output schema / properties / optin_messageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / optin_workflowAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Description of the workflow through which subscribers opt in to the Campaign.", + "example": "Our SMS ..." +} - added
Output schema / properties / optoutAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).", + "example": true +} - added
Output schema / properties / optout_keywordsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of opt-out keywords. Keywords are case-insensitive.", + "example": "stop,quit,unsubscribe" +} - added
Output schema / properties / optout_messageAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Opt-out message sent upon receiving an opt-out keyword.", + "example": "You are now opted out and will receive no further messages" +} - added
Output schema / properties / phone_numbersAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Phone numbers assigned to the Campaign, in E.164 format.", + "example": [ + "14358684439", + "13193337776", + "12673296046" + ], + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } +} - added
Output schema / properties / privacy_policyAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Privacy policy URL.", + "example": "https://site.com/privacy-policy" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - } - ] -} - added
Output schema / properties / sample1Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign.", + "example": "Your verification code is XXXXXX" +} - added
Output schema / properties / sample2Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / sample3Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / sample4Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / sample5Added value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." +} - added
Output schema / properties / statusAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Current registration status of the Campaign, such as `APPROVED` or `PENDING`.", + "example": "APPROVED" +} - added
Output schema / properties / terms_conditionsAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Terms and conditions URL.", + "example": "https://site.com/terms-and-conditions" +} - added
Output schema / properties / updated_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Campaign was last updated, in ISO 8601 format.", + "example": "2024-08-14T11:57:47" +} - added
Output schema / properties / usecaseAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registered use case for the Campaign, such as `2FA` or `MARKETING`.", + "example": "2FA" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "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" +] - added
Output schema / titleAdded value: +"TenDLCCampaign" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brand_evidence_delete10 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - added
Input schema / properties / idAdded value: +{ + "description": "The unique ID of the Brand evidence file.", + "example": "191eb205-8357-4d71-b8da-160a25a000d7", + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Evidence ID.", - "example": "191eb205-8357-4d71-b8da-160a25a000d7", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "brand_id", - "uuid" -]New value: +[ + "brand_id", + "id" +] - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brand_evidence_get3 fields changed- added
Input schema / properties / idAdded value: +{ + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "brand_id", - "uuid" -]New value: +[ + "brand_id", + "id" +]
- Changed
ten_dlc_brand_evidence_list16 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Unique identifier of a Brand"New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - removed
Output schema / exampleRemoved value: -{ - "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" - } - ] -} - added
Output schema / properties / items / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / example / urlPrevious value: -"https://api.wavix.dev/v3/10dlc/brands/B6AI7PA/evidence/191eb205-8357-4d71-b8da-160a25a000d7"New value: +"https://api.wavix.com/v3/10dlc/brands/B6AI7PA/evidence/191eb205-8357-4d71-b8da-160a25a000d7" - added
Output schema / properties / items / items / properties / file_name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / file_name / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / mime_type / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / mime_type / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / properties / url / examplePrevious value: -"https://api.wavix.dev/v3/10dlc/brands/B6AI7PA/evidence/191eb205-8357-4d71-b8da-160a25a000d7"New value: +"https://api.wavix.com/v3/10dlc/brands/B6AI7PA/evidence/191eb205-8357-4d71-b8da-160a25a000d7" - removed
Output schema / properties / items / items / properties / url / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / uuid / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / uuid / typeRemoved value: -"string" - changed
Output schema / properties / items / items / titlePrevious value: -"TenDlcBrandEvidence"New value: +"TenDLCBrandEvidence" - removed
Output schema / properties / items / typeRemoved value: -"array"
- Removed
ten_dlc_brand_evidence_upload - Changed
ten_dlc_brand_usecase_qualify12 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / use_case / descriptionPrevious value: -"Use case name."New value: +"Name of the use case to qualify the Brand for." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / exampleAdded value: +{ + "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" +} - added
Output schema / properties / mno_metadataAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "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, + "description": "Represents per-MNO 10DLC requirements and throughput limits that apply to a campaign use case.", + "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": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "MMS throughput per minute allowed on the AT&T network.", + "format": "int32" + }, + "att_msg_class": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Message class assigned by AT&T." + }, + "att_sms_tpm": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "SMS throughput per minute allowed on the AT&T network.", + "format": "int32" + }, + "att_tpm_scope": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Scope of the AT&T throughput-per-minute allocation.", + "format": "int32" + }, + "help_required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether help keywords and an acknowledgement are mandatory for the use case.", + "example": true + }, + "min_msg_samples": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Minimum number of message samples the MNO requires for the use case.", + "example": 1, + "format": "int32" + }, + "mno": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Name of the mobile network operator (MNO) these requirements apply to.", + "example": "T-Mobile" + }, + "mno_qualify": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Brand qualifies with the MNO for the selected use case.", + "example": true + }, + "mno_review": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the MNO requires a post-approval review of the use case.", + "example": false + }, + "mno_support": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the MNO supports the use case.", + "example": true + }, + "no_embedded_links": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether embedded links are prohibited in message content for the use case.", + "example": false + }, + "no_embedded_phone": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether embedded phone numbers are prohibited in message content for the use case.", + "example": false + }, + "optin_required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether an opt-in mechanism is mandatory for the use case.", + "example": true + }, + "optout_required": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether an opt-out mechanism is mandatory for the use case.", + "example": false + }, + "tmobile_brand_dcap": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Daily message cap allowed on the T-Mobile network.", + "example": 2000, + "format": "int32" + }, + "tmobile_brand_tier": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Brand tier assigned on the T-Mobile network, such as `LOW`.", + "example": "LOW" + } + }, + "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" + } +} - added
Output schema / properties / monthly_feeAdded value: +{ + "anyOf": [ + { + "type": "number" + }, + { + "type": "null" + } + ], + "description": "Monthly fee associated with any Campaign with this use case", + "example": 10 +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - } - ] -} - added
Output schema / properties / usecaseAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The use case name", + "example": "2FA" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "mno_metadata", + "monthly_fee", + "usecase" +] - added
Output schema / titleAdded value: +"TenDLCBrandQualificationResult" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brand_vetting_appeals_create9 fields changed- changed
Input schema / properties / appeal_categories / descriptionPrevious value: -"List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`, `LOW_SCORE`."New value: +"List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`, `LOW_SCORE`. `LOW_SCORE` is only valid for vetting appeals — brand identity appeals (`ten_dlc_brand_appeals_create`) do not accept it." - added
Input schema / properties / appeal_categories / items / enumAdded value: +[ + "VERIFY_TAX_ID", + "VERIFY_NON_PROFIT", + "VERIFY_GOVERNMENT", + "LOW_SCORE" +] - changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brand_vetting_appeals_list52 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - added
Output schema / properties / result / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / examplePrevious value: -[ - { - "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" - } -]New value: +[ + { + "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:31", + "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" + } +] - added
Output schema / properties / result / items / descriptionAdded value: +"Represents an appeal against a 10DLC brand vetting result. An appeal asks the vetting provider to reconsider the assigned score." - changed
Output schema / properties / result / items / example / appeal_status_update_datePrevious value: -"2024-08-15T08:42:31Z"New value: +"2024-08-15T08:42:31" - added
Output schema / properties / result / items / properties / appeal_outcome / additionalPropertiesAdded value: +false - removed
Output schema / properties / result / items / properties / appeal_outcome / allOfRemoved value: -[ - { - "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" - } - } -] - added
Output schema / properties / result / items / properties / appeal_outcome / descriptionAdded value: +"Outcome of the appeal, including the revised vetting status and score." - added
Output schema / properties / result / items / properties / appeal_outcome / exampleAdded value: +{ + "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" +} - added
Output schema / properties / result / items / properties / appeal_outcome / propertiesAdded value: +{ + "feedback": { + "additionalProperties": false, + "description": "The feedback provided by the external vetting provider", + "example": { + "reasons": [ + "Company size as reported by government or business sources resulted in a score deduction: size range 6-10." + ] + }, + "properties": { + "reasons": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + } + }, + "required": [ + "reasons" + ], + "title": "TenDLCBrandVettingAppealOutcomeReason", + "type": "object" + }, + "vet_score": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "The Brand vetting score", + "example": 80, + "format": "int32" + }, + "vet_status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Current status of the Brand vetting", + "example": "ACTIVE" + } +} - added
Output schema / properties / result / items / properties / appeal_outcome / requiredAdded value: +[ + "vet_status", + "vet_score", + "feedback" +] - added
Output schema / properties / result / items / properties / appeal_outcome / titleAdded value: +"TenDLCBrandVettingAppealOutcome" - added
Output schema / properties / result / items / properties / appeal_outcome / typeAdded value: +"object" - added
Output schema / properties / result / items / properties / appeal_status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / appeal_status / descriptionPrevious value: -"The appeal status"New value: +"Current status of the appeal, such as `PENDING` or `COMPLETE`." - removed
Output schema / properties / result / items / properties / appeal_status / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / appeal_status_update_date / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / appeal_status_update_date / descriptionPrevious value: -"The date and time the appeal status was updated"New value: +"Timestamp when the appeal status was last updated, in ISO 8601 format." - changed
Output schema / properties / result / items / properties / appeal_status_update_date / examplePrevious value: -"2024-08-15T08:42:31Z"New value: +"2024-08-15T08:42:31" - removed
Output schema / properties / result / items / properties / appeal_status_update_date / formatRemoved value: -"date-time" - removed
Output schema / properties / result / items / properties / appeal_status_update_date / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / attachment_uuid_list / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / attachment_uuid_list / descriptionPrevious value: -"A list of evidence UUIDs associated with the appeal"New value: +"UUIDs of the evidence files submitted in support of the appeal." - added
Output schema / properties / result / items / properties / attachment_uuid_list / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / attachment_uuid_list / items / typeRemoved value: -"string" - removed
Output schema / properties / result / items / properties / attachment_uuid_list / typeRemoved value: -"array" - added
Output schema / properties / result / items / properties / brand_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / brand_id / descriptionPrevious value: -"The unique identifier of the Brand the appeal is associated with"New value: +"Unique identifier of the Brand the appeal is associated with." - removed
Output schema / properties / result / items / properties / brand_id / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / category_list / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / category_list / descriptionPrevious value: -"A list of appeal categories"New value: +"Categories that classify the appeal, such as `LOW_SCORE`." - added
Output schema / properties / result / items / properties / category_list / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / category_list / items / typeRemoved value: -"string" - removed
Output schema / properties / result / items / properties / category_list / typeRemoved value: -"array" - added
Output schema / properties / result / items / properties / create_date / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / create_date / descriptionPrevious value: -"Date and time the appeal was created"New value: +"Timestamp when the appeal was created, in ISO 8601 format." - removed
Output schema / properties / result / items / properties / create_date / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / evp_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / evp_id / descriptionPrevious value: -"External vetting provider code"New value: +"Code identifying the external vetting provider that handled the appeal." - removed
Output schema / properties / result / items / properties / evp_id / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / explanation / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / explanation / descriptionPrevious value: -"The appeal justification"New value: +"Justification provided for the appeal." - removed
Output schema / properties / result / items / properties / explanation / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / vetting_class / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / vetting_class / descriptionPrevious value: -"The vetting class"New value: +"Class of the vetting being appealed, such as `STANDARD` or `ENHANCED`." - removed
Output schema / properties / result / items / properties / vetting_class / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / vetting_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / vetting_id / descriptionPrevious value: -"The vetting unique identifier"New value: +"Unique identifier of the vetting request being appealed." - removed
Output schema / properties / result / items / properties / vetting_id / typeRemoved value: -"string" - changed
Output schema / properties / result / items / titlePrevious value: -"TenDlcBrandVettingAppeal"New value: +"TenDLCBrandVettingAppeal" - removed
Output schema / properties / result / typeRemoved value: -"array"
- Changed
ten_dlc_brand_vettings_create36 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / evp_id / descriptionPrevious value: -"External vetting provider code"New value: +"Code identifying the external vetting provider to perform the vetting." - changed
Input schema / properties / vetting_class / descriptionPrevious value: -"The vetting class"New value: +"Class of vetting to request, such as `STANDARD` or `ENHANCED`." - added
Output schema / descriptionAdded value: +"Represents the result of an external vetting performed on a 10DLC brand. Vetting can raise a Brand's trust score and unlock higher messaging throughput." - added
Output schema / properties / create_date / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / create_date / descriptionPrevious value: -"The date and time the vetting request is created"New value: +"Timestamp when the vetting request was created, in ISO 8601 format." - removed
Output schema / properties / create_date / typeRemoved value: -"string" - added
Output schema / properties / evp_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / evp_id / descriptionPrevious value: -"External vetting provider code"New value: +"Code identifying the external vetting provider that performed the vetting." - removed
Output schema / properties / evp_id / typeRemoved value: -"string" - added
Output schema / properties / reasons / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / reasons / descriptionPrevious value: -"Reason"New value: +"Reasons explaining the assigned `vetting_score`. Null when no reasons are provided." - added
Output schema / properties / reasons / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / reasons / items / typeRemoved value: -"string" - removed
Output schema / properties / reasons / typeRemoved value: -[ - "array", - "null" -] - added
Output schema / properties / vetted_date / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / vetted_date / descriptionPrevious value: -"The date and time the vetting request is competed"New value: +"Timestamp when the vetting was completed, in ISO 8601 format. Null while the vetting is still in progress." - removed
Output schema / properties / vetted_date / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / vetting_class / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / vetting_class / descriptionPrevious value: -"The vetting class"New value: +"Class of vetting performed, such as `STANDARD` or `ENHANCED`." - removed
Output schema / properties / vetting_class / typeRemoved value: -"string" - changed
Output schema / properties / vetting_details / descriptionPrevious value: -"Additional details of the vetting request"New value: +"Additional provider-specific details about the vetting request." - added
Output schema / properties / vetting_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / vetting_id / descriptionPrevious value: -"Unique identifier of the vetting request"New value: +"Unique identifier of the vetting request." - removed
Output schema / properties / vetting_id / typeRemoved value: -"string" - added
Output schema / properties / vetting_score / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / vetting_score / descriptionPrevious value: -"The assigned Brand vetting score"New value: +"Score assigned to the Brand by the vetting provider. Null until vetting completes." - removed
Output schema / properties / vetting_score / typeRemoved value: -[ - "integer", - "null" -] - added
Output schema / properties / vetting_status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / vetting_status / descriptionPrevious value: -"Status of the vetting request"New value: +"Current status of the vetting request, such as `PENDING` or `ACTIVE`." - removed
Output schema / properties / vetting_status / typeRemoved value: -"string" - added
Output schema / properties / vetting_token / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / vetting_token / descriptionPrevious value: -"Unique vetting token"New value: +"Token issued by the vetting provider that uniquely identifies this vetting result." - removed
Output schema / properties / vetting_token / typeRemoved value: -[ - "string", - "null" -] - changed
Output schema / titlePrevious value: -"TenDlcBrandVetting"New value: +"TenDLCBrandVetting"
- Changed
ten_dlc_brand_vettings_import21 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / evp_id / descriptionPrevious value: -"External vetting provider code"New value: +"Code identifying the external vetting provider that issued the vetting." - changed
Input schema / properties / vetting_id / descriptionPrevious value: -"Unique identifier of the vetting request"New value: +"Unique identifier of the vetting request to import." - changed
Input schema / properties / vetting_token / descriptionPrevious value: -"Unique vetting token"New value: +"Token issued by the vetting provider that uniquely identifies the vetting result to import." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"Represents the result of an external vetting performed on a 10DLC brand. Vetting can raise a Brand's trust score and unlock higher messaging throughput." - added
Output schema / properties / create_dateAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the vetting request was created, in ISO 8601 format.", + "example": "2024-08-01T14:09:43" +} - added
Output schema / properties / evp_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Code identifying the external vetting provider that performed the vetting.", + "example": "AEGIS" +} - added
Output schema / properties / reasonsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Reasons explaining the assigned `vetting_score`. Null when no reasons are provided.", + "example": [ + "Company size as reported by government or business sources resulted in a score deduction: size range 6-10" + ], + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] -} - added
Output schema / properties / vetted_dateAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the vetting was completed, in ISO 8601 format. Null while the vetting is still in progress.", + "example": "2024-08-01T14:09:43" +} - added
Output schema / properties / vetting_classAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Class of vetting performed, such as `STANDARD` or `ENHANCED`.", + "example": "STANDARD" +} - added
Output schema / properties / vetting_detailsAdded value: +{ + "additionalProperties": true, + "description": "Additional provider-specific details about the vetting request.", + "example": { + "additional_prop1": {}, + "additional_prop2": {}, + "additional_prop3": {} + }, + "type": "object" +} - added
Output schema / properties / vetting_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the vetting request.", + "example": "13d8e00c-3cb4-4dc0-9e26-d5057fa938d9" +} - added
Output schema / properties / vetting_scoreAdded value: +{ + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Score assigned to the Brand by the vetting provider. Null until vetting completes.", + "example": 80, + "format": "int32" +} - added
Output schema / properties / vetting_statusAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Current status of the vetting request, such as `PENDING` or `ACTIVE`.", + "example": "PENDING" +} - added
Output schema / properties / vetting_tokenAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Token issued by the vetting provider that uniquely identifies this vetting result.", + "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" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "evp_id", + "create_date", + "vetted_date", + "vetting_id", + "vetting_token", + "vetting_score", + "vetting_class", + "vetting_status", + "reasons" +] - added
Output schema / titleAdded value: +"TenDLCBrandVetting" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brand_vettings_list36 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - added
Output schema / properties / result / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / descriptionAdded value: +"Represents the result of an external vetting performed on a 10DLC brand. Vetting can raise a Brand's trust score and unlock higher messaging throughput." - added
Output schema / properties / result / items / properties / create_date / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / create_date / descriptionPrevious value: -"The date and time the vetting request is created"New value: +"Timestamp when the vetting request was created, in ISO 8601 format." - removed
Output schema / properties / result / items / properties / create_date / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / evp_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / evp_id / descriptionPrevious value: -"External vetting provider code"New value: +"Code identifying the external vetting provider that performed the vetting." - removed
Output schema / properties / result / items / properties / evp_id / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / reasons / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / reasons / descriptionPrevious value: -"Reason"New value: +"Reasons explaining the assigned `vetting_score`. Null when no reasons are provided." - added
Output schema / properties / result / items / properties / reasons / items / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / reasons / items / typeRemoved value: -"string" - removed
Output schema / properties / result / items / properties / reasons / typeRemoved value: -[ - "array", - "null" -] - added
Output schema / properties / result / items / properties / vetted_date / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / vetted_date / descriptionPrevious value: -"The date and time the vetting request is competed"New value: +"Timestamp when the vetting was completed, in ISO 8601 format. Null while the vetting is still in progress." - removed
Output schema / properties / result / items / properties / vetted_date / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / result / items / properties / vetting_class / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / vetting_class / descriptionPrevious value: -"The vetting class"New value: +"Class of vetting performed, such as `STANDARD` or `ENHANCED`." - removed
Output schema / properties / result / items / properties / vetting_class / typeRemoved value: -"string" - changed
Output schema / properties / result / items / properties / vetting_details / descriptionPrevious value: -"Additional details of the vetting request"New value: +"Additional provider-specific details about the vetting request." - added
Output schema / properties / result / items / properties / vetting_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / vetting_id / descriptionPrevious value: -"Unique identifier of the vetting request"New value: +"Unique identifier of the vetting request." - removed
Output schema / properties / result / items / properties / vetting_id / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / vetting_score / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / vetting_score / descriptionPrevious value: -"The assigned Brand vetting score"New value: +"Score assigned to the Brand by the vetting provider. Null until vetting completes." - removed
Output schema / properties / result / items / properties / vetting_score / typeRemoved value: -[ - "integer", - "null" -] - added
Output schema / properties / result / items / properties / vetting_status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / vetting_status / descriptionPrevious value: -"Status of the vetting request"New value: +"Current status of the vetting request, such as `PENDING` or `ACTIVE`." - removed
Output schema / properties / result / items / properties / vetting_status / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / vetting_token / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / vetting_token / descriptionPrevious value: -"Unique vetting token"New value: +"Token issued by the vetting provider that uniquely identifies this vetting result." - removed
Output schema / properties / result / items / properties / vetting_token / typeRemoved value: -[ - "string", - "null" -] - changed
Output schema / properties / result / items / titlePrevious value: -"TenDlcBrandVetting"New value: +"TenDLCBrandVetting" - removed
Output schema / properties / result / typeRemoved value: -"array"
- Changed
ten_dlc_brands_create41 fields changed- changed
Input schema / properties / entity_type / descriptionPrevious value: -"The company entity type"New value: +"Legal entity type of the company. One of `PRIVATE_PROFIT` (privately held for-profit company), `PUBLIC_PROFIT` (publicly traded for-profit company), `NON_PROFIT` (non-profit organization), or `GOVERNMENT` (government entity)." - changed
Input schema / properties / mock / descriptionPrevious value: -"Indicates a mock Brand. You can create mock Brands for testing purposes only, production traffic with the mock Brands is prohibited."New value: +"Indicates a mock Brand. Mock Brands are for testing purposes only; production traffic with mock Brands is prohibited." - added
Input schema / properties / state_or_province / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Input schema / properties / state_or_province / typeRemoved value: -[ - "string", - "null" -] - added
Input schema / properties / stock_exchange / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Input schema / properties / stock_exchange / typeRemoved value: -[ - "string", - "null" -] - added
Input schema / properties / stock_symbol / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Input schema / properties / stock_symbol / typeRemoved value: -[ - "string", - "null" -] - changed
Input schema / properties / vertical / descriptionPrevious value: -"The segment the business operates in"New value: +"Business segment the Brand operates in. One of:\n\n- `HEALTHCARE` — healthcare.\n- `PROFESSIONAL` — professional services.\n- `RETAIL` — retail.\n- `TECHNOLOGY` — technology.\n- `EDUCATION` — education.\n- `FINANCIAL` — financial services.\n- `NON_PROFIT` — non-profit organizations.\n- `GOVERNMENT` — government entities.\n- `OTHER` — any segment not listed above." - changed
Input schema / requiredPrevious value: -[ - "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" -]New value: +[ + "dba_name", + "company_name", + "entity_type", + "vertical", + "ein_taxid", + "ein_taxid_country", + "first_name", + "last_name", + "phone_number", + "email", + "street_address", + "city", + "country", + "zip" +] - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"Represents a 10DLC brand registered for application-to-person messaging. A Brand identifies the business behind one or more messaging campaigns." - added
Output schema / exampleAdded value: +{ + "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": "support@brand.com", + "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" +} - added
Output schema / properties / brand_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Brand assigned by the registry.", + "example": "BM20QP9" +} - added
Output schema / properties / cityAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "City of the business address.", + "example": "Miami" +} - added
Output schema / properties / company_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registered legal name of the company that owns the Brand.", + "example": "Company" +} - added
Output schema / properties / countryAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ISO 3166-1 alpha-2 country code of the business address.", + "example": "US" +} - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Brand was created, in ISO 8601 format.", + "example": "2024-07-24T08:29:09" +} - added
Output schema / properties / dba_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Doing-business-as name, or the public-facing brand name.", + "example": "Brand" +} - added
Output schema / properties / ein_taxidAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "IRS Employer Identification Number (EIN) or other tax ID of the company.", + "example": "999999999" +} - added
Output schema / properties / ein_taxid_countryAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ISO 3166-1 alpha-2 country code where the Tax ID was issued.", + "example": "US" +} - added
Output schema / properties / emailAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Support contact email address.", + "example": "support@brand.com" +} - added
Output schema / properties / entity_typeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Legal entity type of the 10DLC Brand. One of `PRIVATE_PROFIT` (privately held for-profit company), `PUBLIC_PROFIT` (publicly traded for-profit company), `NON_PROFIT` (non-profit organization), or `GOVERNMENT` (government entity).", + "enum": [ + "PRIVATE_PROFIT", + "PUBLIC_PROFIT", + "NON_PROFIT", + "GOVERNMENT", + null + ], + "example": "PRIVATE_PROFIT", + "title": "TenDLCBrandEntityType" +} - added
Output schema / properties / feedbackAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Feedback from the identity verification process explaining the current `status`." +} - added
Output schema / properties / first_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business contact first name.", + "example": "John" +} - added
Output schema / properties / last_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business contact last name.", + "example": "Dow" +} - added
Output schema / properties / mockAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates whether the Brand is a mock brand for testing.", + "example": false +} - added
Output schema / properties / phone_numberAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Support contact phone number in E.164 format.", + "example": "12123450099" +} - removed
Output schema / properties / resultRemoved value: -{ - "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": "support@brand.com", - "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": "support@brand.com", - "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": "support@brand.com", - "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" - } - } - ] -} - added
Output schema / properties / state_or_provinceAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "State or province of the business address.", + "example": "FL" +} - added
Output schema / properties / statusAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Identity verification status of the 10DLC Brand. One of:\n\n- `REVIEW` — verification is in progress.\n- `VERIFIED` — the Brand passed standard verification.\n- `UNVERIFIED` — verification has not succeeded.\n- `VETTED_VERIFIED` — the Brand also passed third-party vetting.\n- `SUSPENDED` — the Brand is blocked from sending.", + "enum": [ + "REVIEW", + "VERIFIED", + "UNVERIFIED", + "VETTED_VERIFIED", + "SUSPENDED", + null + ], + "example": "VERIFIED", + "title": "TenDLCBrandIdentityVerificationStatus" +} - added
Output schema / properties / stock_exchangeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Code of the stock exchange the company is listed on. Required for publicly traded companies." +} - added
Output schema / properties / stock_symbolAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Stock ticker symbol of the company. Required for publicly traded companies." +} - added
Output schema / properties / street_addressAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Street address of the business.", + "example": "10, City Name" +} - added
Output schema / properties / updated_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Brand was last updated, in ISO 8601 format.", + "example": "2024-07-24T08:29:09" +} - added
Output schema / properties / verticalAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Industry vertical the Brand operates in.", + "example": "HEALTHCARE" +} - added
Output schema / properties / websiteAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business website URL.", + "example": "https://brand.com" +} - added
Output schema / properties / zipAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ZIP or postal code of the business address.", + "example": "12345" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "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" +] - added
Output schema / titleAdded value: +"TenDLCBrand" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brands_delete7 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brands_get33 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"Represents a 10DLC brand registered for application-to-person messaging. A Brand identifies the business behind one or more messaging campaigns." - added
Output schema / exampleAdded value: +{ + "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": "support@brand.com", + "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" +} - added
Output schema / properties / brand_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Brand assigned by the registry.", + "example": "BM20QP9" +} - added
Output schema / properties / cityAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "City of the business address.", + "example": "Miami" +} - added
Output schema / properties / company_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registered legal name of the company that owns the Brand.", + "example": "Company" +} - added
Output schema / properties / countryAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ISO 3166-1 alpha-2 country code of the business address.", + "example": "US" +} - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Brand was created, in ISO 8601 format.", + "example": "2024-07-24T08:29:09" +} - added
Output schema / properties / dba_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Doing-business-as name, or the public-facing brand name.", + "example": "Brand" +} - added
Output schema / properties / ein_taxidAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "IRS Employer Identification Number (EIN) or other tax ID of the company.", + "example": "999999999" +} - added
Output schema / properties / ein_taxid_countryAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ISO 3166-1 alpha-2 country code where the Tax ID was issued.", + "example": "US" +} - added
Output schema / properties / emailAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Support contact email address.", + "example": "support@brand.com" +} - added
Output schema / properties / entity_typeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Legal entity type of the 10DLC Brand. One of `PRIVATE_PROFIT` (privately held for-profit company), `PUBLIC_PROFIT` (publicly traded for-profit company), `NON_PROFIT` (non-profit organization), or `GOVERNMENT` (government entity).", + "enum": [ + "PRIVATE_PROFIT", + "PUBLIC_PROFIT", + "NON_PROFIT", + "GOVERNMENT", + null + ], + "example": "PRIVATE_PROFIT", + "title": "TenDLCBrandEntityType" +} - added
Output schema / properties / feedbackAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Feedback from the identity verification process explaining the current `status`." +} - added
Output schema / properties / first_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business contact first name.", + "example": "John" +} - added
Output schema / properties / last_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business contact last name.", + "example": "Dow" +} - added
Output schema / properties / mockAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates whether the Brand is a mock brand for testing.", + "example": false +} - added
Output schema / properties / phone_numberAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Support contact phone number in E.164 format.", + "example": "12123450099" +} - removed
Output schema / properties / resultRemoved value: -{ - "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": "support@brand.com", - "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": "support@brand.com", - "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": "support@brand.com", - "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" - } - } - ] -} - added
Output schema / properties / state_or_provinceAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "State or province of the business address.", + "example": "FL" +} - added
Output schema / properties / statusAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Identity verification status of the 10DLC Brand. One of:\n\n- `REVIEW` — verification is in progress.\n- `VERIFIED` — the Brand passed standard verification.\n- `UNVERIFIED` — verification has not succeeded.\n- `VETTED_VERIFIED` — the Brand also passed third-party vetting.\n- `SUSPENDED` — the Brand is blocked from sending.", + "enum": [ + "REVIEW", + "VERIFIED", + "UNVERIFIED", + "VETTED_VERIFIED", + "SUSPENDED", + null + ], + "example": "VERIFIED", + "title": "TenDLCBrandIdentityVerificationStatus" +} - added
Output schema / properties / stock_exchangeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Code of the stock exchange the company is listed on. Required for publicly traded companies." +} - added
Output schema / properties / stock_symbolAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Stock ticker symbol of the company. Required for publicly traded companies." +} - added
Output schema / properties / street_addressAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Street address of the business.", + "example": "10, City Name" +} - added
Output schema / properties / updated_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Brand was last updated, in ISO 8601 format.", + "example": "2024-07-24T08:29:09" +} - added
Output schema / properties / verticalAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Industry vertical the Brand operates in.", + "example": "HEALTHCARE" +} - added
Output schema / properties / websiteAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business website URL.", + "example": "https://brand.com" +} - added
Output schema / properties / zipAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ZIP or postal code of the business address.", + "example": "12345" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "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" +] - added
Output schema / titleAdded value: +"TenDLCBrand" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brands_list21 fields changed- changed
Input schema / properties / company_name / descriptionPrevious value: -"Company legal name."New value: +"Filters Brands by `company_name` (registered legal name). Matches partial values." - changed
Input schema / properties / country / descriptionPrevious value: -"Brand registration country."New value: +"Filters Brands by registration country, as an ISO 3166-1 alpha-2 code (e.g., `US`)." - changed
Input schema / properties / created_after / descriptionPrevious value: -"Brand creation start date in `YYYY-MM-DD` format."New value: +"Returns brands created on or after this date, in `YYYY-MM-DD` format." - changed
Input schema / properties / created_before / descriptionPrevious value: -"Brand creation end date in `YYYY-MM-DD` format."New value: +"Returns brands created on or before this date, in `YYYY-MM-DD` format." - changed
Input schema / properties / dba_name / descriptionPrevious value: -"Brand name."New value: +"Filters Brands by `dba_name` (doing-business-as name). Matches partial values." - changed
Input schema / properties / ein_taxid / descriptionPrevious value: -"EIN/Tax ID."New value: +"Filters Brands by their Employer Identification Number (EIN) or tax ID." - changed
Input schema / properties / entity_type / descriptionPrevious value: -"Business entity type."New value: +"Filters Brands by business entity type, such as `PRIVATE_PROFIT`." - changed
Input schema / properties / mock / descriptionPrevious value: -"Indicates whether to include mock brands only."New value: +"When `true`, returns only mock Brands used for testing. Default `false`." - changed
Input schema / properties / page / descriptionPrevious value: -"Page number."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / show_deleted / descriptionPrevious value: -"Indicates whether to include deleted brands."New value: +"When `true`, includes deleted Brands in the results. Default `false`." - changed
Input schema / properties / status / descriptionPrevious value: -"Brand identity verification status."New value: +"Filters Brands by identity verification status, such as `VERIFIED`." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"A list of 10DLC Brands" - added
Output schema / exampleAdded value: +{ + "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": "support@brand.com", + "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 + } +} - added
Output schema / properties / itemsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "A paginated list of 10DLC Brands matching the filter criteria", + "items": { + "additionalProperties": false, + "description": "Represents a 10DLC brand registered for application-to-person messaging. A Brand identifies the business behind one or more messaging campaigns.", + "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": "support@brand.com", + "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": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Brand assigned by the registry.", + "example": "BM20QP9" + }, + "city": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "City of the business address.", + "example": "Miami" + }, + "company_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registered legal name of the company that owns the Brand.", + "example": "Company" + }, + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ISO 3166-1 alpha-2 country code of the business address.", + "example": "US" + }, + "created_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Brand was created, in ISO 8601 format.", + "example": "2024-07-24T08:29:09" + }, + "dba_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Doing-business-as name, or the public-facing brand name.", + "example": "Brand" + }, + "ein_taxid": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "IRS Employer Identification Number (EIN) or other tax ID of the company.", + "example": "999999999" + }, + "ein_taxid_country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ISO 3166-1 alpha-2 country code where the Tax ID was issued.", + "example": "US" + }, + "email": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Support contact email address.", + "example": "support@brand.com" + }, + "entity_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Legal entity type of the 10DLC Brand. One of `PRIVATE_PROFIT` (privately held for-profit company), `PUBLIC_PROFIT` (publicly traded for-profit company), `NON_PROFIT` (non-profit organization), or `GOVERNMENT` (government entity).", + "enum": [ + "PRIVATE_PROFIT", + "PUBLIC_PROFIT", + "NON_PROFIT", + "GOVERNMENT", + null + ], + "example": "PRIVATE_PROFIT", + "title": "TenDLCBrandEntityType" + }, + "feedback": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Feedback from the identity verification process explaining the current `status`." + }, + "first_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business contact first name.", + "example": "John" + }, + "last_name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business contact last name.", + "example": "Dow" + }, + "mock": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates whether the Brand is a mock brand for testing.", + "example": false + }, + "phone_number": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Support contact phone number in E.164 format.", + "example": "12123450099" + }, + "state_or_province": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "State or province of the business address.", + "example": "FL" + }, + "status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Identity verification status of the 10DLC Brand. One of:\n\n- `REVIEW` — verification is in progress.\n- `VERIFIED` — the Brand passed standard verification.\n- `UNVERIFIED` — verification has not succeeded.\n- `VETTED_VERIFIED` — the Brand also passed third-party vetting.\n- `SUSPENDED` — the Brand is blocked from sending.", + "enum": [ + "REVIEW", + "VERIFIED", + "UNVERIFIED", + "VETTED_VERIFIED", + "SUSPENDED", + null + ], + "example": "VERIFIED", + "title": "TenDLCBrandIdentityVerificationStatus" + }, + "stock_exchange": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Code of the stock exchange the company is listed on. Required for publicly traded companies." + }, + "stock_symbol": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Stock ticker symbol of the company. Required for publicly traded companies." + }, + "street_address": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Street address of the business.", + "example": "10, City Name" + }, + "updated_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Brand was last updated, in ISO 8601 format.", + "example": "2024-07-24T08:29:09" + }, + "vertical": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Industry vertical the Brand operates in.", + "example": "HEALTHCARE" + }, + "website": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business website URL.", + "example": "https://brand.com" + }, + "zip": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ZIP or postal code of the business address.", + "example": "12345" + } + }, + "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" + } +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "description": "Pagination details", + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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": "support@brand.com", - "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": "support@brand.com", - "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": "support@brand.com", - "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": "support@brand.com", - "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 - } - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "items", + "pagination" +] - added
Output schema / titleAdded value: +"TenDLCBrandListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_brands_update41 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / entity_type / descriptionPrevious value: -"The company entity type"New value: +"Legal entity type of the company. One of `PRIVATE_PROFIT` (privately held for-profit company), `PUBLIC_PROFIT` (publicly traded for-profit company), `NON_PROFIT` (non-profit organization), or `GOVERNMENT` (government entity)." - added
Input schema / properties / state_or_province / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Input schema / properties / state_or_province / typeRemoved value: -[ - "string", - "null" -] - added
Input schema / properties / stock_exchange / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Input schema / properties / stock_exchange / typeRemoved value: -[ - "string", - "null" -] - added
Input schema / properties / stock_symbol / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Input schema / properties / stock_symbol / typeRemoved value: -[ - "string", - "null" -] - changed
Input schema / properties / vertical / descriptionPrevious value: -"The segment the business operates in"New value: +"Business segment the Brand operates in. One of:\n\n- `HEALTHCARE` — healthcare.\n- `PROFESSIONAL` — professional services.\n- `RETAIL` — retail.\n- `TECHNOLOGY` — technology.\n- `EDUCATION` — education.\n- `FINANCIAL` — financial services.\n- `NON_PROFIT` — non-profit organizations.\n- `GOVERNMENT` — government entities.\n- `OTHER` — any segment not listed above." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"Represents a 10DLC brand registered for application-to-person messaging. A Brand identifies the business behind one or more messaging campaigns." - added
Output schema / exampleAdded value: +{ + "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": "support@brand.com", + "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" +} - added
Output schema / properties / brand_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Brand assigned by the registry.", + "example": "BM20QP9" +} - added
Output schema / properties / cityAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "City of the business address.", + "example": "Miami" +} - added
Output schema / properties / company_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registered legal name of the company that owns the Brand.", + "example": "Company" +} - added
Output schema / properties / countryAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ISO 3166-1 alpha-2 country code of the business address.", + "example": "US" +} - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Brand was created, in ISO 8601 format.", + "example": "2024-07-24T08:29:09" +} - added
Output schema / properties / dba_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Doing-business-as name, or the public-facing brand name.", + "example": "Brand" +} - added
Output schema / properties / ein_taxidAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "IRS Employer Identification Number (EIN) or other tax ID of the company.", + "example": "999999999" +} - added
Output schema / properties / ein_taxid_countryAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ISO 3166-1 alpha-2 country code where the Tax ID was issued.", + "example": "US" +} - added
Output schema / properties / emailAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Support contact email address.", + "example": "support@brand.com" +} - added
Output schema / properties / entity_typeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Legal entity type of the 10DLC Brand. One of `PRIVATE_PROFIT` (privately held for-profit company), `PUBLIC_PROFIT` (publicly traded for-profit company), `NON_PROFIT` (non-profit organization), or `GOVERNMENT` (government entity).", + "enum": [ + "PRIVATE_PROFIT", + "PUBLIC_PROFIT", + "NON_PROFIT", + "GOVERNMENT", + null + ], + "example": "PRIVATE_PROFIT", + "title": "TenDLCBrandEntityType" +} - added
Output schema / properties / feedbackAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Feedback from the identity verification process explaining the current `status`." +} - added
Output schema / properties / first_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business contact first name.", + "example": "John" +} - added
Output schema / properties / last_nameAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business contact last name.", + "example": "Dow" +} - added
Output schema / properties / mockAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "default": false, + "description": "Indicates whether the Brand is a mock brand for testing.", + "example": false +} - added
Output schema / properties / phone_numberAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Support contact phone number in E.164 format.", + "example": "12123450099" +} - removed
Output schema / properties / resultRemoved value: -{ - "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": "support@brand.com", - "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": "support@brand.com", - "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": "support@brand.com", - "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" - } - } - ] -} - added
Output schema / properties / state_or_provinceAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "State or province of the business address.", + "example": "FL" +} - added
Output schema / properties / statusAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Identity verification status of the 10DLC Brand. One of:\n\n- `REVIEW` — verification is in progress.\n- `VERIFIED` — the Brand passed standard verification.\n- `UNVERIFIED` — verification has not succeeded.\n- `VETTED_VERIFIED` — the Brand also passed third-party vetting.\n- `SUSPENDED` — the Brand is blocked from sending.", + "enum": [ + "REVIEW", + "VERIFIED", + "UNVERIFIED", + "VETTED_VERIFIED", + "SUSPENDED", + null + ], + "example": "VERIFIED", + "title": "TenDLCBrandIdentityVerificationStatus" +} - added
Output schema / properties / stock_exchangeAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Code of the stock exchange the company is listed on. Required for publicly traded companies." +} - added
Output schema / properties / stock_symbolAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Stock ticker symbol of the company. Required for publicly traded companies." +} - added
Output schema / properties / street_addressAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Street address of the business.", + "example": "10, City Name" +} - added
Output schema / properties / updated_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Brand was last updated, in ISO 8601 format.", + "example": "2024-07-24T08:29:09" +} - added
Output schema / properties / verticalAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Industry vertical the Brand operates in.", + "example": "HEALTHCARE" +} - added
Output schema / properties / websiteAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Business website URL.", + "example": "https://brand.com" +} - added
Output schema / properties / zipAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "ZIP or postal code of the business address.", + "example": "12345" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "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" +] - added
Output schema / titleAdded value: +"TenDLCBrand" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_campaign_numbers_link9 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / campaign_id / descriptionPrevious value: -"Campaign ID."New value: +"The unique ID of the 10DLC Campaign." - changed
Input schema / properties / number / descriptionPrevious value: -"Phone number to associate with the Campaign."New value: +"The phone number to link to the Campaign, in E.164 format." - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_campaign_numbers_list11 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / campaign_id / descriptionPrevious value: -"Campaign ID."New value: +"The unique ID of the 10DLC Campaign." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / brand_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the 10DLC Brand that owns the Campaign." +} - added
Output schema / properties / campaign_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the 10DLC Campaign the numbers belong to." +} - added
Output schema / properties / numbersAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Phone numbers assigned to the Campaign, with their provisioning status.", + "items": { + "additionalProperties": false, + "properties": { + "number": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Phone number assigned to the 10DLC Campaign, in E.164 format.", + "example": "17029641104" + }, + "status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Provisioning status of the phone number, such as `APPROVED`. Only `APPROVED` numbers can be used as Sender IDs.", + "example": "APPROVED" + } + }, + "required": [ + "number", + "status" + ], + "title": "TenDLCCampaignNumber", + "type": "object" + } +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - ] - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "brand_id", + "campaign_id", + "numbers" +] - added
Output schema / titleAdded value: +"TenDLCCampaignNumberListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_campaign_numbers_unlink9 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / campaign_id / descriptionPrevious value: -"Campaign ID."New value: +"The unique ID of the 10DLC Campaign." - changed
Input schema / properties / number / descriptionPrevious value: -"Phone number to unlink."New value: +"The phone number to unlink from the Campaign, in E.164 format." - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_campaigns_list17 fields changed- changed
Input schema / properties / created_after / descriptionPrevious value: -"Campaign creation start date in `YYYY-MM-DD` format."New value: +"Returns Campaigns created on or after this date, in `YYYY-MM-DD` format." - changed
Input schema / properties / created_before / descriptionPrevious value: -"Campaign creation end date in `YYYY-MM-DD` format."New value: +"Returns Campaigns created on or before this date, in `YYYY-MM-DD` format." - changed
Input schema / properties / mock / descriptionPrevious value: -"Indicates whether to include mock 10DLC Campaigns only."New value: +"When `true`, returns only mock Campaigns used for testing. Default `false`." - changed
Input schema / properties / name / descriptionPrevious value: -"Campaign name."New value: +"Filters Campaigns by name. Matches partial values." - changed
Input schema / properties / page / descriptionPrevious value: -"Page number to retrieve."New value: +"Page number to retrieve. Default `1`." - changed
Input schema / properties / per_page / descriptionPrevious value: -"Number of records per page."New value: +"Number of records to return per page. Default `25`." - changed
Input schema / properties / status / descriptionPrevious value: -"Campaign status."New value: +"Filters Campaigns by status." - changed
Input schema / properties / usecase / descriptionPrevious value: -"Use case."New value: +"Filters Campaigns by use case." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"Paginated list of 10DLC Campaigns." - added
Output schema / exampleAdded value: +{ + "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 + } +} - added
Output schema / properties / itemsAdded value: +{ + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "10DLC Campaigns on the current page that match the filter criteria.", + "items": { + "additionalProperties": false, + "description": "Represents a 10DLC campaign registered under a Brand. A Campaign defines the messaging use case, opt-in and opt-out flows, and the phone numbers permitted to send its traffic.", + "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": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign is used for affiliate marketing.", + "example": false + }, + "age_gated": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain age-gated content.", + "example": false + }, + "auto_renewal": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign should be automatically renewed.", + "example": true + }, + "brand_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Brand that owns the Campaign.", + "example": "BM20QP9" + }, + "campaign_id": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Campaign assigned by the registry.", + "example": "CKLCK95" + }, + "created_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Campaign was created, in ISO 8601 format.", + "example": "2024-08-14T11:57:41" + }, + "description": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Description of the Campaign and its messaging purpose.", + "example": "Our campaign aims to …" + }, + "direct_lending": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain direct lending content.", + "example": true + }, + "embedded_link_sample": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample of an embedded link used in Campaign messages." + }, + "embedded_links": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain embedded links.", + "example": true + }, + "embedded_phones": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign messages contain embedded phone numbers.", + "example": true + }, + "feedback": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Feedback from the registry explaining the current `status`." + }, + "help": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the campaign includes a help system (for example, keyword: HELP, INFO).", + "example": true + }, + "help_keywords": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of help keywords. Keywords are case-insensitive.", + "example": "help" + }, + "help_message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Help message sent upon receiving a help keyword.", + "example": "For help, please visit www.site.com. To opt out, reply STOP." + }, + "last_bill_date": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "mock": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign is a mock campaign used for testing. Mock campaigns cannot send production traffic.", + "example": false + }, + "monthly_fee": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Recurring monthly fee charged for the Campaign, as a decimal string.", + "example": "10.0" + }, + "name": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Display name of the Campaign.", + "example": "My first campaign" + }, + "next_bill_date": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "optin": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the Campaign requires subscriber opt-in.", + "example": true + }, + "optin_keywords": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of opt-in keywords. Keywords are case-insensitive.", + "example": "begin,start" + }, + "optin_message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" + }, + "optin_workflow": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Description of the workflow through which subscribers opt in to the Campaign.", + "example": "Our SMS ..." + }, + "optout": { + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the campaign includes an opt-out system (for example, keyword: STOP, QUIT).", + "example": true + }, + "optout_keywords": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Comma-separated list of opt-out keywords. Keywords are case-insensitive.", + "example": "stop,quit,unsubscribe" + }, + "optout_message": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Opt-out message sent upon receiving an opt-out keyword.", + "example": "You are now opted out and will receive no further messages" + }, + "phone_numbers": { + "anyOf": [ + { + "type": "array" + }, + { + "type": "null" + } + ], + "description": "Phone numbers assigned to the Campaign, in E.164 format.", + "example": [ + "14358684439", + "13193337776", + "12673296046" + ], + "items": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ] + } + }, + "privacy_policy": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Privacy policy URL.", + "example": "https://site.com/privacy-policy" + }, + "sample1": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign.", + "example": "Your verification code is XXXXXX" + }, + "sample2": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." + }, + "sample3": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." + }, + "sample4": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." + }, + "sample5": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Sample message demonstrating the content sent through the Campaign." + }, + "status": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Current registration status of the Campaign, such as `APPROVED` or `PENDING`.", + "example": "APPROVED" + }, + "terms_conditions": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Terms and conditions URL.", + "example": "https://site.com/terms-and-conditions" + }, + "updated_at": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Timestamp when the Campaign was last updated, in ISO 8601 format.", + "example": "2024-08-14T11:57:47" + }, + "usecase": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Registered use case for the Campaign, such as `2FA` or `MARKETING`.", + "example": "2FA" + } + }, + "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" + } +} - added
Output schema / properties / paginationAdded value: +{ + "additionalProperties": false, + "description": "Pagination metadata for the result set.", + "properties": { + "current_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Current page number.", + "example": 2, + "format": "int32" + }, + "per_page": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Number of records per page.", + "example": 25, + "format": "int32" + }, + "total": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of records.", + "example": 101, + "format": "int32" + }, + "total_pages": { + "anyOf": [ + { + "type": "integer" + }, + { + "type": "null" + } + ], + "description": "Total number of pages.", + "example": 5, + "format": "int32" + } + }, + "required": [ + "current_page", + "per_page", + "total", + "total_pages" + ], + "title": "Pagination", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "items", + "pagination" +] - added
Output schema / titleAdded value: +"TenDLCCampaignListResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_campaigns_nudge8 fields changed- changed
Input schema / properties / brand_id / descriptionPrevious value: -"Brand ID."New value: +"The unique ID of the 10DLC Brand." - added
Input schema / properties / brand_id / patternAdded value: +"^B[A-Z0-9]{6}$" - changed
Input schema / properties / campaign_id / descriptionPrevious value: -"Campaign ID."New value: +"The unique ID of the 10DLC Campaign." - removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_subscriptions_create15 fields changed- added
Input schema / properties / subscription_category / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / subscription_category / descriptionPrevious value: -"The Wavix 10DLC event type. Can be one of the following: `brand`, `campaign`, or `number`."New value: +"Category of 10DLC events to subscribe to. One of `brand` (brand status changes), `campaign` (campaign status changes), or `number` (number provisioning changes)." - removed
Input schema / properties / subscription_category / typeRemoved value: -"string" - added
Input schema / properties / url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Input schema / properties / url / descriptionPrevious value: -"A webhook URL to send events to"New value: +"Webhook URL that events in this category are delivered to." - removed
Input schema / properties / url / typeRemoved value: -"string" - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / descriptionAdded value: +"Represents a subscription that delivers 10DLC lifecycle events to a webhook URL." - added
Output schema / exampleAdded value: +{ + "subscription_category": "brand", + "url": "https://webhook.url" +} - removed
Output schema / properties / resultRemoved value: -{ - "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" - } - } - ] -} - added
Output schema / properties / subscription_categoryAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Category of 10DLC events to subscribe to. One of `brand` (brand status changes), `campaign` (campaign status changes), or `number` (number provisioning changes).", + "example": "brand" +} - added
Output schema / properties / urlAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Webhook URL that events in this category are delivered to.", + "example": "https://webhook.url" +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "subscription_category", + "url" +] - added
Output schema / titleAdded value: +"TenDLCEventSubscription" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_subscriptions_delete5 fields changed- removed
Output schema / properties / resultRemoved value: -{ - "allOf": [ - { - "properties": { - "success": { - "example": true, - "type": "boolean" - } - }, - "required": [ - "success" - ], - "title": "SuccessResponse", - "type": "object" - }, - { - "example": { - "success": true - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the request was successful.", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
ten_dlc_subscriptions_list10 fields changed- added
Output schema / properties / result / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / descriptionPrevious value: -"10DLC event subscription configuration."New value: +"Represents a subscription that delivers 10DLC lifecycle events to a webhook URL." - added
Output schema / properties / result / items / properties / subscription_category / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / subscription_category / descriptionPrevious value: -"The Wavix 10DLC event type. Can be one of the following: `brand`, `campaign`, or `number`."New value: +"Category of 10DLC events to subscribe to. One of `brand` (brand status changes), `campaign` (campaign status changes), or `number` (number provisioning changes)." - removed
Output schema / properties / result / items / properties / subscription_category / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / url / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / url / descriptionPrevious value: -"A webhook URL to send events to"New value: +"Webhook URL that events in this category are delivered to." - removed
Output schema / properties / result / items / properties / url / typeRemoved value: -"string" - changed
Output schema / properties / result / items / titlePrevious value: -"TenDlcEventSubscription"New value: +"TenDLCEventSubscription" - removed
Output schema / properties / result / typeRemoved value: -"array"
- Changed
two_fa_events_list14 fields changed- changed
Input schema / properties / session_id / descriptionPrevious value: -"2FA Verification ID."New value: +"The unique ID of the 2FA verification session." - added
Output schema / properties / result / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / charge / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / charge / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / created_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / created_at / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / error / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / error / typeRemoved value: -[ - "string", - "null" -] - added
Output schema / properties / result / items / properties / event / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / result / items / properties / event / descriptionPrevious value: -"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"New value: +"Human-readable event description. One of the following values:\n- `Number lookup` — the Wavix platform checked whether the destination phone number is valid. Returned only when number validation is enabled for the 2FA Service.\n- `Code sent via SMS` — a code was sent via SMS.\n- `Code sent via voice` — a code was sent via a voice call.\n- `Verification` — a code verification attempt." - removed
Output schema / properties / result / items / properties / event / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / status / typeRemoved value: -"string" - removed
Output schema / properties / result / typeRemoved value: -"array"
- Changed
two_fa_sessions_list21 fields changed- changed
Input schema / properties / from / descriptionPrevious value: -"Start date in `YYYY-MM-DD` format."New value: +"Start of the date range to query, in `YYYY-MM-DD` format. Inclusive." - changed
Input schema / properties / service_id / descriptionPrevious value: -"2FA Service ID."New value: +"The unique ID of the 2FA service." - changed
Input schema / properties / to / descriptionPrevious value: -"End date in `YYYY-MM-DD` format."New value: +"End of the date range to query, in `YYYY-MM-DD` format. Inclusive." - added
Output schema / properties / result / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / result / items / properties / charge / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / charge / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / created_at / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / created_at / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / destination_country / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / destination_country / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / phone_number / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / phone_number / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / service_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / service_id / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / service_name / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / service_name / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / session_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / session_id / typeRemoved value: -"string" - added
Output schema / properties / result / items / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - removed
Output schema / properties / result / items / properties / status / typeRemoved value: -"string" - removed
Output schema / properties / result / typeRemoved value: -"array"
- Changed
two_fa_verification_cancel6 fields changed- changed
Input schema / properties / session_id / descriptionPrevious value: -"2FA Verification ID."New value: +"The unique ID of the 2FA verification session." - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - added
Output schema / properties / success / descriptionAdded value: +"Indicates whether the request was successful." - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
two_fa_verification_check7 fields changed- changed
Input schema / properties / session_id / descriptionPrevious value: -"2FA Verification ID."New value: +"The unique ID of the 2FA verification session." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / is_validAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the entered code is valid", + "example": true +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - } - ] -} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "is_valid" +] - added
Output schema / titleAdded value: +"TwoFactorVerificationCheckResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
two_fa_verification_create14 fields changed- changed
Input schema / properties / channel / descriptionPrevious value: -"The communication channel you want to use. Can be either `sms` or `voice`."New value: +"Channel used to deliver the verification code. One of `sms` (sent as a text message) or `voice` (read aloud over a phone call)." - changed
Input schema / properties / service_id / descriptionPrevious value: -"Unique Wavix 2FA Service ID. Find your 2FA Service ID on the Wavix portal."New value: +"Unique Wavix 2FA Service ID. Available on the Wavix portal." - added
Output schema / additionalPropertiesAdded value: +false - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time the 2FA Verification is created", + "example": "2022-02-16T13:41:38.000Z", + "format": "date-time" +} - added
Output schema / properties / destinationAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The end user's phone number.", + "example": "447919433768" +} - added
Output schema / properties / number_lookupAdded value: +{ + "additionalProperties": false, + "properties": { + "country": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The destination phone number's 2-letter ISO country code", + "example": "GB" + }, + "current_carrier": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The carrier name the phone number currently belongs to", + "example": "Vodafone" + }, + "number_type": { + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The destination phone number type", + "example": "mobile" + } + }, + "required": [ + "number_type", + "country", + "current_carrier" + ], + "title": "PhoneLookupDetails", + "type": "object" +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - } - ] -} - added
Output schema / properties / service_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Wavix 2FA Service", + "example": "7204a030201211ee9fb47d093f2f127c" +} - added
Output schema / properties / session_idAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Unique identifier of the Wavix 2FA Verification", + "example": "2953d4308f2e11ecb75fcdafd6d2d687" +} - added
Output schema / properties / session_urlAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "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" +} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the 2FA Verification was successfully created", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success", + "service_id", + "session_url", + "session_id", + "destination", + "created_at", + "number_lookup" +] - added
Output schema / titleAdded value: +"TwoFactorVerificationResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
two_fa_verification_resend10 fields changed- changed
Input schema / properties / channel / descriptionPrevious value: -"The communication channel you want to use. Can be either `sms` or `voice`."New value: +"Channel used to resend the verification code. One of `sms` (sent as a text message) or `voice` (read aloud over a phone call)." - changed
Input schema / properties / session_id / descriptionPrevious value: -"2FA Verification ID."New value: +"The unique ID of the 2FA verification session." - added
Output schema / properties / channelAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the code was sent via an SMS or a voice call", + "example": "voice" +} - added
Output schema / properties / created_atAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "Date and time the code was sent", + "example": "2022-02-16T13:41:38.000Z", + "format": "date-time" +} - added
Output schema / properties / destinationAdded value: +{ + "anyOf": [ + { + "type": "string" + }, + { + "type": "null" + } + ], + "description": "The destination phone number the code was sent to", + "example": "447919433768" +} - removed
Output schema / properties / resultRemoved value: -{ - "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 - } - } - ] -} - added
Output schema / properties / successAdded value: +{ + "anyOf": [ + { + "type": "boolean" + }, + { + "type": "null" + } + ], + "description": "Indicates whether the verification code was successfully sent", + "example": true +} - changed
Output schema / requiredPrevious value: -[ - "result" -]New value: +[ + "success", + "channel", + "destination", + "created_at" +] - added
Output schema / titleAdded value: +"TwoFactorVerificationResendResponse" - removed
Output schema / x-fastmcp-wrap-resultRemoved value: -true
- Changed
voice_campaigns_create20 fields changed- added
Input schema / properties / voice_campaign / descriptionAdded value: +"Represents a voice campaign that places an outbound call running a pre-approved call flow." - changed
Input schema / properties / voice_campaign / properties / callback_url / descriptionPrevious value: -"A webhook URL to receive campaign status updates"New value: +"Webhook URL that receives voice campaign status updates." - changed
Input schema / properties / voice_campaign / properties / caller_id / descriptionPrevious value: -"A phone number on your Wavix account. Will be used as Caller ID when placing an outbound call."New value: +"Phone number on the account used as the Caller ID for the outbound call, in E.164 format." - changed
Input schema / properties / voice_campaign / properties / callflow_id / descriptionPrevious value: -"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."New value: +"Unique identifier of the call flow to launch, listed on the Call flows page. Every scenario must be pre-approved by the Wavix Service Operations team before it can be used in production." - changed
Input schema / properties / voice_campaign / properties / contact / descriptionPrevious value: -"A phone number to place an outbound the call to"New value: +"Destination phone number the outbound call is placed to, in E.164 format." - added
Output schema / properties / voice_campaign / properties / caller_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / voice_campaign / properties / caller_id / descriptionPrevious value: -"Caller ID."New value: +"Phone number used as the Caller ID for the outbound call, in E.164 format." - removed
Output schema / properties / voice_campaign / properties / caller_id / typeRemoved value: -"string" - added
Output schema / properties / voice_campaign / properties / contact / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / voice_campaign / properties / contact / descriptionPrevious value: -"Destination phone number."New value: +"Destination phone number the outbound call is placed to, in E.164 format." - removed
Output schema / properties / voice_campaign / properties / contact / typeRemoved value: -"string" - added
Output schema / properties / voice_campaign / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / voice_campaign / properties / id / descriptionPrevious value: -"Voice campaign ID."New value: +"Unique identifier of the voice campaign." - removed
Output schema / properties / voice_campaign / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / voice_campaign / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / voice_campaign / properties / status / descriptionPrevious value: -"Voice campaign status."New value: +"Current status of the voice campaign, such as `in_progress`." - removed
Output schema / properties / voice_campaign / properties / status / typeRemoved value: -"string" - added
Output schema / properties / voice_campaign / properties / timestamp / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / voice_campaign / properties / timestamp / descriptionPrevious value: -"Date and time the voice campaign was created in ISO 8601 format."New value: +"Timestamp when the voice campaign was created, in ISO 8601 format." - removed
Output schema / properties / voice_campaign / properties / timestamp / typeRemoved value: -"string"
- Changed
voice_campaigns_get16 fields changed- changed
Input schema / properties / id / descriptionPrevious value: -"Voice campaign ID."New value: +"The unique ID of the voice campaign to retrieve." - added
Output schema / properties / voice_campaign / properties / caller_id / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / voice_campaign / properties / caller_id / descriptionPrevious value: -"Caller ID."New value: +"Phone number used as the Caller ID for the outbound call, in E.164 format." - removed
Output schema / properties / voice_campaign / properties / caller_id / typeRemoved value: -"string" - added
Output schema / properties / voice_campaign / properties / contact / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / voice_campaign / properties / contact / descriptionPrevious value: -"Destination phone number."New value: +"Destination phone number the outbound call is placed to, in E.164 format." - removed
Output schema / properties / voice_campaign / properties / contact / typeRemoved value: -"string" - added
Output schema / properties / voice_campaign / properties / id / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / voice_campaign / properties / id / descriptionPrevious value: -"Voice campaign ID."New value: +"Unique identifier of the voice campaign." - removed
Output schema / properties / voice_campaign / properties / id / typeRemoved value: -"integer" - added
Output schema / properties / voice_campaign / properties / status / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / voice_campaign / properties / status / descriptionPrevious value: -"Voice campaign status."New value: +"Current status of the voice campaign, such as `in_progress`." - removed
Output schema / properties / voice_campaign / properties / status / typeRemoved value: -"string" - added
Output schema / properties / voice_campaign / properties / timestamp / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / voice_campaign / properties / timestamp / descriptionPrevious value: -"Date and time the voice campaign was created in ISO 8601 format."New value: +"Timestamp when the voice campaign was created, in ISO 8601 format." - removed
Output schema / properties / voice_campaign / properties / timestamp / typeRemoved value: -"string"
- Changed
webrtc_tokens_create25 fields changed- added
Input schema / properties / payload / anyOfAdded value: +[ + { + "type": "object" + }, + { + "type": "null" + } +] - changed
Input schema / properties / payload / descriptionPrevious value: -"Arbitrary data to be associated with the token"New value: +"Arbitrary client-defined data to associate with the token." - removed
Input schema / properties / payload / typeRemoved value: -[ - "object", - "null" -] - changed
Input schema / properties / sip_trunk / descriptionPrevious value: -"SIP trunk name"New value: +"Name of the SIP trunk the token authenticates against." - added
Input schema / properties / ttl / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - added
Input schema / properties / ttl / defaultAdded value: +3600 - changed
Input schema / properties / ttl / descriptionPrevious value: -"Time to live in seconds. Pass `null` for no expiration."New value: +"Time to live in seconds. Default `3600`. Pass `null` for no expiration." - removed
Input schema / properties / ttl / typeRemoved value: -[ - "integer", - "null" -] - changed
Input schema / requiredPrevious value: -[ - "sip_trunk", - "ttl" -]New value: +[ + "sip_trunk" +] - added
Output schema / properties / payload / anyOfAdded value: +[ + { + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / payload / descriptionPrevious value: -"Arbitrary data associated with the token"New value: +"Arbitrary client-defined data associated with the token." - removed
Output schema / properties / payload / typeRemoved value: -[ - "object", - "null" -] - added
Output schema / properties / sip_trunk / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / sip_trunk / descriptionPrevious value: -"SIP trunk name"New value: +"Name of the SIP trunk the token authenticates against." - removed
Output schema / properties / sip_trunk / typeRemoved value: -"string" - added
Output schema / properties / token / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / token / descriptionPrevious value: -"Wavix Embeddable Widget token."New value: +"Signed JWT used by the Wavix embeddable widget to authenticate." - removed
Output schema / properties / token / typeRemoved value: -"string" - added
Output schema / properties / ttl / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - changed
Output schema / properties / ttl / descriptionPrevious value: -"Time to live, in seconds"New value: +"Lifetime of the token, in seconds. `null` means the token does not expire." - removed
Output schema / properties / ttl / typeRemoved value: -[ - "integer", - "null" -] - added
Output schema / properties / uuid / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / uuid / descriptionPrevious value: -"Token ID"New value: +"Unique identifier of the WebRTC token." - removed
Output schema / properties / uuid / typeRemoved value: -"string" - changed
Output schema / titlePrevious value: -"WebRtcTokenResponse"New value: +"WebRTCTokenResponse"
- Changed
webrtc_tokens_delete8 fields changed- added
Input schema / properties / idAdded value: +{ + "description": "The UUID of the widget token to delete.", + "format": "uuid", + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Token ID", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "id" +] - added
Output schema / properties / success / anyOfAdded value: +[ + { + "type": "boolean" + }, + { + "type": "null" + } +] - added
Output schema / properties / success / descriptionAdded value: +"Indicates whether the request was successful." - removed
Output schema / properties / success / typeRemoved value: -"boolean" - added
Output schema / requiredAdded value: +[ + "success" +] - added
Output schema / titleAdded value: +"SuccessResponse"
- Changed
webrtc_tokens_get16 fields changed- added
Input schema / properties / idAdded value: +{ + "description": "The UUID of the widget token to retrieve.", + "format": "uuid", + "type": "string" +} - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Token ID.", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid" -]New value: +[ + "id" +] - added
Output schema / descriptionAdded value: +"Represents a WebRTC token that authorizes the Wavix embeddable widget to register against a SIP trunk." - added
Output schema / properties / payload / anyOfAdded value: +[ + { + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / payload / descriptionPrevious value: -"Arbitrary data associated with the token"New value: +"Arbitrary client-defined data associated with the token." - removed
Output schema / properties / payload / typeRemoved value: -[ - "object", - "null" -] - added
Output schema / properties / sip_trunk / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / sip_trunk / descriptionPrevious value: -"SIP trunk name"New value: +"Name of the SIP trunk the token authenticates against." - removed
Output schema / properties / sip_trunk / typeRemoved value: -"string" - added
Output schema / properties / ttl / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / ttl / typeRemoved value: -[ - "integer", - "null" -] - added
Output schema / properties / uuid / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / uuid / descriptionPrevious value: -"Token ID"New value: +"Unique identifier of the WebRTC token." - removed
Output schema / properties / uuid / typeRemoved value: -"string" - changed
Output schema / titlePrevious value: -"WebRtcToken"New value: +"WebRTCToken"
- Changed
webrtc_tokens_list27 fields changed- added
Input schema / properties / pageAdded value: +{ + "description": "Page number to retrieve. Default `1`.", + "format": "int32", + "type": "integer" +} - added
Input schema / properties / per_pageAdded value: +{ + "description": "Number of records to return per page. Default `25`.", + "format": "int32", + "type": "integer" +} - added
Output schema / descriptionAdded value: +"Paginated list of WebRTC tokens." - added
Output schema / properties / items / anyOfAdded value: +[ + { + "type": "array" + }, + { + "type": "null" + } +] - added
Output schema / properties / items / descriptionAdded value: +"WebRTC tokens on the current page." - added
Output schema / properties / items / items / descriptionAdded value: +"Represents a WebRTC token that authorizes the Wavix embeddable widget to register against a SIP trunk." - added
Output schema / properties / items / items / properties / payload / anyOfAdded value: +[ + { + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / properties / payload / descriptionPrevious value: -"Arbitrary data associated with the token"New value: +"Arbitrary client-defined data associated with the token." - removed
Output schema / properties / items / items / properties / payload / typeRemoved value: -[ - "object", - "null" -] - added
Output schema / properties / items / items / properties / sip_trunk / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / properties / sip_trunk / descriptionPrevious value: -"SIP trunk name"New value: +"Name of the SIP trunk the token authenticates against." - removed
Output schema / properties / items / items / properties / sip_trunk / typeRemoved value: -"string" - added
Output schema / properties / items / items / properties / ttl / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / items / items / properties / ttl / typeRemoved value: -[ - "integer", - "null" -] - added
Output schema / properties / items / items / properties / uuid / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / items / items / properties / uuid / descriptionPrevious value: -"Token ID"New value: +"Unique identifier of the WebRTC token." - removed
Output schema / properties / items / items / properties / uuid / typeRemoved value: -"string" - changed
Output schema / properties / items / items / titlePrevious value: -"WebRtcToken"New value: +"WebRTCToken" - removed
Output schema / properties / items / typeRemoved value: -"array" - added
Output schema / properties / pagination / properties / current_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / current_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / per_page / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / per_page / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / total / typeRemoved value: -"integer" - added
Output schema / properties / pagination / properties / total_pages / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / pagination / properties / total_pages / typeRemoved value: -"integer"
- Changed
webrtc_tokens_update17 fields changed- added
Input schema / properties / idAdded value: +{ + "description": "The UUID of the widget token to update.", + "format": "uuid", + "type": "string" +} - changed
Input schema / properties / payload / descriptionPrevious value: -"Arbitrary data to be associated with the token"New value: +"Arbitrary client-defined data to associate with the token, replacing the existing payload." - removed
Input schema / properties / uuidRemoved value: -{ - "description": "Token ID", - "format": "uuid", - "type": "string" -} - changed
Input schema / requiredPrevious value: -[ - "uuid", - "payload" -]New value: +[ + "id", + "payload" +] - added
Output schema / descriptionAdded value: +"Represents a WebRTC token that authorizes the Wavix embeddable widget to register against a SIP trunk." - added
Output schema / properties / payload / anyOfAdded value: +[ + { + "type": "object" + }, + { + "type": "null" + } +] - changed
Output schema / properties / payload / descriptionPrevious value: -"Arbitrary data associated with the token"New value: +"Arbitrary client-defined data associated with the token." - removed
Output schema / properties / payload / typeRemoved value: -[ - "object", - "null" -] - added
Output schema / properties / sip_trunk / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / sip_trunk / descriptionPrevious value: -"SIP trunk name"New value: +"Name of the SIP trunk the token authenticates against." - removed
Output schema / properties / sip_trunk / typeRemoved value: -"string" - added
Output schema / properties / ttl / anyOfAdded value: +[ + { + "type": "integer" + }, + { + "type": "null" + } +] - removed
Output schema / properties / ttl / typeRemoved value: -[ - "integer", - "null" -] - added
Output schema / properties / uuid / anyOfAdded value: +[ + { + "type": "string" + }, + { + "type": "null" + } +] - changed
Output schema / properties / uuid / descriptionPrevious value: -"Token ID"New value: +"Unique identifier of the WebRTC token." - removed
Output schema / properties / uuid / typeRemoved value: -"string" - changed
Output schema / titlePrevious value: -"WebRtcToken"New value: +"WebRTCToken"
6 tool updates
- Changed
cdrs_get1 field changed- changed
Output schema / properties / result / allOfPrevious value: -[ - { - "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" - }, - "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" - } -]New value: +[ + { + "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" + } +]
- Changed
my_numbers_get1 field changed- changed
Output schema / properties / state / typePrevious value: -"string"New value: +[ + "string", + "null" +]
- Changed
my_numbers_list1 field changed- changed
Output schema / properties / items / items / properties / state / typePrevious value: -"string"New value: +[ + "string", + "null" +]
- Changed
my_numbers_update1 field changed- changed
Output schema / properties / state / typePrevious value: -"string"New value: +[ + "string", + "null" +]
- Changed
profile_get1 field changed- changed
Output schema / properties / result / allOfPrevious value: -[ - { - "additionalProperties": false, - "properties": { - "additional_info": { - "description": "Additional info associated with the account.", - "example": "Additional info", - "type": "string" - }, - "company_info": { - "additionalProperties": false, - "description": "Company details.", - "properties": { - "address": { - "description": "Company address.", - "example": "Baker street", - "type": "string" - }, - "attn_contact_name": { - "description": "Billing contact name.", - "example": "James Scott", - "type": "string" - }, - "country": { - "additionalProperties": false, - "description": "Country.", - "properties": { - "country_id": { - "description": "Country ID.", - "example": 1, - "type": "integer" - }, - "country_name": { - "description": "Country name.", - "example": "United States", - "type": "string" - } - }, - "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" - ], - "example": "telecommunications", - "type": "string" - }, - "name": { - "description": "Company name.", - "example": "Awesome company", - "type": "string" - }, - "vat_number": { - "description": "VAT number.", - "example": "VAT123456789", - "type": "string" - } - }, - "type": "object" - }, - "contact_email": { - "description": "Additional email address for billing notifications.", - "example": "billing@awesome.com", - "type": "string" - }, - "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" - }, - "email": { - "description": "Email associated with the account.", - "example": "info@awesome.com", - "type": "string" - }, - "first_name": { - "description": "Account owner's first name.", - "example": "Jason", - "type": "string" - }, - "id": { - "description": "Account ID.", - "example": 1, - "format": "int32", - "type": "integer" - }, - "job_title": { - "description": "Account owner's job title.", - "example": "Manager", - "type": "string" - }, - "last_name": { - "description": "Account owner's last name.", - "example": "Androux", - "type": "string" - }, - "phone": { - "description": "Account owner's phone number.", - "example": "13291019312", - "type": "string" - }, - "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" - } -]New value: +[ + { + "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": "billing@awesome.com", + "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": "info@awesome.com", + "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" + } +]
- Changed
profile_update1 field changed- changed
Output schema / properties / result / allOfPrevious value: -[ - { - "additionalProperties": false, - "properties": { - "additional_info": { - "description": "Additional info associated with the account.", - "example": "Additional info", - "type": "string" - }, - "company_info": { - "additionalProperties": false, - "description": "Company details.", - "properties": { - "address": { - "description": "Company address.", - "example": "Baker street", - "type": "string" - }, - "attn_contact_name": { - "description": "Billing contact name.", - "example": "James Scott", - "type": "string" - }, - "country": { - "additionalProperties": false, - "description": "Country.", - "properties": { - "country_id": { - "description": "Country ID.", - "example": 1, - "type": "integer" - }, - "country_name": { - "description": "Country name.", - "example": "United States", - "type": "string" - } - }, - "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" - ], - "example": "telecommunications", - "type": "string" - }, - "name": { - "description": "Company name.", - "example": "Awesome company", - "type": "string" - }, - "vat_number": { - "description": "VAT number.", - "example": "VAT123456789", - "type": "string" - } - }, - "type": "object" - }, - "contact_email": { - "description": "Additional email address for billing notifications.", - "example": "billing@awesome.com", - "type": "string" - }, - "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" - }, - "email": { - "description": "Email associated with the account.", - "example": "info@awesome.com", - "type": "string" - }, - "first_name": { - "description": "Account owner's first name.", - "example": "Jason", - "type": "string" - }, - "id": { - "description": "Account ID.", - "example": 1, - "format": "int32", - "type": "integer" - }, - "job_title": { - "description": "Account owner's job title.", - "example": "Manager", - "type": "string" - }, - "last_name": { - "description": "Account owner's last name.", - "example": "Androux", - "type": "string" - }, - "phone": { - "description": "Account owner's phone number.", - "example": "13291019312", - "type": "string" - }, - "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" - } -]New value: +[ + { + "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": "billing@awesome.com", + "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": "info@awesome.com", + "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" + } +]
122 tool updates
- First observed
api_keys_activate - First observed
api_keys_create - First observed
api_keys_deactivate - First observed
api_keys_delete - First observed
api_keys_list - First observed
billing_invoices_download - First observed
billing_invoices_list - First observed
billing_transactions_list - First observed
buy_cities_list - First observed
buy_countries_list - First observed
buy_numbers_list - First observed
buy_region_cities_list - First observed
buy_regions_list - First observed
call_control_answer - First observed
call_control_audio_play - First observed
call_control_audio_stop - First observed
call_control_collect - First observed
call_control_create - First observed
call_control_delete - First observed
call_control_get - First observed
call_control_list - First observed
call_control_streams_create - First observed
call_control_streams_delete - First observed
call_control_update - First observed
call_recording_delete - First observed
call_recording_get - First observed
call_recording_list - First observed
call_webhooks_create - First observed
call_webhooks_delete - First observed
call_webhooks_list - First observed
cart_add - First observed
cart_checkout - First observed
cart_get - First observed
cart_remove - First observed
cdrs_get - First observed
cdrs_list - First observed
cdrs_list_all - First observed
cdrs_retranscribe - First observed
cdrs_search - First observed
cdrs_transcription_get - First observed
link_shortener_create - First observed
link_shortener_metrics_list - First observed
my_numbers_delete - First observed
my_numbers_destinations_update - First observed
my_numbers_get - First observed
my_numbers_list - First observed
my_numbers_papers_upload - First observed
my_numbers_sms_update - First observed
my_numbers_update - First observed
number_validator_create_bulk - First observed
number_validator_get - First observed
number_validator_results_get - First observed
profile_config_get - First observed
profile_get - First observed
profile_update - First observed
sip_trunks_create - First observed
sip_trunks_delete - First observed
sip_trunks_get - First observed
sip_trunks_list - First observed
sip_trunks_update - First observed
sms_and_mms_messages_get - First observed
sms_and_mms_messages_list - First observed
sms_and_mms_messages_list_all - First observed
sms_and_mms_messages_send - First observed
sms_and_mms_opt_outs_create - First observed
sms_and_mms_opt_outs_list - First observed
sms_and_mms_sender_ids_create - First observed
sms_and_mms_sender_ids_delete - First observed
sms_and_mms_sender_ids_get - First observed
sms_and_mms_sender_ids_list - First observed
speech_analytics_create - First observed
speech_analytics_file_get - First observed
speech_analytics_get - First observed
speech_analytics_retranscribe - First observed
sub_accounts_create - First observed
sub_accounts_get - First observed
sub_accounts_list - First observed
sub_accounts_transactions_list - First observed
sub_accounts_update - First observed
ten_dlc_brand_appeals_create - First observed
ten_dlc_brand_appeals_list - First observed
ten_dlc_brand_campaigns_create - First observed
ten_dlc_brand_campaigns_delete - First observed
ten_dlc_brand_campaigns_get - First observed
ten_dlc_brand_campaigns_list - First observed
ten_dlc_brand_campaigns_update - First observed
ten_dlc_brand_evidence_delete - First observed
ten_dlc_brand_evidence_get - First observed
ten_dlc_brand_evidence_list - First observed
ten_dlc_brand_evidence_upload - First observed
ten_dlc_brand_usecase_qualify - First observed
ten_dlc_brand_vetting_appeals_create - First observed
ten_dlc_brand_vetting_appeals_list - First observed
ten_dlc_brand_vettings_create - First observed
ten_dlc_brand_vettings_import - First observed
ten_dlc_brand_vettings_list - First observed
ten_dlc_brands_create - First observed
ten_dlc_brands_delete - First observed
ten_dlc_brands_get - First observed
ten_dlc_brands_list - First observed
ten_dlc_brands_update - First observed
ten_dlc_campaign_numbers_link - First observed
ten_dlc_campaign_numbers_list - First observed
ten_dlc_campaign_numbers_unlink - First observed
ten_dlc_campaigns_list - First observed
ten_dlc_campaigns_nudge - First observed
ten_dlc_subscriptions_create - First observed
ten_dlc_subscriptions_delete - First observed
ten_dlc_subscriptions_list - First observed
two_fa_events_list - First observed
two_fa_sessions_list - First observed
two_fa_verification_cancel - First observed
two_fa_verification_check - First observed
two_fa_verification_create - First observed
two_fa_verification_resend - First observed
voice_campaigns_create - First observed
voice_campaigns_get - First observed
webrtc_tokens_create - First observed
webrtc_tokens_delete - First observed
webrtc_tokens_get - First observed
webrtc_tokens_list - First observed
webrtc_tokens_update
Related MCP Connectors
Czech telephony API and MCP for apps and AI agents - numbers, calls, SMS, voice agent.
WhatsApp (Web + Business API), SMS, contacts, and call records via 2Chat's MCP server.
Phone, SMS & email for AI agents — one remote MCP endpoint, OAuth login, zero install.
Send, automate, and orchestrate SMS, WhatsApp, Viber, IVR, and USSD messaging in 150+ countries.
Related MCP Servers
- AlicenseAqualityAmaintenanceMCP server for SMS verification — get virtual phone numbers, receive OTP codes, and manage verifications for 500+ services across 50+ countries via the VirtualSMS API.4088 npm8MIT
- AlicenseAqualityBmaintenanceLoginWA MCP: WhatsApp OTP, device status, send message, and broadcast for AI agents. LoginWA hosts the WhatsApp session, so no VPS, no Baileys to babysit, no reconnect loops. Free tier 100 messages a month, paid from $1. Pricing: https://loginwa.com/pricing8MIT
- AlicenseNot gradedqualityDmaintenanceThe most complete MCP Server for WhatsApp Business Cloud API. 43 tools across 10 modules including messaging, templates, media, webhooks, analytics, AI auto-reply, and anti-spam protection.12 npm3MIT
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd
Glama MCP Gateway
Add one secure layer between your agents and this server.