Wavix

Name: Wavix
Author: Wavix

by io.github.Wavix

Server Details

Hosted MCP server for the Wavix telecom platform: SMS, voice, 2FA, SIP, numbers, 10DLC, CDRs.

Status: Healthy
Last Tested: 2026-05-25 12:31
Transport: Streamable HTTP
URL
Repository: Wavix/wavix-mcp-server
GitHub Stars: 0

Glama MCP Gateway

Connect through Glama MCP Gateway for full control over tool access and complete visibility into every call.

MCP client

Glama

MCP server

Full call logging

Every tool call is logged with complete inputs and outputs, so you can debug issues and audit what your agents are doing.

Tool access control

Enable or disable individual tools per connector, so you decide what your agents can and cannot do.

Managed credentials

Glama handles OAuth flows, token storage, and automatic rotation, so credentials never expire on your clients.

Usage analytics

See which tools your agents call, how often, and when, so you can understand usage patterns and catch anomalies.

100% free. Your data is private.

Tool Definition Quality

Score is being calculated. Check back soon.

Available Tools

122 tools

api_keys_activateInspect

Activates an API key. Once activated, the API key can be used for authentication again.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	API key ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No

api_keys_createInspect

Creates an API key. Optional IP restrictions can be configured to limit access.

ParametersJSON Schema

Name	Required	Description
`calls`	No	Access call records and active calls, and control live call actions such as starting, answering, ending, audio playback, DTMF, streaming, and transcription requests.
`label`	No	API key label.
`trunks`	No	View, create, update, and delete SIP trunks and their settings.
`two_fa`	No	View 2FA service details and verification logs, trigger OTPs by voice or SMS, and validate verification codes.
`account`	No	View and update account profile information and timezone.
`billing`	No	Access invoices, balance, payment methods, usage reports, and billing settings, including payment method updates.
`numbers`	No	View, buy, release, and configure phone numbers, browse inventory, and manage the cart.
`messages`	No	Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs.
`webhooks`	No	List, create, and delete webhooks.
`campaigns`	No	View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links.
`is_active`	No	Indicates whether the API key should be activated upon creation.
`validator`	No	View number validation results and trigger single or bulk validation or HLR lookup requests.
`embeddable`	No	Manage widget tokens, including listing, viewing, creating, updating, and deleting them.
`recordings`	No	List, download, and delete call recordings.
`subaccounts`	No	Manage subaccounts: list and view them, create, update, and suspend them.
`permitted_ips`	No	List of permitted IP addresses for this API key. Each must be a valid IPv4 address. Required when `is_restriction` is true.
`is_restriction`	No	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`	No	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 the key has no access.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	Yes	API key ID.
`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.
`label`	Yes	API key label.
`value`	Yes	API key value.
`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.
`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.
`numbers`	Yes	View, buy, release, and configure phone numbers, browse inventory, and manage the cart.
`messages`	Yes	Access message history and Sender IDs, send messages, manage opt-outs, and create or delete Sender IDs.
`webhooks`	Yes	List, create, and delete webhooks.
`campaigns`	Yes	View campaign analytics and Sender ID or Brand status, schedule bulk voice or SMS campaigns, register Brands, and create short links.
`is_active`	Yes	Indicates whether the API key is active.
`validator`	Yes	View number validation results and trigger single or bulk validation or HLR lookup requests.
`created_at`	Yes	Creation date and time in ISO 8601 format.
`embeddable`	Yes	Manage widget tokens, including listing, viewing, creating, updating, and deleting them.
`recordings`	Yes	List, download, and delete call recordings.
`subaccounts`	Yes	Manage subaccounts: list and view them, create, update, and suspend them.
`last_used_at`	Yes	Timestamp of the most recent authenticated request made with this key.
`permitted_ips`	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.
`is_restriction`	Yes	Indicates whether IP restrictions are enabled. When enabled, the API key works only from IP addresses in `permitted_ips`.
`is_scopes_enabled`	Yes	When `true`, the key is restricted to the permissions defined in the scope fields below. When `false`, the key has full access.

api_keys_deactivateInspect

Deactivates an API key. Once deactivated, the API key cannot be used for authentication.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	API key ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No

api_keys_deleteInspect

Deletes an API key. This action is permanent.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	API key ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No

api_keys_listInspect

Returns a list of API keys.

ParametersJSON Schema

Name	Required	Description	Default
`label`	No	Label to filter API keys. Partial match supported.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

billing_invoices_downloadInspect

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.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes

Output Schema

ParametersJSON Schema

Name	Required	Description
No output parameters

billing_invoices_listInspect

Returns a paginated list of financial statements.

ParametersJSON Schema

Name	Required	Description	Default
`page`	No	Page number to retrieve.
`per_page`	No	Number of records per page.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

billing_transactions_listInspect

Returns a paginated list of financial transactions.

ParametersJSON Schema

Name	Required	Description
`page`	No	Page number to retrieve.
`type`	No	Filter by transaction type.
`to_date`	Yes	End date in `YYYY-MM-DD` format.
`payments`	No	Indicates whether to include account top-ups only.
`per_page`	No	Number of records per page.
`from_date`	Yes	Start date in `YYYY-MM-DD` format.
`details_contains`	No	Transaction details for filtering.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

buy_cities_listInspect

Returns a list of cities for countries where has_provinces_or_states is false.

ParametersJSON Schema

Name	Required	Description	Default
`country`	Yes	Country ID.
`text_enabled_only`	No	Indicates whether to return only cities with text-enabled numbers.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

buy_countries_listInspect

Returns a list of countries where phone numbers are available.

ParametersJSON Schema

Name	Required	Description	Default
`text_enabled_only`	No	Indicates whether to return only countries with text-enabled phone numbers.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

buy_numbers_listInspect

Returns a paginated list of phone numbers available for purchase.

ParametersJSON Schema

Name	Required	Description
`city`	Yes	City ID.
`page`	No	Page number to retrieve.
`country`	Yes	Country ID.
`per_page`	No	Number of records per page.
`text_enabled_only`	No	Indicates whether to return only text-enabled phone numbers.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

buy_region_cities_listInspect

Returns a list of cities in the specified region for countries where has_provinces_or_states is true.

ParametersJSON Schema

Name	Required	Description
`region`	Yes	Region ID.
`country`	Yes	Country ID.
`text_enabled_only`	No	Indicates whether to return only cities with text-enabled numbers.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

buy_regions_listInspect

Returns a list of regions (states or provinces) for countries where has_provinces_or_states is true.

ParametersJSON Schema

Name	Required	Description	Default
`country`	Yes	Country ID.
`text_enabled_only`	No	Indicates whether to return only regions with text-enabled numbers.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

call_control_answerInspect

Answers an inbound call. Optionally initiate media streaming upon answering.

ParametersJSON Schema

Name	Required	Description
`uuid`	Yes	Call ID.
`stream_url`	No	WebSocket URL to stream the call.
`stream_type`	No
`call_recording`	No	Indicates whether the call should be recorded.
`stream_channel`	No
`call_transcription`	No	Indicates whether the call should be transcribed after it ends.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No	Indicates whether the request was successful.

call_control_audio_playInspect

Plays audio in an active call.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Call ID.
`audio_file`	Yes	URL of the audio file to play

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No	Indicates whether the request was successful.

call_control_audio_stopInspect

Stops audio playback in an active call.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Call ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No	Indicates whether the request was successful.

call_control_collectInspect

Collects DTMF input in an active call.

ParametersJSON Schema

Name	Required	Description
`uuid`	Yes	Call ID.
`prompt`	No	Prompt to play before collecting digits. Play a prerecorded audio file or use Wavix Text-To-Speech.
`timeout`	No	Timeout for digit collection in seconds.
`max_digits`	No	Maximum number of digits to collect.
`max_attempts`	No	Maximum number of attempts.
`termination_character`	No	DTMF character that ends input collection.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No	Indicates whether the request was successful.

call_control_createInspect

Starts an outbound call.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	Destination number in E.164 format
`tag`	No	Call metadata
`from`	Yes	Caller ID. Must be an active or verified phone number in your account.
`timeout`	No	The ring timeout, in seconds, before the call is considered unanswered.
`recording`	No	Specifies whether to record the call
`callback_url`	Yes	The callback URL where Wavix sends the call status updates
`voicemail_detection`	No	Specifies whether the AMD is turned on for the call

Output Schema

ParametersJSON Schema

Name	Required	Description
`to`	No	Destination number
`tag`	No	Call metadata
`from`	No	Caller ID
`uuid`	No	Call ID
`direction`	No	Call direction - inbound or outbound
`event_time`	No	Date and time of the latest event
`event_type`	No	The latest call event
`call_started`	No	Date and time when the call started
`call_answered`	No	Date and time when the call was answered
`event_payload`	No	Event-specific data
`call_completed`	No	Date and time when the call ended
`machine_detected`	No	Indicates whether the call was answered by an answering machine

call_control_deleteInspect

Ends an active call.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Call ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No	Indicates whether the request was successful.

call_control_getInspect

Returns a call.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Call ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`call`	Yes
`success`	Yes	Indicates whether the request was successful.

call_control_listInspect

Returns a list of active calls.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`calls`	Yes	List of calls
`success`	Yes	Indicates whether the request was successful.

call_control_streams_createInspect

Starts call media streaming.

ParametersJSON Schema

Name	Required	Description
`uuid`	Yes	Call ID.
`stream_url`	Yes	WebSocket URL for call streaming
`stream_type`	Yes
`stream_channel`	Yes

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No	Indicates that the request was successful
`stream_id`	No	Stream ID

call_control_streams_deleteInspect

Stops call media streaming.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Call ID.
`stream_uuid`	Yes	Stream ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No	Indicates whether the request was successful.

call_control_updateInspect

Updates an active call. Only the tag field can be modified.

ParametersJSON Schema

Name	Required	Description	Default
`tag`	Yes	Call metadata.
`uuid`	Yes	Call ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	Yes	Indicates whether the request was successful.

call_recording_deleteInspect

Deletes a call recording.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	Recording ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No	Indicates whether the request succeeded.

call_recording_getInspect

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.

ParametersJSON Schema

Name	Required	Description	Default
`call_uuid`	Yes

Output Schema

ParametersJSON Schema

Name	Required	Description
No output parameters

call_recording_listInspect

Returns a paginated list of call recordings.

ParametersJSON Schema

Name	Required	Description
`to`	No	Destination phone number for filtering. Full or partial input accepted.
`from`	No	Originating phone number for filtering. Full or partial input accepted.
`page`	No	Page number to retrieve.
`to_date`	No	End date in `YYYY-MM-DD` format.
`per_page`	No	Number of records per page.
`call_uuid`	No	Call ID for filtering.
`from_date`	No	Start date in `YYYY-MM-DD` format.
`sip_trunks`	No	List of SIP trunk logins to filter outbound calls.

Output Schema

ParametersJSON Schema

Name	Required	Description
`invalid`	No	An invalid recording filter response
`pagination`	No
`recordings`	No

call_webhooks_createInspect

Creates a call webhook. Wavix sends POST callbacks for on-call and post-call events.

ParametersJSON Schema

Name	Required	Description	Default
`url`	Yes	Webhook URL to send call events to.
`event_type`	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 disposition, duration, and cost.

Output Schema

ParametersJSON Schema

Name	Required	Description
`url`	Yes	Webhook URL
`success`	Yes
`event_type`	Yes	Type of call events

call_webhooks_deleteInspect

Deletes a call webhook.

ParametersJSON Schema

Name	Required	Description	Default
`event_type`	Yes	Use `post-call` to stop receiving post-call callbacks. Use `on-call` to stop receiving real-time call status updates.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No

call_webhooks_listInspect

Returns a list of configured call webhooks. Wavix sends POST callbacks for on-call and post-call events.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes	List of call webhooks configured for the phone number.

cart_addInspect

Adds phone numbers to the cart.

ParametersJSON Schema

Name	Required	Description	Default
`ids`	Yes	List of phone numbers to add to the cart.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

cart_checkoutInspect

Checks out the cart. Activation and monthly fees are deducted from the account balance.

ParametersJSON Schema

Name	Required	Description	Default
`ids`	Yes	List of phone numbers to check out from the cart.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

cart_getInspect

Returns the cart.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

cart_removeInspect

Removes phone numbers from the cart.

ParametersJSON Schema

Name	Required	Description	Default
`ids`	Yes	List of phone numbers to remove.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

cdrs_getInspect

Returns call details.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Call ID.
`show_transcription`	No	Indicates whether to include transcription.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

cdrs_listInspect

Returns a paginated list of CDRs.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	End date in `YYYY-MM-DD` format.
`from`	Yes	Start date in `YYYY-MM-DD` format.
`page`	No	Page number to retrieve.
`type`	Yes	Call direction to filter results. Allowed values: `placed`, `received`.
`uuid`	No	Call ID to filter results.
`per_page`	No	Number of records per page.
`sip_trunk`	No	SIP trunk login to filter outbound calls. Ignored for inbound calls.
`to_search`	No	Destination phone number for filtering. Full or partial input accepted.
`disposition`	No	Call disposition to filter results. Allowed values: `answered`, `busy`, `rejected`, `failed`, `all`.
`from_search`	No	Originating phone number for filtering. Full or partial input accepted.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

cdrs_list_allInspect

Returns CDRs in NDJSON format for bulk export.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	End date in `YYYY-MM-DD` format.
`from`	Yes	Start date in `YYYY-MM-DD` format.
`page`	No	Page number to retrieve.
`type`	Yes	Call direction to filter results. Allowed values: `placed`, `received`.
`uuid`	No	Call ID to filter results.
`per_page`	No	Number of records per page.
`sip_trunk`	No	SIP trunk login to filter outbound calls. Ignored for inbound calls.
`to_search`	No	Destination phone number for filtering. Full or partial input accepted.
`disposition`	No	Call disposition to filter results. Allowed values: `answered`, `busy`, `rejected`, `failed`, `all`.
`from_search`	No	Originating phone number for filtering. Full or partial input accepted.

cdrs_retranscribeInspect

Transcribes a recorded call.

ParametersJSON Schema

Name	Required	Description
`uuid`	Yes	Call ID.
`language`	No	Language.
`webhook_url`	No	Webhook URL to receive status updates.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	Yes	Indicates whether the request was successful.

cdrs_searchInspect

Searches call transcriptions for specific keywords or phrases.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	End date for call search in `YYYY-MM-DD` format.
`from`	Yes	Start date for call search in `YYYY-MM-DD` format.
`page`	Yes	Page number to retrieve.
`type`	Yes	Search transcriptions by call type.
`uuid`	No	Call ID.
`per_page`	Yes	Number of records per page.
`sip_trunk`	No	SIP trunk login to filter outbound calls. Ignored for inbound calls.
`to_search`	No	Destination phone number to filter results. Accepts full or partial number.
`disposition`	No
`from_search`	No	Originating phone number to filter results. Accepts full or partial number.
`min_duration`	No	Minimum call duration in seconds.
`transcription`	No

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

cdrs_transcription_getInspect

Returns a recorded call transcription.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Call ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

link_shortener_createInspect

Creates a short link.

ParametersJSON Schema

Name	Required	Description
`link`	Yes	Target URL to shorten.
`phone`	No	Phone number for the short link.
`fallback_url`	No	Fallback URL for expired or invalid links.
`utm_campaign`	No	UTM campaign name for tracking insights.
`expiration_time`	No	Expiration date and time in ISO 8601 format.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

link_shortener_metrics_listInspect

Returns short link metrics.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	End date in `YYYY-MM-DD` format.
`from`	Yes	Start date in `YYYY-MM-DD` format.
`page`	No	Page number to retrieve.
`phone`	No	Phone number for filtering.
`per_page`	No	Number of records per page.
`utm_campaign`	No	UTM campaign name for filtering.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

my_numbers_deleteInspect

Releases phone numbers back to stock.

ParametersJSON Schema

Name	Required	Description	Default
`ids`	No	List of phone number IDs to release.
`dids`	No	List of phone numbers to release.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

my_numbers_destinations_updateInspect

Updates inbound call routing for phone numbers.

ParametersJSON Schema

Name	Required	Description
`ids`	Yes	List of phone number IDs to update.
`destinations`	Yes	Inbound call destinations to apply.
`sms_relay_url`	Yes	Callback URL for inbound SMS and MMS messages.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

my_numbers_getInspect

Returns a phone number.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	Phone number ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Phone number ID.
`city`	Yes	City or rate center where the phone number originates.
`cnam`	Yes	Indicates whether CNAM is enabled.
`added`	Yes	Date and time the phone number was purchased in ISO 8601 format.
`label`	Yes	Label assigned to the phone number.
`state`	No	State where the phone number originates. For non-US numbers, this field may be null.
`number`	Yes	Phone number.
`status`	Yes	Phone number status. `active` means the number can receive and place calls; `inactive` means it cannot.
`country`	Yes	Country where the phone number originates.
`per_min`	Yes	Price per inbound minute in USD.
`seconds`	Yes	Total inbound call duration in seconds for current month.
`channels`	Yes	Maximum number of concurrent inbound calls.
`free_min`	No	Number of free inbound minutes.
`documents`	Yes	Uploaded documents for the phone number.
`unlimited`	No	Indicates whether usage is unlimited.
`paid_until`	Yes	Date until which the number is paid.
`destination`	Yes	Inbound call destinations set for the phone number.
`monthly_fee`	Yes	Monthly fee in USD.
`sms_enabled`	Yes	Indicates whether SMS is enabled.
`domestic_cli`	Yes	Indicates whether the number can be used as the Caller ID for local calls.
`require_docs`	Yes	Documents required to activate the phone number.
`sms_relay_url`	Yes	Callback URL for inbound SMS and MMS messages.
`activation_fee`	Yes	One-time activation fee in USD.
`call_status_url`	No	Callback URL for call status updates.
`country_short_name`	Yes	Two-letter ISO country code.
`transcription_enabled`	Yes	Indicates whether transcription is enabled.
`call_recording_enabled`	Yes	Indicates whether call recording is enabled.
`transcription_threshold`	Yes	Minimum call duration in seconds to trigger transcription.

my_numbers_listInspect

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.

ParametersJSON Schema

Name	Required	Description
`page`	No	Page number to retrieve.
`label`	No	Label for filtering.
`search`	No	Phone number or partial number for filtering.
`city_id`	No	City or rate center for filtering.
`per_page`	No	Number of records per page.
`label_present`	No	Indicates whether to return only numbers with or without labels.

Output Schema

ParametersJSON Schema

Name	Required	Description
`items`	Yes	List of phone numbers on the account.
`doc_types`	Yes	Documents required to activate phone numbers.
`pagination`	Yes

my_numbers_papers_uploadInspect

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

ParametersJSON Schema

Name	Required	Description
`doc_id`	No	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.
`did_ids`	No	List of phone number IDs.
`doc_attachment`	No	Document file to upload.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

my_numbers_sms_updateInspect

Enables or disables inbound SMS support for a phone number.

ParametersJSON Schema

Name	Required	Description	Default
`id`	No	Phone number ID.
`sms_enabled`	No	Indicates whether inbound SMS is enabled.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No	Indicates whether the request succeeded.

my_numbers_updateInspect

Updates a phone number.

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Phone number ID.
`sms_relay_url`	No	Callback URL for inbound messages. Set to `null` to remove routing.
`call_status_url`	No	Callback URL for call status updates.
`transcription_enabled`	No	Indicates whether transcription is enabled.
`call_recording_enabled`	No	Indicates whether call recording is enabled.
`transcription_threshold`	No	Transcription threshold in seconds.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Phone number ID.
`city`	Yes	City or rate center where the phone number originates.
`cnam`	Yes	Indicates whether CNAM is enabled.
`added`	Yes	Date and time the phone number was purchased in ISO 8601 format.
`label`	Yes	Label assigned to the phone number.
`state`	No	State where the phone number originates. For non-US numbers, this field may be null.
`number`	Yes	Phone number.
`status`	Yes	Phone number status. `active` means the number can receive and place calls; `inactive` means it cannot.
`country`	Yes	Country where the phone number originates.
`per_min`	Yes	Price per inbound minute in USD.
`seconds`	Yes	Total inbound call duration in seconds for current month.
`channels`	Yes	Maximum number of concurrent inbound calls.
`free_min`	No	Number of free inbound minutes.
`documents`	Yes	Uploaded documents for the phone number.
`unlimited`	No	Indicates whether usage is unlimited.
`paid_until`	Yes	Date until which the number is paid.
`destination`	Yes	Inbound call destinations set for the phone number.
`monthly_fee`	Yes	Monthly fee in USD.
`sms_enabled`	Yes	Indicates whether SMS is enabled.
`domestic_cli`	Yes	Indicates whether the number can be used as the Caller ID for local calls.
`require_docs`	Yes	Documents required to activate the phone number.
`sms_relay_url`	Yes	Callback URL for inbound SMS and MMS messages.
`activation_fee`	Yes	One-time activation fee in USD.
`call_status_url`	No	Callback URL for call status updates.
`country_short_name`	Yes	Two-letter ISO country code.
`transcription_enabled`	Yes	Indicates whether transcription is enabled.
`call_recording_enabled`	Yes	Indicates whether call recording is enabled.
`transcription_threshold`	Yes	Minimum call duration in seconds to trigger transcription.

number_validator_create_bulkInspect

Returns details for multiple phone numbers. If async is true, returns a token to poll for results.

ParametersJSON Schema

Name	Required	Description
`type`	Yes
`async`	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 validation results directly.
`force`	Yes	Force
`phone_numbers`	Yes	List of phone numbers to get detailed information about.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

number_validator_getInspect

Returns details for a phone number.

ParametersJSON Schema

Name	Required	Description	Default
`type`	Yes	Validation type.
`phone_number`	Yes	Phone number in E.164 format or without "+".

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

number_validator_results_getInspect

Returns asynchronous validation results.

ParametersJSON Schema

Name	Required	Description	Default
`request_id`	Yes	Request ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

profile_config_getInspect

Returns the account balance and configuration details.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

profile_getInspect

Returns the account profile and billing details.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

profile_updateInspect

Updates the account profile and billing details.

ParametersJSON Schema

Name	Required	Description
`phone`	No	Account owner's phone number
`contacts`	No	Email associated with the account.
`job_title`	No	Account owner's job title.
`last_name`	No	Account owner's last name.
`time_zone`	No	Timezone configured on the account.
`first_name`	No	Account owner's first name.
`company_info`	No
`dlr_relay_url`	No	Callback URL to forward message delivery reports (DLRs) to.
`sms_relay_url`	No	Callback URL to forward inbound SMS to.
`additional_info`	No	Additional information associated with the account.
`default_short_link_endpoint`	No	Default short link endpoint.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sip_trunks_createInspect

Creates a SIP trunk.

ParametersJSON Schema

Name	Required	Description
`label`	Yes	User-defined name of the SIP trunk
`callerid`	Yes	Caller ID associated with the SIP trunk. Must be an active or verified number on your account.
`password`	Yes	Password set for the SIP trunk. Use a strong password to help keep your SIP trunk secure.
`call_limit`	No	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`.
`cost_limit`	Yes	Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.
`allowed_ips`	No	A list of public static IP addresses allowed to register with the SIP trunk
`ip_restrict`	Yes	Indicates whether SIP trunk registration is allowed from only specific public static IP addresses. When set to `true`, the `allowed_ips` parameter must be provided.
`host_request`	No	For SIP trunks with IP authentication, includes the SIP endpoint public static IP address and the status of the authentication request. Wavix authenticates all SIP traffic originating from this IP address.
`max_channels`	No	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`.
`rewrite_cond`	No	Number of leading digits to automatically remove from each dialed phone number
`call_restrict`	Yes	Indicates whether a maximum call duration limit is enforced for the SIP trunk
`max_call_cost`	No	Maximum cost for an outbound call, in USD
`rewrite_prefix`	No	Digits to automatically prepend to each dialed phone number
`didinfo_enabled`	Yes	Indicates whether inbound calls include dialed number information in the `To` header of SIP INVITE requests
`encrypted_media`	No
`rewrite_enabled`	Yes	Indicates whether a custom dial plan is activated for the SIP trunk
`multiple_numbers`	No	Indicates whether any active or verified phone number in your account can be used as the Caller ID for the SIP trunk
`channels_restrict`	Yes	Indicates whether a limit on the number of concurrent outbound calls is enforced for the SIP trunk
`transcription_enabled`	Yes	Indicates whether automatic call transcription is enabled for the SIP trunk. Available for `Flex Pro` customers only.
`call_recording_enabled`	No	Indicates whether outbound call recording is enabled for the SIP trunk
`transcription_threshold`	Yes	Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds. Available for `Flex Pro` customers only.
`machine_detection_enabled`	No	Indicates whether automatic voicemail detection is enabled for the SIP trunk. Available for `Flex Pro` customers only.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sip_trunks_deleteInspect

Deletes a SIP trunk.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	SIP trunk ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sip_trunks_getInspect

Returns a SIP trunk configuration.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	SIP trunk ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sip_trunks_listInspect

Returns a paginated list of SIP trunks. Results are limited to 25 records per page by default. Use page and per_page to navigate results.

ParametersJSON Schema

Name	Required	Description	Default
`page`	No	Page number to retrieve.
`per_page`	No	Number of records per page.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sip_trunks_updateInspect

Updates a SIP trunk configuration.

ParametersJSON Schema

Name	Required	Description
`id`	Yes	SIP trunk ID.
`label`	Yes	User-defined name of the SIP trunk
`callerid`	Yes	Caller ID associated with the SIP trunk. Must be an active or verified number on your account.
`password`	Yes	Password set for the SIP trunk. Use a strong password to help keep your SIP trunk secure.
`call_limit`	No	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`.
`cost_limit`	Yes	Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk.
`allowed_ips`	No	A list of public static IP addresses allowed to register with the SIP trunk
`ip_restrict`	Yes	Indicates whether SIP trunk registration is allowed from only specific public static IP addresses. When set to `true`, the `allowed_ips` parameter must be provided.
`host_request`	No	For SIP trunks with IP authentication, includes the SIP endpoint public static IP address and the status of the authentication request. Wavix authenticates all SIP traffic originating from this IP address.
`max_channels`	No	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`.
`rewrite_cond`	No	Number of leading digits to automatically remove from each dialed phone number
`call_restrict`	Yes	Indicates whether a maximum call duration limit is enforced for the SIP trunk
`max_call_cost`	No	Maximum cost for an outbound call, in USD
`rewrite_prefix`	No	Digits to automatically prepend to each dialed phone number
`didinfo_enabled`	Yes	Indicates whether inbound calls include dialed number information in the `To` header of SIP INVITE requests
`encrypted_media`	No
`rewrite_enabled`	Yes	Indicates whether a custom dial plan is activated for the SIP trunk
`multiple_numbers`	No	Indicates whether any active or verified phone number in your account can be used as the Caller ID for the SIP trunk
`channels_restrict`	Yes	Indicates whether a limit on the number of concurrent outbound calls is enforced for the SIP trunk
`transcription_enabled`	Yes	Indicates whether automatic call transcription is enabled for the SIP trunk. Available for `Flex Pro` customers only.
`call_recording_enabled`	No	Indicates whether outbound call recording is enabled for the SIP trunk
`transcription_threshold`	Yes	Transcriptions will be generated for calls that meet or exceed the specified minimal call duration threshold, in seconds. Available for `Flex Pro` customers only.
`machine_detection_enabled`	No	Indicates whether automatic voicemail detection is enabled for the SIP trunk. Available for `Flex Pro` customers only.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sms_and_mms_messages_getInspect

Returns a message.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	Message ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sms_and_mms_messages_listInspect

Returns a paginated list of SMS and MMS messages.

ParametersJSON Schema

Name	Required	Description
`to`	No	Recipient phone number. For `outbound` messages, the destination phone number; for `inbound` messages, an SMS-enabled number on the Wavix platform.
`tag`	No	Tag for filtering. Supported for outbound messages only.
`from`	No	Message sender. For `outbound` messages, the Sender ID used to send the message; for `inbound` messages, the originating phone number.
`page`	No	Page number to retrieve.
`type`	Yes	Message direction for filtering. Allowed values are `inbound`, `outbound`.
`status`	No	Message delivery status for filtering.
`per_page`	No	Number of records per page.
`sent_after`	No	Start date in `YYYY-MM-DD` format.
`sent_before`	No	End date in `YYYY-MM-DD` format.
`message_type`	No	Message type for filtering. Allowed values are `sms`, `mms`.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sms_and_mms_messages_list_allInspect

Returns SMS and MMS messages in newline-delimited JSON (NDJSON) format.

ParametersJSON Schema

Name	Required	Description
`to`	No	Message recipient. For `outbound` messages, the destination phone number; for `inbound` messages, the SMS-enabled number that received the message.
`tag`	No	Tag for filtering. Supported for outbound messages only.
`from`	No	Message sender. For `outbound` messages, the Sender ID used to send the message; for `inbound` messages, the originating phone number.
`type`	Yes	Message direction for filtering. Allowed values are `inbound`, `outbound`.
`status`	No	Message delivery status for filtering.
`sent_after`	No	Start date in `YYYY-MM-DDTHH:MM:SS` format.
`sent_before`	No	End date in `YYYY-MM-DDTHH:MM:SS` format.
`message_type`	No	Message type for filtering. Allowed values are `sms`, `mms`.

sms_and_mms_messages_sendInspect

Sends SMS or MMS messages. MMS is supported for U.S. numbers only. Rate limit: 20 messages per phone number in 24 hours.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	Recipient phone number.
`tag`	No	Tag to group messages, such as for a specific campaign.
`from`	Yes	Sender ID. Numeric or alphanumeric.
`validity`	No	Message validity period in seconds. Delivery attempts stop after this period expires.
`callback_url`	No	Callback URL for delivery reports.
`message_body`	Yes

Output Schema

ParametersJSON Schema

Name	Required	Description
`to`	No	Recipient phone number.
`mcc`	No	Mobile country code.
`mnc`	No	Mobile network code.
`tag`	No	Message tag.
`from`	No	Sender ID.
`charge`	No	Total charge for the message in USD.
`status`	No	Message status.
`sent_at`	No	Date and time the message was sent in ISO 8601 format.
`segments`	No	Number of SMS segments. Always 1 for MMS.
`direction`	No	Message direction. Possible values are `outbound`, `inbound`.
`message_id`	No	Message ID.
`carrier_fees`	No	Mobile carrier fees in USD.
`delivered_at`	No	Date and time the message was delivered in ISO 8601 format.
`message_body`	No
`message_type`	No	Message type.
`submitted_at`	No	Date and time the message was submitted in ISO 8601 format.
`error_message`	No	Error message.

sms_and_mms_opt_outs_createInspect

Creates an opt-out for a Sender ID, 10DLC campaign, or all outbound messages.

ParametersJSON Schema

Name	Required	Description	Default
`opt_out`	Yes

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sms_and_mms_opt_outs_listInspect

Returns a paginated list of opted-out phone numbers. Results are limited to 25 records per page by default. Use page and per_page to navigate results.

ParametersJSON Schema

Name	Required	Description
`page`	No	Page number to retrieve.
`per_page`	No	Number of records per page.
`sender_id`	No	Sender ID for filtering.
`campaign_id`	No	10DLC campaign for filtering.
`created_after`	No	Start date in `YYYY-MM-DD` format.
`created_before`	No	End date in `YYYY-MM-DD` format.

Output Schema

ParametersJSON Schema

Name	Required	Description
`items`	No
`pagination`	No

sms_and_mms_sender_ids_createInspect

Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US.

ParametersJSON Schema

Name	Required	Description
`type`	Yes	Sender ID type.
`samples`	No	Message samples.
`usecase`	Yes	Use case for the Sender ID
`countries`	Yes	Two-letter ISO country codes where the Sender ID is allowlisted.
`sender_id`	Yes	Sender ID name. Can be either an alphanumeric string or a phone number.
`monthly_volume`	No	Expected monthly volume.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sms_and_mms_sender_ids_deleteInspect

Deletes a Sender ID.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	Sender ID ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sms_and_mms_sender_ids_getInspect

Returns a Sender ID.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	Sender ID ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

sms_and_mms_sender_ids_listInspect

Returns a list of Sender IDs.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

speech_analytics_createInspect

Uploads an audio file for transcription. Wavix sends a POST callback to the specified callback URL when the transcription is complete.

Callback body:

   {
        "request_id": "e865ea07-25af-4fdd-876e-04b0d41d5ebd",
        "status": "completed",
        "error": null
   }

request_id: Transcription request ID.
status: Operation status. Possible values are completed, failed. completed indicates successful transcription; failed indicates an error. - error: Error description. Value is null if the transcription was successful.

ParametersJSON Schema

Name	Required	Description
`file`	No	Binary file content. Maximum size is 25 MB. Wavix supports WAV, MP3, and MP4 stereo formats.
`insights`	No	Indicates whether to enable insights generation.
`callback_url`	No	Callback URL for transcription status updates.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

speech_analytics_file_getInspect

Get a download URL for a speech-analytics audio file.

Returns {download_url, content_type, status_code, note} instead of the binary audio stream (WAV/MP3/MP4). Fetch download_url to obtain the file.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes

Output Schema

ParametersJSON Schema

Name	Required	Description
No output parameters

speech_analytics_getInspect

Returns a transcription.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Transcription request ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

speech_analytics_retranscribeInspect

Retranscribes an uploaded file.

ParametersJSON Schema

Name	Required	Description
`uuid`	Yes	Transcription request ID.
`insights`	No	Indicates whether to enable insights generation.
`callback_url`	No	Callback URL for transcription status updates.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No	Indicates whether the request was successful.

sub_accounts_createInspect

Creates a sub-account.

ParametersJSON Schema

Name	Required	Description	Default
`name`	Yes	Sub-account name.
`default_destinations`	No	Default webhook URLs for inbound messages and delivery reports.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Sub-account ID.
`name`	Yes	Sub-account name.
`status`	Yes	Sub-account status.
`api_key`	Yes	Sub-account API key.
`created_at`	Yes	Date and time the sub-account was created in ISO 8601 format.
`master_organization`	Yes	Master account ID.
`default_destinations`	Yes	Default webhook URLs for inbound messages and delivery reports.

sub_accounts_getInspect

Returns a specific sub-account. Results are limited to 25 records per page by default. Use page and per_page to navigate results.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	Sub-account ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Sub-account ID.
`name`	Yes	Sub-account name.
`status`	Yes	Sub-account status.
`api_key`	Yes	Sub-account API key.
`created_at`	Yes	Date and time the sub-account was created in ISO 8601 format.
`master_organization`	Yes	Master account ID.
`default_destinations`	Yes	Default webhook URLs for inbound messages and delivery reports.

sub_accounts_listInspect

Returns a paginated list of sub-accounts. Results are limited to 25 records per page by default. Use page and per_page to navigate results.

ParametersJSON Schema

Name	Required	Description	Default
`status`	No	Account status to filter results.

Output Schema

ParametersJSON Schema

Name	Required	Description
`pagination`	No
`sub_organizations`	No

sub_accounts_transactions_listInspect

Returns a paginated list of transactions for a specific sub-account. Filter by date range and type. Results are paginated with 25 records per page by default. Use page and per_page to navigate results.

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Sub-account ID.
`page`	No	Page number to retrieve.
`type`	No	Transaction types to filter results.
`to_date`	Yes	End date in `YYYY-MM-DD` format.
`per_page`	No	Number of records per page.
`from_date`	Yes	Start date in `YYYY-MM-DD` format.

Output Schema

ParametersJSON Schema

Name	Required	Description
`pagination`	No
`transactions`	No

sub_accounts_updateInspect

Updates a sub-account's configuration.

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Sub-account ID.
`name`	Yes	Sub-account name.
`status`	No	Sub-account status.
`default_destinations`	No	Default webhook URLs for inbound messages and delivery reports.

Output Schema

ParametersJSON Schema

Name	Required	Description
`id`	Yes	Sub-account ID.
`name`	Yes	Sub-account name.
`status`	Yes	Sub-account status.
`api_key`	Yes	Sub-account API key.
`created_at`	Yes	Date and time the sub-account was created in ISO 8601 format.
`master_organization`	Yes	Master account ID.
`default_destinations`	Yes	Default webhook URLs for inbound messages and delivery reports.

ten_dlc_brand_appeals_createInspect

Submits an appeal for 10DLC brand identity verification. Provide any additional documentation to support the appeal. Use appeal_category to specify the appeal type:

VERIFY_TAX_ID — Use if the brand is UNVERIFIED due to a tax ID mismatch. Applies to private companies, public companies, non-profits, and government entities.
VERIFY_NON_PROFIT — Use if a non-profit brand is UNVERIFIED or VERIFIED but missing tax-exempt status.
VERIFY_GOVERNMENT — Use if a government brand is UNVERIFIED or VERIFIED but missing government entity status.

ParametersJSON Schema

Name	Required	Description
`brand_id`	Yes	Brand ID.
`evidence`	Yes	List of evidence IDs associated with the appeal.
`explanation`	No	Appeal comment or justification.
`appeal_categories`	Yes	List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_appeals_listInspect

Returns a list of brand identity verification appeals.

ParametersJSON Schema

Name	Required	Description	Default
`brand_id`	Yes	Brand ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_campaigns_createInspect

Registers a 10DLC Campaign.

ParametersJSON Schema

Name	Required	Description
`help`	Yes	Indicates whether the campaign has a help system (e.g. keyword: HELP, INFO) that subscribers can use or not.
`mock`	Yes	Indicates a mock Campaign. The mock Campaigns cannot be used to send production traffic
`name`	Yes	A user-defined Campaign name
`optin`	Yes	Indicates whether the campaign requires a subscriber to opt-in before receiving messages or not.
`optout`	Yes	Indicates whether the campaign has an opt-out system (e.g. keyword: STOP, QUIT) that subscribers can use or not.
`sample1`	Yes	Message sample
`sample2`	Yes	Message sample
`sample3`	Yes	Message sample
`sample4`	Yes	Message sample
`sample5`	Yes	Message sample
`usecase`	Yes	The Campaign use case
`brand_id`	Yes	Brand ID.
`age_gated`	Yes	Indicates whether the Campaign messages contain age-gated content
`description`	Yes	The Campaign description
`auto_renewal`	Yes	Indicates whether the Campaign should be automatically renewed
`help_message`	Yes	An acknowledgement to be sent when a HELP keyword is received
`help_keywords`	Yes	A comma-separated list of HELP keywords. The HELP keywords are case-insensitive.
`optin_message`	Yes	An acknowledgement to be sent when an OPT-IN keyword is received
`direct_lending`	Yes	Indicates whether the Campaign messages contain direct lending content
`embedded_links`	Yes	Indicates whether the Campaign messages contain embedded links
`optin_keywords`	Yes	A comma-separated list of OPT-IN keywords. The OPT-IN keywords are case-insensitive.
`optin_workflow`	Yes	The opt-in workflow - the process through which consumers opt-in to the Campaign
`optout_message`	Yes	An acknowledgement to be sent when an OPT-OUT keyword is received
`privacy_policy`	No	A link to the Campaign privacy policy
`embedded_phones`	Yes	Indicates whether the Campaign messages contain embedded phone numbers
`optout_keywords`	Yes	A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive.
`terms_conditions`	Yes	A link to the Campaign terms and conditions
`affiliate_marketing`	Yes	Indicates whether the Campaign is used for affiliate marketing
`embedded_link_sample`	Yes	An embedded link sample

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_campaigns_deleteInspect

Deletes a 10DLC Campaign. Associated phone numbers cannot be used as Sender IDs once the Campaign is deleted.

ParametersJSON Schema

Name	Required	Description	Default
`brand_id`	Yes	Brand ID.
`campaign_id`	Yes	Campaign ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_campaigns_getInspect

Returns a 10DLC Campaign.

ParametersJSON Schema

Name	Required	Description	Default
`brand_id`	Yes	Brand ID.
`campaign_id`	Yes	Campaign ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_campaigns_listInspect

Returns 10DLC Campaigns associated with a Brand. Results are limited to 25 records per page by default. Use page and per_page to navigate results.

ParametersJSON Schema

Name	Required	Description
`mock`	No	Indicates whether to include mock Campaigns only.
`name`	No	Campaign name.
`page`	No	Page number to retrieve.
`status`	No	Campaign status.
`usecase`	No	Use case.
`brand_id`	Yes	Brand ID.
`per_page`	No	Number of records per page.
`created_after`	No	Campaign creation start date in `YYYY-MM-DD` format.
`created_before`	No	Campaign creation end date in `YYYY-MM-DD` format.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_campaigns_updateInspect

Updates a 10DLC Campaign.

ParametersJSON Schema

Name	Required	Description	Default
`help`	No	Indicates whether the Campaign provides HELP responses
`name`	No	A user-defined Campaign name
`optin`	No	Indicates whether the Campaign supports opt-in functionality
`optout`	No	Indicates whether the Campaign supports opt-out functionality
`sample1`	No	Message sample
`sample2`	No	Message sample
`sample3`	No	Message sample
`sample4`	No	Message sample
`sample5`	No	Message sample
`usecase`	No	Campaign use case
`brand_id`	Yes	Brand ID.
`age_gated`	No	Indicates whether the Campaign messages contain age-gated content
`campaign_id`	Yes	Campaign ID.
`description`	No	The Campaign description
`auto_renewal`	No	Indicates whether the Campaign should be automatically renewed
`help_message`	No	An acknowledgement to be sent when a HELP keyword is received
`help_keywords`	No	A comma-separated list of HELP keywords. The HELP keywords are case-insensitive.	HELP
`optin_message`	No	An acknowledgement to be sent when an OPT-IN keyword is received
`direct_lending`	No	Indicates whether the Campaign messages contain direct lending content
`embedded_links`	No	Indicates whether the Campaign messages contain embedded links
`optin_keywords`	No	A comma-separated list of OPT-IN keywords. The OPT-IN keywords are case-insensitive.
`optin_workflow`	No	The opt-in workflow - the process through which consumers opt-in to the Campaign
`optout_message`	No	An acknowledgement to be sent when an OPT-OUT keyword is received
`privacy_policy`	No	A link to the Campaign privacy policy
`embedded_phones`	No	Indicates whether the Campaign messages contain embedded phone numbers
`optout_keywords`	No	A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive.
`terms_conditions`	No	A link to the Campaign terms and conditions
`embedded_link_sample`	No	An embedded link sample

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_evidence_deleteInspect

Deletes a 10DLC Brand evidence file.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Evidence ID.
`brand_id`	Yes	Brand ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_evidence_getInspect

Get a download URL for a 10DLC brand evidence file.

Returns {download_url, content_type, status_code, note} instead of the binary file stream. Fetch download_url to obtain the file.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes
`brand_id`	Yes

Output Schema

ParametersJSON Schema

Name	Required	Description
No output parameters

ten_dlc_brand_evidence_listInspect

Use this method to list previously uploaded Brand appeal evidence.

ParametersJSON Schema

Name	Required	Description	Default
`brand_id`	Yes	Unique identifier of a Brand

Output Schema

ParametersJSON Schema

Name	Required	Description
`items`	Yes	List of uploaded evidence files

ten_dlc_brand_evidence_uploadInspect

Uploads 10DLC Brand evidence. Supported formats include .jpg, .png, .pdf, and more. File size must be under 10MB.

ParametersJSON Schema

Name	Required	Description	Default
`file`	No	File to upload.
`brand_id`	Yes	Brand ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brands_createInspect

Registers a 10DLC Brand. TCR automatically verifies the brand identity. Only brands with VERIFIED or VETTED_VERIFIED identity status can register 10DLC Campaigns.

ParametersJSON Schema

Name	Required	Description
`zip`	Yes	The business zip or postal code
`city`	Yes	The city name
`mock`	No	Indicates a mock Brand. You can create mock Brands for testing purposes only, production traffic with the mock Brands is prohibited.
`email`	Yes	The email address of the support contact
`country`	Yes	2-letter ISO country code the business address
`website`	No	The website of the business
`dba_name`	Yes	Brand name or DBA
`vertical`	Yes	The segment the business operates in
`ein_taxid`	Yes	IRS Employee Identification Number (EIN) for US-based or foreign companies with EIN. The numeric portion of Tax ID for companies incorporated in other countries.
`last_name`	Yes	The last name of the business contact
`first_name`	Yes	The first name of the business contact
`entity_type`	Yes	The company entity type
`company_name`	Yes	Legal name of the company
`phone_number`	Yes	The support contact telephone in E.164 format
`stock_symbol`	No	The stock symbol of the Brand. For PUBLIC_PROFIT Brands only.
`stock_exchange`	No	The stock exchange code. For PUBLIC_PROFIT Brands only.
`street_address`	Yes	Street name and house number
`ein_taxid_country`	Yes	2-letter ISO country code of the Tax ID issuing country
`state_or_province`	Yes	State or province. For the United States, use 2 character codes.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brands_deleteInspect

Deletes a 10DLC Brand. Brands with active campaigns cannot be deleted.

ParametersJSON Schema

Name	Required	Description	Default
`brand_id`	Yes	Brand ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brands_getInspect

Returns a 10DLC Brand.

ParametersJSON Schema

Name	Required	Description	Default
`brand_id`	Yes	Brand ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brands_listInspect

Returns a paginated list of 10DLC brands. Filter results by date, name, legal name, and status. Results are limited to 25 records per page by default. Use page and per_page to navigate results.

ParametersJSON Schema

Name	Required	Description
`mock`	No	Indicates whether to include mock brands only.
`page`	No	Page number.
`status`	No	Brand identity verification status.
`country`	No	Brand registration country.
`dba_name`	No	Brand name.
`per_page`	No	Number of records per page.
`ein_taxid`	No	EIN/Tax ID.
`entity_type`	No	Business entity type.
`company_name`	No	Company legal name.
`show_deleted`	No	Indicates whether to include deleted brands.
`created_after`	No	Brand creation start date in `YYYY-MM-DD` format.
`created_before`	No	Brand creation end date in `YYYY-MM-DD` format.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brands_updateInspect

Updates a 10DLC brand. Updating identity-related parameters, including ein_taxid, ein_taxid_country, and entity_type, resets the Brand status to UNVERIFIED and triggers automatic re-submission. Brands in VETTED_VERIFIED status or with active Campaigns cannot be updated.

ParametersJSON Schema

Name	Required	Description
`zip`	No	The business zip or postal code
`city`	No	The city name
`mock`	No	Mock flag for testing (optional, defaults to false)
`email`	No	The email address of the support contact
`country`	No	2-letter ISO country code the business address
`website`	No	The website of the business
`brand_id`	Yes	Brand ID.
`dba_name`	No	Brand name or DBA
`vertical`	No	The segment the business operates in
`ein_taxid`	No	IRS Employee Identification Number (EIN) for US-based or foreign companies with EIN. The numeric portion of Tax ID for companies incorporated in other countries.
`last_name`	No	The last name of the business contact
`first_name`	No	The first name of the business contact
`entity_type`	No	The company entity type
`company_name`	No	Legal name of the company
`phone_number`	No	The support contact telephone in E.164 format
`stock_symbol`	No	The stock symbol of the Brand. For PUBLIC_PROFIT Brands only.
`stock_exchange`	No	The stock exchange code. For PUBLIC_PROFIT Brands only.
`street_address`	No	Street name and house number
`ein_taxid_country`	No	2-letter ISO country code of the Tax ID issuing country
`state_or_province`	No	State or province. For the United States, use 2 character codes.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_usecase_qualifyInspect

Returns the qualification results for a 10DLC Brand use case. Includes MNO-specific attributes, restrictions, and fees.

ParametersJSON Schema

Name	Required	Description	Default
`brand_id`	Yes	Brand ID.
`use_case`	Yes	Use case name.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_vetting_appeals_createInspect

Submits an appeal for a 10DLC Brand external vetting.

ParametersJSON Schema

Name	Required	Description
`evp_id`	No	EVP ID.
`brand_id`	Yes	Brand ID.
`evidence`	Yes	List of evidence IDs associated with the appeal.
`vetting_id`	No	Vetting ID.
`explanation`	No	Appeal comment or justification.
`appeal_categories`	Yes	List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`, `LOW_SCORE`.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_vetting_appeals_listInspect

Returns a list of external vetting appeals for a 10DLC Brand.

ParametersJSON Schema

Name	Required	Description	Default
`brand_id`	Yes	Brand ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_vettings_createInspect

Requests external vetting for a 10DLC Brand. Supported providers: AEGIS, CV, WMC. Supported classes: STANDARD, ENHANCED.

ParametersJSON Schema

Name	Required	Description
`evp_id`	Yes	External vetting provider code
`brand_id`	Yes	Brand ID.
`vetting_class`	Yes	The vetting class

Output Schema

ParametersJSON Schema

Name	Required	Description
`evp_id`	Yes	External vetting provider code
`reasons`	Yes	Reason
`vetting_id`	Yes	Unique identifier of the vetting request
`create_date`	Yes	The date and time the vetting request is created
`vetted_date`	Yes	The date and time the vetting request is competed
`vetting_class`	Yes	The vetting class
`vetting_score`	Yes	The assigned Brand vetting score
`vetting_token`	Yes	Unique vetting token
`vetting_status`	Yes	Status of the vetting request
`vetting_details`	No	Additional details of the vetting request

ten_dlc_brand_vettings_importInspect

Imports an existing external vetting for a 10DLC Brand.

ParametersJSON Schema

Name	Required	Description
`evp_id`	Yes	External vetting provider code
`brand_id`	Yes	Brand ID.
`vetting_id`	Yes	Unique identifier of the vetting request
`vetting_token`	Yes	Unique vetting token

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_brand_vettings_listInspect

Returns a list of external vettings for a 10DLC Brand.

ParametersJSON Schema

Name	Required	Description	Default
`brand_id`	Yes	Brand ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_campaign_numbers_linkInspect

Links a phone number to a 10DLC Campaign. Wavix automatically creates a Sender ID once the number is approved.

ParametersJSON Schema

Name	Required	Description
`number`	Yes	Phone number to associate with the Campaign.
`brand_id`	Yes	Brand ID.
`campaign_id`	Yes	Campaign ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_campaign_numbers_listInspect

Returns a list of phone numbers associated with a 10DLC Campaign.

ParametersJSON Schema

Name	Required	Description	Default
`brand_id`	Yes	Brand ID.
`campaign_id`	Yes	Campaign ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_campaign_numbers_unlinkInspect

Unlinks a phone number from a 10DLC Campaign. The associated Sender ID is also deleted.

ParametersJSON Schema

Name	Required	Description
`number`	Yes	Phone number to unlink.
`brand_id`	Yes	Brand ID.
`campaign_id`	Yes	Campaign ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_campaigns_listInspect

Returns a paginated list of 10DLC Campaigns. Filter results by date, status, and use case. Results are limited to 25 records per page by default. Use page and per_page to navigate results.

ParametersJSON Schema

Name	Required	Description
`mock`	No	Indicates whether to include mock 10DLC Campaigns only.
`name`	No	Campaign name.
`page`	No	Page number to retrieve.
`status`	No	Campaign status.
`usecase`	No	Use case.
`per_page`	No	Number of records per page.
`created_after`	No	Campaign creation start date in `YYYY-MM-DD` format.
`created_before`	No	Campaign creation end date in `YYYY-MM-DD` format.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_campaigns_nudgeInspect

Requests action on a pending or rejected 10DLC Campaign. Use nudge_intent to specify the action:

REVIEW: Request review for a pending Campaign. - APPEAL_REJECTION: Appeal a rejected Campaign. Note:
The Campaign must be at least 72 hours old.
Only one nudge request per Campaign is allowed every 24 hours.

ParametersJSON Schema

Name	Required	Description
`brand_id`	Yes	Brand ID.
`campaign_id`	Yes	Campaign ID.
`description`	Yes	Description of the nudge request.
`nudge_intent`	Yes	Nudge intent. Allowed values: `REVIEW`, `APPEAL_REJECTION`. Use `nudge_intent` to specify the action: - `REVIEW`: Request review for a pending Campaign. - `APPEAL_REJECTION`: Appeal a rejected Campaign.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_subscriptions_createInspect

Subscribes to Wavix 10DLC event callbacks.

ParametersJSON Schema

Name	Required	Description	Default
`url`	Yes	A webhook URL to send events to
`subscription_category`	Yes	The Wavix 10DLC event type. Can be one of the following: `brand`, `campaign`, or `number`.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_subscriptions_deleteInspect

Deletes a 10DLC event subscription.

ParametersJSON Schema

Name	Required	Description	Default
`subscription_category`	Yes	Event category to unsubscribe from.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

ten_dlc_subscriptions_listInspect

Returns a list of 10DLC event subscriptions.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

two_fa_events_listInspect

Returns a list of events for a specific 2FA Verification.

ParametersJSON Schema

Name	Required	Description	Default
`session_id`	Yes	2FA Verification ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

two_fa_sessions_listInspect

Returns a list of 2FA verifications. Filter by service or date.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	End date in `YYYY-MM-DD` format.
`from`	Yes	Start date in `YYYY-MM-DD` format.
`service_id`	Yes	2FA Service ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

two_fa_verification_cancelInspect

Cancels a 2FA verification. After cancellation, no additional codes are sent, and previously sent codes can no longer be validated. You must create a new verification to send another code.

ParametersJSON Schema

Name	Required	Description	Default
`session_id`	Yes	2FA Verification ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No

two_fa_verification_checkInspect

Validates the verification code.

ParametersJSON Schema

Name	Required	Description	Default
`code`	Yes	The code entered by an end user
`session_id`	Yes	2FA Verification ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

two_fa_verification_createInspect

Creates a new 2FA Verification and sends a one-time password (OTP) to the destination phone number. Before using this endpoint, create a 2FA Service in the Wavix portal. The service is created once and reused to generate and validate OTPs. OTP flow:

Create a Verification to generate and send an OTP.
Reuse the same Verification to resend the OTP if needed.
Validate the OTP using the 2FA API

When a Verification is created, Wavix generates a random code and sends it to the destination phone number via the selected channel.

ParametersJSON Schema

Name	Required	Description
`to`	Yes	End user's phone number to which the verification code will be sent. The phone number must be in E.164 format.
`channel`	Yes	The communication channel you want to use. Can be either `sms` or `voice`.
`service_id`	Yes	Unique Wavix 2FA Service ID. Find your 2FA Service ID on the Wavix portal.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

two_fa_verification_resendInspect

Resends the verification code using the specified channel. Previously sent codes are invalidated.

ParametersJSON Schema

Name	Required	Description	Default
`channel`	Yes	The communication channel you want to use. Can be either `sms` or `voice`.
`session_id`	Yes	2FA Verification ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`result`	Yes

voice_campaigns_createInspect

Triggers an outbound call based on a pre-configured scenario.

ParametersJSON Schema

Name	Required	Description	Default
`voice_campaign`	Yes

Output Schema

ParametersJSON Schema

Name	Required	Description
`voice_campaign`	No

voice_campaigns_getInspect

Returns a specific voice campaign.

ParametersJSON Schema

Name	Required	Description	Default
`id`	Yes	Voice campaign ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`voice_campaign`	No

webrtc_tokens_createInspect

Creates a Wavix Embeddable widget token.

ParametersJSON Schema

Name	Required	Description
`ttl`	Yes	Time to live in seconds. Pass `null` for no expiration.
`payload`	No	Arbitrary data to be associated with the token
`sip_trunk`	Yes	SIP trunk name

Output Schema

ParametersJSON Schema

Name	Required	Description
`ttl`	No	Time to live, in seconds
`uuid`	Yes	Token ID
`token`	Yes	Wavix Embeddable Widget token.
`payload`	No	Arbitrary data associated with the token
`sip_trunk`	Yes	SIP trunk name

webrtc_tokens_deleteInspect

Deletes a Wavix Embeddable widget token. After deletion, the token can't be used to authenticate widget sessions, and any active session associated with it is terminated.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Token ID

Output Schema

ParametersJSON Schema

Name	Required	Description
`success`	No

webrtc_tokens_getInspect

Returns a Wavix Embeddable widget token configuration.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Token ID.

Output Schema

ParametersJSON Schema

Name	Required	Description
`ttl`	No	Time to live, in seconds. `null` means no expiration.
`uuid`	Yes	Token ID
`payload`	No	Arbitrary data associated with the token
`sip_trunk`	Yes	SIP trunk name

webrtc_tokens_listInspect

Returns a paginated list of active Wavix Embeddable widget tokens. Results are limited to 25 records per page by default. Use page and per_page to navigate results.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

Output Schema

ParametersJSON Schema

Name	Required	Description
`items`	No
`pagination`	No

webrtc_tokens_updateInspect

Updates the payload for a Wavix Embeddable widget token.

ParametersJSON Schema

Name	Required	Description	Default
`uuid`	Yes	Token ID
`payload`	Yes	Arbitrary data to be associated with the token

Output Schema

ParametersJSON Schema

Name	Required	Description
`ttl`	No	Time to live, in seconds. `null` means no expiration.
`uuid`	Yes	Token ID
`payload`	No	Arbitrary data associated with the token
`sip_trunk`	Yes	SIP trunk name

Claim this connector by publishing a /.well-known/glama.json file on your server's domain with the following structure:

{
  "$schema": "https://glama.ai/mcp/schemas/connector.json",
  "maintainers": [{ "email": "your-email@example.com" }]
}

The email address must match the email associated with your Glama account. Once published, Glama will automatically detect and verify the file within a few minutes.