Wavix
REMOTE · MCP.WAVIX.COM · SCANNED AUG 3
Hosted MCP server for the Wavix telecom platform: SMS, voice, 2FA, SIP, numbers, 10DLC, CDRs.
Available components
How this component scores in each security and reliability category. Every signal is checked automatically against the live server, and we only credit what we can confirm. How we score →
Endpoint Security57
- The endpoint's TLS certificate is valid, in date, and uses a strong key. View diagnostics → Pass
- Authorisation not fully verified: no authorisation is required to call this server, and 122 tool(s) never declared a destructiveHint. The MCP spec treats an absent hint as destructive by default, so we cannot call this surface safe. See how to fix → View diagnostics → Unverified
- HTTPS is enforced; there's no plaintext access path. View diagnostics → Pass
- HSTS check failed: the Strict-Transport-Security header is absent. See how to fix → View diagnostics → Fail
- DNSSEC check failed: this domain isn't protected by DNSSEC. See how to fix → View diagnostics → Fail
Transport & Reachability100
- Verified streamable-http transport via a live MCP handshake. View diagnostics → Pass
Schema Quality & AI Usability67
- 100% of prompts and resources have a non-trivial description (not blank, and not just the item's name).Pass
- AI-judged instruction clarity (fair).Partial
- Tool/resource definitions use about 13523 tokens (~80/item across 167 items; 122 tools + 45 resources), lean.Pass
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management27
- Stability observed for 8 of 30 days with no destabilising changes; credit accrues until the full window elapses.Partial
Tool Coverage99
- 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
- 96% of tool parameters carry a description.Partial
- Structured output schemas are declared (98% of tools); any adoption earns full credit.Pass
Capabilities100
- Implements a supported MCP spec version (2025-11-25); the latest is 2026-07-28.Pass
Add this component to your MCP client. Where a client-specific snippet is available, pick your client below and copy it straight into your config; otherwise use the connection detail shown.
remote · mcp.wavix.com
claude mcp add --transport http wavix-mcp https://mcp.wavix.com/mcp
[mcp_servers.wavix-mcp] url = "https://mcp.wavix.com/mcp"
{
"$schema": "https://opencode.ai/config.json",
"mcp": {
"wavix-mcp": {
"type": "remote",
"url": "https://mcp.wavix.com/mcp",
"enabled": true
}
}
} openclaw mcp add wavix-mcp --url https://mcp.wavix.com/mcp --transport streamable-http
mcp_servers:
wavix-mcp:
url: "https://mcp.wavix.com/mcp" {
"mcpServers": {
"wavix-mcp": {
"type": "http",
"url": "https://mcp.wavix.com/mcp"
}
}
} The mcpServers block is a cross-client convention. Remote transports vary, so check your client's docs.
Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 2 Aug 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 20 to 23. That category is still filling its 30-day observation window: 6 days of observed history at the previous scan, 7 at this one. The score rises as the window fills, whether or not the server changes.
- 31 Jul 26 +1
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 30 Jul 26 0
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 29 Jul 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 7 to 10. That category is still filling its 30-day observation window: 2 days of observed history at the previous scan, 3 at this one. The score rises as the window fills, whether or not the server changes.
- 28 Jul 26 +1
No change was recorded against any check on this day. Stability & Change Management went from 3 to 7. That category is still filling its 30-day observation window: 1 days of observed history at the previous scan, 2 at this one. The score rises as the window fills, whether or not the server changes.
- 27 Jul 26 0
- We updated how we score, so this day's move reflects our rubric, not a change to the server See what changed → functional
- 26 Jul 26 61
First indexed and scored.
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 3 Aug 2026 · Probed https://mcp.wavix.com/mcp
TLS valid
Negotiated TLS 1.3 with TLS_AES_256_GCM_SHA384 .
| Subject | Issuer | Valid from | Valid until | Key | Signature | Serial |
|---|---|---|---|---|---|---|
| CN=*.wavix.com | CN=GlobalSign GCC R6 AlphaSSL CA 2025,O=GlobalSign nv-sa,C=BE | 16 Jun 2026 | 1 Jan 2027 | RSA 2048 | SHA256-RSA | 138eab06a957b419c83f0b22 |
| SANs: *.wavix.com, wavix.com | ||||||
| CN=GlobalSign GCC R6 AlphaSSL CA 2025,O=GlobalSign nv-sa,C=BE (CA) | CN=GlobalSign,OU=GlobalSign Root CA - R6,O=GlobalSign | 21 May 2025 | 21 May 2027 | RSA 2048 | SHA256-RSA | 837d4eb89e912fe72cad3bc7692ddc20 |
| CN=GlobalSign,OU=GlobalSign Root CA - R6,O=GlobalSign (CA) | CN=GlobalSign,OU=GlobalSign Root CA - R6,O=GlobalSign | 10 Dec 2014 | 10 Dec 2034 | RSA 4096 | SHA384-RSA | 45e6bb038333c3856548e6ff4551 |
DNSSEC insecure
Validation of mcp.wavix.com. — Not signed
| Zone | DS | Keys | Algorithms | Outcome |
|---|---|---|---|---|
| . | trust_anchor | 20326, 38696 | 8, 8 | Verified |
| com. | present | 19718 | 13 | Verified |
| wavix.com. | absent | Unsigned (proven) parent-signed NSEC/NSEC3 proves an unsigned delegation |
Authentication No authorisation required
The endpoint answered without asking for a token. Anyone who knows the URL can reach it.
| Result | No authorisation required |
|---|---|
| HTTP status | 200 |
Transports 2 probes
| Transport | URL | Outcome | Status | Location |
|---|---|---|---|---|
| streamable-http | https://mcp.wavix.com/mcp | Verified | 200 | |
| http (plaintext) | http://mcp.wavix.com/mcp | HTTPS enforced | 301 | https://wavix.com/mcp |
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability.
api_keys_activate ~38
Activates an API key. Once activated, the API key can be used for authentication again.
| Name | Type | Req | Description |
|---|---|---|---|
| id | integer | yes | API key ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | — |
No examples provided.
api_keys_create ~482
Creates an API key. Optional IP restrictions can be configured to limit access.
| Name | Type | Req | Description |
|---|---|---|---|
| account | — | — | View and update account profile information and timezone. |
| billing | — | — | Access invoices, balance, payment methods, usage reports, and billing settings, including payment method updates. |
| calls | — | — | Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests. |
| campaigns | — | — | View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links. |
| embeddable | — | — | Manage widget tokens, including listing, viewing, creating, updating, and deleting them. |
| is_active | boolean | — | Indicates whether the API key should be activated upon creation. |
| is_restriction | boolean | — | Indicates whether to restrict API key access by IP address. When enabled, only requests from IP addresses listed in `permitted_ips` are allowed. |
| is_scopes_enabled | boolean | — | When `true`, scope fields below are enforced. When `false` (default), the key has full access. Omitted scope fields default to `{ allow: none }`, so with `is_scopes_enabled: true` and no scopes set t… |
| label | string | — | API key label. |
| messages | — | — | Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs. |
| numbers | — | — | View, buy, release, and configure phone numbers, browse inventory, and manage the cart. |
| permitted_ips | array | — | List of permitted IP addresses for this API key. Each must be a valid IPv4 address. Required when `is_restriction` is true. |
| recordings | — | — | List, download, and delete call recordings. |
| subaccounts | — | — | Manage subaccounts: list and view them, create, update, and suspend them. |
| trunks | — | — | View, create, update, and delete SIP trunks and their settings. |
| two_fa | — | — | View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes. |
| validator | — | — | View number validation results and trigger single or bulk validation or HLR lookup requests. |
| webhooks | — | — | List, create, and delete webhooks. |
| Name | Type | Req | Description |
|---|---|---|---|
| account | — | yes | View and update account profile information and timezone. |
| billing | — | yes | Access invoices, balance, payment methods, usage reports, and billing settings, including payment method updates. |
| calls | — | yes | Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests. |
| campaigns | — | yes | View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links. |
| created_at | string | yes | Creation date and time in ISO 8601 format. |
| embeddable | — | yes | Manage widget tokens, including listing, viewing, creating, updating, and deleting them. |
| id | integer | yes | API key ID. |
| is_active | boolean | yes | Indicates whether the API key is active. |
| is_restriction | boolean | yes | Indicates whether IP restrictions are enabled. When enabled, the API key works only from IP addresses in `permitted_ips`. |
| is_scopes_enabled | boolean | yes | When `true`, the key is restricted to the permissions defined in the scope fields below. When `false`, the key has full access. |
| label | string | yes | API key label. |
| last_used_at | string|null | yes | Timestamp of the most recent authenticated request made with this key. |
| messages | — | yes | Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs. |
| numbers | — | yes | View, buy, release, and configure phone numbers, browse inventory, and manage the cart. |
| permitted_ips | array | yes | List of permitted IP addresses. If `is_restriction` is false, an empty list means no IP restrictions. If `is_restriction` is true, an empty list prevents all requests. |
| recordings | — | yes | List, download, and delete call recordings. |
| subaccounts | — | yes | Manage subaccounts: list and view them, create, update, and suspend them. |
| trunks | — | yes | View, create, update, and delete SIP trunks and their settings. |
| two_fa | — | yes | View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes. |
| validator | — | yes | View number validation results and trigger single or bulk validation or HLR lookup requests. |
| value | string | yes | API key value. |
| webhooks | — | yes | List, create, and delete webhooks. |
No examples provided.
api_keys_deactivate ~40
Deactivates an API key. Once deactivated, the API key cannot be used for authentication.
| Name | Type | Req | Description |
|---|---|---|---|
| id | integer | yes | API key ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | — |
No examples provided.
api_keys_delete ~29
Deletes an API key. This action is permanent.
| Name | Type | Req | Description |
|---|---|---|---|
| id | integer | yes | API key ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | — |
No examples provided.
api_keys_list ~32
Returns a list of API keys.
| Name | Type | Req | Description |
|---|---|---|---|
| label | string | — | Label to filter API keys. Partial match supported. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | array | yes | — |
No examples provided.
billing_invoices_download ~60
Get a download URL for a billing invoice PDF. Returns ``{download_url, content_type, status_code, note}`` instead of the binary PDF stream. Fetch ``download_url`` to obtain the file.
| Name | Type | Req | Description |
|---|---|---|---|
| id | integer | yes | — |
Structured output declared, but exposes no named fields.
No examples provided.
billing_invoices_list ~43
Returns a paginated list of financial statements.
| Name | Type | Req | Description |
|---|---|---|---|
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
billing_transactions_list ~112
Returns a paginated list of financial transactions.
| Name | Type | Req | Description |
|---|---|---|---|
| details_contains | string | — | Transaction details for filtering. |
| from_date | string | yes | Start date in `YYYY-MM-DD` format. |
| page | integer | — | Page number to retrieve. |
| payments | boolean | — | Indicates whether to include account top-ups only. |
| per_page | integer | — | Number of records per page. |
| to_date | string | yes | End date in `YYYY-MM-DD` format. |
| type | — | — | Filter by transaction type. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
buy_cities_list ~59
Returns a list of cities for countries where `has_provinces_or_states` is `false`.
| Name | Type | Req | Description |
|---|---|---|---|
| country | integer | yes | Country ID. |
| text_enabled_only | boolean | — | Indicates whether to return only cities with text-enabled numbers. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
buy_countries_list ~41
Returns a list of countries where phone numbers are available.
| Name | Type | Req | Description |
|---|---|---|---|
| text_enabled_only | boolean | — | Indicates whether to return only countries with text-enabled phone numbers. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
buy_numbers_list ~81
Returns a paginated list of phone numbers available for purchase.
| Name | Type | Req | Description |
|---|---|---|---|
| city | integer | yes | City ID. |
| country | integer | yes | Country ID. |
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| text_enabled_only | boolean | — | Indicates whether to return only text-enabled phone numbers. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
buy_region_cities_list ~72
Returns a list of cities in the specified region for countries where `has_provinces_or_states` is `true`.
| Name | Type | Req | Description |
|---|---|---|---|
| country | integer | yes | Country ID. |
| region | integer | yes | Region ID. |
| text_enabled_only | boolean | — | Indicates whether to return only cities with text-enabled numbers. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
buy_regions_list ~62
Returns a list of regions (states or provinces) for countries where `has_provinces_or_states` is `true`.
| Name | Type | Req | Description |
|---|---|---|---|
| country | integer | yes | Country ID. |
| text_enabled_only | boolean | — | Indicates whether to return only regions with text-enabled numbers. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
call_control_answer ~94
Answers an inbound call. Optionally initiate media streaming upon answering.
| Name | Type | Req | Description |
|---|---|---|---|
| call_recording | boolean | — | Indicates whether the call should be recorded. |
| call_transcription | boolean | — | Indicates whether the call should be transcribed after it ends. |
| stream_channel | — | — | — |
| stream_type | — | — | — |
| stream_url | string | — | WebSocket URL to stream the call. |
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | Indicates whether the request was successful. |
No examples provided.
call_control_audio_play ~41
Plays audio in an active call.
| Name | Type | Req | Description |
|---|---|---|---|
| audio_file | string | yes | URL of the audio file to play |
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | Indicates whether the request was successful. |
No examples provided.
call_control_audio_stop ~27
Stops audio playback in an active call.
| Name | Type | Req | Description |
|---|---|---|---|
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | Indicates whether the request was successful. |
No examples provided.
call_control_collect ~113
Collects DTMF input in an active call.
| Name | Type | Req | Description |
|---|---|---|---|
| max_attempts | integer | — | Maximum number of attempts. |
| max_digits | integer | — | Maximum number of digits to collect. |
| prompt | object | — | Prompt to play before collecting digits. Play a prerecorded audio file or use Wavix Text-To-Speech. |
| termination_character | string | — | DTMF character that ends input collection. |
| timeout | integer | — | Timeout for digit collection in seconds. |
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | Indicates whether the request was successful. |
No examples provided.
call_control_create ~129
Starts an outbound call.
| Name | Type | Req | Description |
|---|---|---|---|
| callback_url | string | yes | The callback URL where Wavix sends the call status updates |
| from | string | yes | Caller ID. Must be an active or verified phone number in your account. |
| recording | boolean | — | Specifies whether to record the call |
| tag | string | — | Call metadata |
| timeout | integer | — | The ring timeout, in seconds, before the call is considered unanswered. |
| to | string | yes | Destination number in E.164 format |
| voicemail_detection | boolean | — | Specifies whether the AMD is turned on for the call |
| Name | Type | Req | Description |
|---|---|---|---|
| call_answered | string|null | — | Date and time when the call was answered |
| call_completed | string|null | — | Date and time when the call ended |
| call_started | string | — | Date and time when the call started |
| direction | string | — | Call direction - inbound or outbound |
| event_payload | — | — | Event-specific data |
| event_time | string | — | Date and time of the latest event |
| event_type | string | — | The latest call event |
| from | string | — | Caller ID |
| machine_detected | boolean | — | Indicates whether the call was answered by an answering machine |
| tag | string | — | Call metadata |
| to | string | — | Destination number |
| uuid | string | — | Call ID |
No examples provided.
call_control_delete ~23
Ends an active call.
| Name | Type | Req | Description |
|---|---|---|---|
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | Indicates whether the request was successful. |
No examples provided.
call_control_get ~22
Returns a call.
| Name | Type | Req | Description |
|---|---|---|---|
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| call | object | yes | — |
| success | boolean | yes | Indicates whether the request was successful. |
No examples provided.
call_control_list ~16
Returns a list of active calls.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| calls | array | yes | List of calls |
| success | boolean | yes | Indicates whether the request was successful. |
No examples provided.
call_control_streams_create ~51
Starts call media streaming.
| Name | Type | Req | Description |
|---|---|---|---|
| stream_channel | — | yes | — |
| stream_type | — | yes | — |
| stream_url | string | yes | WebSocket URL for call streaming |
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| stream_id | string | — | Stream ID |
| success | boolean | — | Indicates that the request was successful |
No examples provided.
call_control_streams_delete ~35
Stops call media streaming.
| Name | Type | Req | Description |
|---|---|---|---|
| stream_uuid | string | yes | Stream ID. |
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | Indicates whether the request was successful. |
No examples provided.
call_control_update ~42
Updates an active call. Only the `tag` field can be modified.
| Name | Type | Req | Description |
|---|---|---|---|
| tag | string | yes | Call metadata. |
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | yes | Indicates whether the request was successful. |
No examples provided.
call_recording_delete ~24
Deletes a call recording.
| Name | Type | Req | Description |
|---|---|---|---|
| id | integer | yes | Recording ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | Indicates whether the request succeeded. |
No examples provided.
call_recording_get ~63
Get a download URL for a call recording audio file. Returns ``{download_url, content_type, status_code, note}`` instead of the binary audio stream. Fetch ``download_url`` to obtain the MP3.
| Name | Type | Req | Description |
|---|---|---|---|
| call_uuid | string | yes | — |
Structured output declared, but exposes no named fields.
No examples provided.
call_recording_list ~145
Returns a paginated list of call recordings.
| Name | Type | Req | Description |
|---|---|---|---|
| call_uuid | string | — | Call ID for filtering. |
| from | string | — | Originating phone number for filtering. Full or partial input accepted. |
| from_date | string | — | Start date in `YYYY-MM-DD` format. |
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| sip_trunks | array | — | List of SIP trunk logins to filter outbound calls. |
| to | string | — | Destination phone number for filtering. Full or partial input accepted. |
| to_date | string | — | End date in `YYYY-MM-DD` format. |
| Name | Type | Req | Description |
|---|---|---|---|
| invalid | object | — | An invalid recording filter response |
| pagination | object | — | — |
| recordings | array | — | — |
No examples provided.
call_webhooks_create ~111
Creates a call webhook. Wavix sends POST callbacks for `on-call` and `post-call` events.
| Name | Type | Req | Description |
|---|---|---|---|
| event_type | string | yes | Allowed values: `on-call`, `post-call`. - `on-call`: Sends real-time status updates when a call starts, is answered, and ends. - `post-call`: Sends a callback after the call ends with disposit… |
| url | string | yes | Webhook URL to send call events to. |
| Name | Type | Req | Description |
|---|---|---|---|
| event_type | string | yes | Type of call events |
| success | boolean | yes | — |
| url | string | yes | Webhook URL |
No examples provided.
call_webhooks_delete ~48
Deletes a call webhook.
| Name | Type | Req | Description |
|---|---|---|---|
| event_type | string | yes | Use `post-call` to stop receiving post-call callbacks. Use `on-call` to stop receiving real-time call status updates. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | — |
No examples provided.
call_webhooks_list ~37
Returns a list of configured call webhooks. Wavix sends POST callbacks for `on-call` and `post-call` events.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| result | array | yes | List of call webhooks configured for the phone number. |
No examples provided.
cart_add ~31
Adds phone numbers to the cart.
| Name | Type | Req | Description |
|---|---|---|---|
| ids | array | yes | List of phone numbers to add to the cart. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | array | yes | — |
No examples provided.
cart_checkout ~41
Checks out the cart. Activation and monthly fees are deducted from the account balance.
| Name | Type | Req | Description |
|---|---|---|---|
| ids | array | yes | List of phone numbers to check out from the cart. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
cart_get ~12
Returns the cart.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
cart_remove ~28
Removes phone numbers from the cart.
| Name | Type | Req | Description |
|---|---|---|---|
| ids | array | yes | List of phone numbers to remove. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
cdrs_get ~37
Returns call details.
| Name | Type | Req | Description |
|---|---|---|---|
| show_transcription | boolean | — | Indicates whether to include transcription. |
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
cdrs_list ~199
Returns a paginated list of CDRs.
| Name | Type | Req | Description |
|---|---|---|---|
| disposition | — | — | Call disposition to filter results. Allowed values: `answered`, `busy`, `rejected`, `failed`, `all`. |
| from | string | yes | Start date in `YYYY-MM-DD` format. |
| from_search | string | — | Originating phone number for filtering. Full or partial input accepted. |
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| sip_trunk | string | — | SIP trunk login to filter outbound calls. Ignored for inbound calls. |
| to | string | yes | End date in `YYYY-MM-DD` format. |
| to_search | string | — | Destination phone number for filtering. Full or partial input accepted. |
| type | string | yes | Call direction to filter results. Allowed values: `placed`, `received`. |
| uuid | string | — | Call ID to filter results. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
cdrs_list_all ~202
Returns CDRs in NDJSON format for bulk export.
| Name | Type | Req | Description |
|---|---|---|---|
| disposition | — | — | Call disposition to filter results. Allowed values: `answered`, `busy`, `rejected`, `failed`, `all`. |
| from | string | yes | Start date in `YYYY-MM-DD` format. |
| from_search | string | — | Originating phone number for filtering. Full or partial input accepted. |
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| sip_trunk | string | — | SIP trunk login to filter outbound calls. Ignored for inbound calls. |
| to | string | yes | End date in `YYYY-MM-DD` format. |
| to_search | string | — | Destination phone number for filtering. Full or partial input accepted. |
| type | string | yes | Call direction to filter results. Allowed values: `placed`, `received`. |
| uuid | string | — | Call ID to filter results. |
No output schema declared.
No examples provided.
cdrs_retranscribe ~51
Transcribes a recorded call.
| Name | Type | Req | Description |
|---|---|---|---|
| language | string|null | — | Language. |
| uuid | string | yes | Call ID. |
| webhook_url | string | — | Webhook URL to receive status updates. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | yes | Indicates whether the request was successful. |
No examples provided.
cdrs_search ~194
Searches call transcriptions for specific keywords or phrases.
| Name | Type | Req | Description |
|---|---|---|---|
| disposition | — | — | — |
| from | string | yes | Start date for call search in `YYYY-MM-DD` format. |
| from_search | string | — | Originating phone number to filter results. Accepts full or partial number. |
| min_duration | integer | — | Minimum call duration in seconds. |
| page | integer | yes | Page number to retrieve. |
| per_page | integer | yes | Number of records per page. |
| sip_trunk | string | — | SIP trunk login to filter outbound calls. Ignored for inbound calls. |
| to | string | yes | End date for call search in `YYYY-MM-DD` format. |
| to_search | string | — | Destination phone number to filter results. Accepts full or partial number. |
| transcription | object | — | — |
| type | string | yes | Search transcriptions by call type. |
| uuid | string | — | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
cdrs_transcription_get ~27
Returns a recorded call transcription.
| Name | Type | Req | Description |
|---|---|---|---|
| uuid | string | yes | Call ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
link_shortener_create ~90
Creates a short link.
| Name | Type | Req | Description |
|---|---|---|---|
| expiration_time | string | — | Expiration date and time in ISO 8601 format. |
| fallback_url | string | — | Fallback URL for expired or invalid links. |
| link | string | yes | Target URL to shorten. |
| phone | string | — | Phone number for the short link. |
| utm_campaign | string | — | UTM campaign name for tracking insights. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
link_shortener_metrics_list ~98
Returns short link metrics.
| Name | Type | Req | Description |
|---|---|---|---|
| from | string | yes | Start date in `YYYY-MM-DD` format. |
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| phone | string | — | Phone number for filtering. |
| to | string | yes | End date in `YYYY-MM-DD` format. |
| utm_campaign | string | — | UTM campaign name for filtering. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
my_numbers_delete ~44
Releases phone numbers back to stock.
| Name | Type | Req | Description |
|---|---|---|---|
| dids | string | — | List of phone numbers to release. |
| ids | array | — | List of phone number IDs to release. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
my_numbers_destinations_update ~64
Updates inbound call routing for phone numbers.
| Name | Type | Req | Description |
|---|---|---|---|
| destinations | array | yes | Inbound call destinations to apply. |
| ids | array | yes | List of phone number IDs to update. |
| sms_relay_url | string | yes | Callback URL for inbound SMS and MMS messages. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
my_numbers_get ~24
Returns a phone number.
| Name | Type | Req | Description |
|---|---|---|---|
| id | integer | yes | Phone number ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| activation_fee | string | yes | One-time activation fee in USD. |
| added | string | yes | Date and time the phone number was purchased in ISO 8601 format. |
| call_recording_enabled | boolean | yes | Indicates whether call recording is enabled. |
| call_status_url | string|null | — | Callback URL for call status updates. |
| channels | integer | yes | Maximum number of concurrent inbound calls. |
| city | string | yes | City or rate center where the phone number originates. |
| cnam | boolean|null | yes | Indicates whether CNAM is enabled. |
| country | string | yes | Country where the phone number originates. |
| country_short_name | string | yes | Two-letter ISO country code. |
| destination | array | yes | Inbound call destinations set for the phone number. |
| documents | array | yes | Uploaded documents for the phone number. |
| domestic_cli | boolean | yes | Indicates whether the number can be used as the Caller ID for local calls. |
| free_min | integer | — | Number of free inbound minutes. |
| id | integer | yes | Phone number ID. |
| label | string|null | yes | Label assigned to the phone number. |
| monthly_fee | string | yes | Monthly fee in USD. |
| number | string | yes | Phone number. |
| paid_until | string | yes | Date until which the number is paid. |
| per_min | string | yes | Price per inbound minute in USD. |
| require_docs | array | yes | Documents required to activate the phone number. |
| seconds | string | yes | Total inbound call duration in seconds for current month. |
| sms_enabled | boolean | yes | Indicates whether SMS is enabled. |
| sms_relay_url | string|null | yes | Callback URL for inbound SMS and MMS messages. |
| state | string|null | — | State where the phone number originates. For non-US numbers, this field may be null. |
| status | string | yes | Phone number status. `active` means the number can receive and place calls; `inactive` means it cannot. |
| transcription_enabled | boolean | yes | Indicates whether transcription is enabled. |
| transcription_threshold | integer | yes | Minimum call duration in seconds to trigger transcription. |
| unlimited | boolean | — | Indicates whether usage is unlimited. |
No examples provided.
my_numbers_list ~126
Returns a paginated list of phone numbers on the account. Results are limited to 25 records per page by default. Use `page` and `per_page` to navigate results.
| Name | Type | Req | Description |
|---|---|---|---|
| city_id | integer | — | City or rate center for filtering. |
| label | string | — | Label for filtering. |
| label_present | boolean | — | Indicates whether to return only numbers with or without labels. |
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| search | string | — | Phone number or partial number for filtering. |
| Name | Type | Req | Description |
|---|---|---|---|
| doc_types | array | yes | Documents required to activate phone numbers. |
| items | array | yes | List of phone numbers on the account. |
| pagination | object | yes | — |
No examples provided.
my_numbers_papers_upload ~145
Uploads a document for one or more phone numbers. Uploaded files must meet the following requirements: - Allowed formats: PNG, JPG, JPEG, TIFF, BMP, or PDF - Maximum file size: 10 MB - Files can't be password protected - PDF files must not contain digital signatures
| Name | Type | Req | Description |
|---|---|---|---|
| did_ids | string | — | List of phone number IDs. |
| doc_attachment | string | — | Document file to upload. |
| doc_id | integer | — | Specifies the type of document required to activate the phone number. Possible values are: `1` - Proof of identity, `2` - Proof of address, `3` - Proof of business registration. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | array | yes | — |
No examples provided.
my_numbers_sms_update ~45
Enables or disables inbound SMS support for a phone number.
| Name | Type | Req | Description |
|---|---|---|---|
| id | integer | — | Phone number ID. |
| sms_enabled | boolean | — | Indicates whether inbound SMS is enabled. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | Indicates whether the request succeeded. |
No examples provided.
my_numbers_update ~105
Updates a phone number.
| Name | Type | Req | Description |
|---|---|---|---|
| call_recording_enabled | boolean | — | Indicates whether call recording is enabled. |
| call_status_url | string | — | Callback URL for call status updates. |
| id | integer | yes | Phone number ID. |
| sms_relay_url | string | — | Callback URL for inbound messages. Set to `null` to remove routing. |
| transcription_enabled | boolean | — | Indicates whether transcription is enabled. |
| transcription_threshold | integer | — | Transcription threshold in seconds. |
| Name | Type | Req | Description |
|---|---|---|---|
| activation_fee | string | yes | One-time activation fee in USD. |
| added | string | yes | Date and time the phone number was purchased in ISO 8601 format. |
| call_recording_enabled | boolean | yes | Indicates whether call recording is enabled. |
| call_status_url | string|null | — | Callback URL for call status updates. |
| channels | integer | yes | Maximum number of concurrent inbound calls. |
| city | string | yes | City or rate center where the phone number originates. |
| cnam | boolean|null | yes | Indicates whether CNAM is enabled. |
| country | string | yes | Country where the phone number originates. |
| country_short_name | string | yes | Two-letter ISO country code. |
| destination | array | yes | Inbound call destinations set for the phone number. |
| documents | array | yes | Uploaded documents for the phone number. |
| domestic_cli | boolean | yes | Indicates whether the number can be used as the Caller ID for local calls. |
| free_min | integer | — | Number of free inbound minutes. |
| id | integer | yes | Phone number ID. |
| label | string|null | yes | Label assigned to the phone number. |
| monthly_fee | string | yes | Monthly fee in USD. |
| number | string | yes | Phone number. |
| paid_until | string | yes | Date until which the number is paid. |
| per_min | string | yes | Price per inbound minute in USD. |
| require_docs | array | yes | Documents required to activate the phone number. |
| seconds | string | yes | Total inbound call duration in seconds for current month. |
| sms_enabled | boolean | yes | Indicates whether SMS is enabled. |
| sms_relay_url | string|null | yes | Callback URL for inbound SMS and MMS messages. |
| state | string|null | — | State where the phone number originates. For non-US numbers, this field may be null. |
| status | string | yes | Phone number status. `active` means the number can receive and place calls; `inactive` means it cannot. |
| transcription_enabled | boolean | yes | Indicates whether transcription is enabled. |
| transcription_threshold | integer | yes | Minimum call duration in seconds to trigger transcription. |
| unlimited | boolean | — | Indicates whether usage is unlimited. |
No examples provided.
number_validator_create_bulk ~113
Returns details for multiple phone numbers. If `async` is true, returns a token to poll for results.
| Name | Type | Req | Description |
|---|---|---|---|
| async | boolean | yes | 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 vali… |
| force | boolean | yes | Force |
| phone_numbers | array | yes | List of phone numbers to get detailed information about. |
| type | string | yes | — |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.