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.
number_validator_get ~41
Returns details for a phone number.
| Name | Type | Req | Description |
|---|---|---|---|
| phone_number | string | yes | Phone number in E.164 format or without "+". |
| type | — | yes | Validation type. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
number_validator_results_get ~25
Returns asynchronous validation results.
| Name | Type | Req | Description |
|---|---|---|---|
| request_id | string | yes | Request ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
profile_config_get ~17
Returns the account balance and configuration details.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
profile_get ~16
Returns the account profile and billing details.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
profile_update ~165
Updates the account profile and billing details.
| Name | Type | Req | Description |
|---|---|---|---|
| additional_info | string | — | Additional information associated with the account. |
| company_info | object | — | — |
| contacts | string | — | Email associated with the account. |
| default_short_link_endpoint | string | — | Default short link endpoint. |
| dlr_relay_url | string | — | Callback URL to forward message delivery reports (DLRs) to. |
| first_name | string | — | Account owner's first name. |
| job_title | string | — | Account owner's job title. |
| last_name | string | — | Account owner's last name. |
| phone | string | — | Account owner's phone number |
| sms_relay_url | string | — | Callback URL to forward inbound SMS to. |
| time_zone | string | — | Timezone configured on the account. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sip_trunks_create ~599
Creates a SIP trunk.
| Name | Type | Req | Description |
|---|---|---|---|
| allowed_ips | array|null | — | A list of public static IP addresses allowed to register with the SIP trunk |
| call_limit | integer | — | 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`. |
| call_recording_enabled | boolean | — | Indicates whether outbound call recording is enabled for the SIP trunk |
| call_restrict | boolean | yes | Indicates whether a maximum call duration limit is enforced for the SIP trunk |
| callerid | string | yes | Caller ID associated with the SIP trunk. Must be an active or verified number on your account. |
| channels_restrict | boolean | yes | Indicates whether a limit on the number of concurrent outbound calls is enforced for the SIP trunk |
| cost_limit | boolean | yes | Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk. |
| didinfo_enabled | boolean | yes | Indicates whether inbound calls include dialed number information in the `To` header of SIP INVITE requests |
| encrypted_media | boolean | — | — |
| host_request | object | — | 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 ad… |
| ip_restrict | boolean | 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. |
| label | string | yes | User-defined name of the SIP trunk |
| machine_detection_enabled | boolean | — | Indicates whether automatic voicemail detection is enabled for the SIP trunk. Available for `Flex Pro` customers only. |
| max_call_cost | number | — | Maximum cost for an outbound call, in USD |
| max_channels | integer | — | 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`. |
| multiple_numbers | boolean | — | Indicates whether any active or verified phone number in your account can be used as the Caller ID for the SIP trunk |
| password | string | yes | Password set for the SIP trunk. Use a strong password to help keep your SIP trunk secure. |
| rewrite_cond | string | — | Number of leading digits to automatically remove from each dialed phone number |
| rewrite_enabled | boolean | yes | Indicates whether a custom dial plan is activated for the SIP trunk |
| rewrite_prefix | string | — | Digits to automatically prepend to each dialed phone number |
| transcription_enabled | boolean | yes | Indicates whether automatic call transcription is enabled for the SIP trunk. Available for `Flex Pro` customers only. |
| transcription_threshold | integer | 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. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sip_trunks_delete ~25
Deletes a SIP trunk.
| Name | Type | Req | Description |
|---|---|---|---|
| id | integer | yes | SIP trunk ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sip_trunks_get ~26
Returns a SIP trunk configuration.
| Name | Type | Req | Description |
|---|---|---|---|
| id | integer | yes | SIP trunk ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sip_trunks_list ~68
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.
| 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.
sip_trunks_update ~610
Updates a SIP trunk configuration.
| Name | Type | Req | Description |
|---|---|---|---|
| allowed_ips | array|null | — | A list of public static IP addresses allowed to register with the SIP trunk |
| call_limit | integer | — | 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`. |
| call_recording_enabled | boolean | — | Indicates whether outbound call recording is enabled for the SIP trunk |
| call_restrict | boolean | yes | Indicates whether a maximum call duration limit is enforced for the SIP trunk |
| callerid | string | yes | Caller ID associated with the SIP trunk. Must be an active or verified number on your account. |
| channels_restrict | boolean | yes | Indicates whether a limit on the number of concurrent outbound calls is enforced for the SIP trunk |
| cost_limit | boolean | yes | Indicates if the max cost limit for an outbound call limit is activated for the SIP trunk. |
| didinfo_enabled | boolean | yes | Indicates whether inbound calls include dialed number information in the `To` header of SIP INVITE requests |
| encrypted_media | boolean | — | — |
| host_request | object | — | 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 ad… |
| id | integer | yes | SIP trunk ID. |
| ip_restrict | boolean | 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. |
| label | string | yes | User-defined name of the SIP trunk |
| machine_detection_enabled | boolean | — | Indicates whether automatic voicemail detection is enabled for the SIP trunk. Available for `Flex Pro` customers only. |
| max_call_cost | number | — | Maximum cost for an outbound call, in USD |
| max_channels | integer | — | 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`. |
| multiple_numbers | boolean | — | Indicates whether any active or verified phone number in your account can be used as the Caller ID for the SIP trunk |
| password | string | yes | Password set for the SIP trunk. Use a strong password to help keep your SIP trunk secure. |
| rewrite_cond | string | — | Number of leading digits to automatically remove from each dialed phone number |
| rewrite_enabled | boolean | yes | Indicates whether a custom dial plan is activated for the SIP trunk |
| rewrite_prefix | string | — | Digits to automatically prepend to each dialed phone number |
| transcription_enabled | boolean | yes | Indicates whether automatic call transcription is enabled for the SIP trunk. Available for `Flex Pro` customers only. |
| transcription_threshold | integer | 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. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sms_and_mms_messages_get ~25
Returns a message.
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | Message ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sms_and_mms_messages_list ~228
Returns a paginated list of SMS and MMS messages.
| Name | Type | Req | Description |
|---|---|---|---|
| from | string | — | Message sender. For `outbound` messages, the Sender ID used to send the message; for `inbound` messages, the originating phone number. |
| message_type | string | — | Message type for filtering. Allowed values are `sms`, `mms`. |
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| sent_after | string | — | Start date in `YYYY-MM-DD` format. |
| sent_before | string | — | End date in `YYYY-MM-DD` format. |
| status | — | — | Message delivery status for filtering. |
| tag | string | — | Tag for filtering. Supported for outbound messages only. |
| to | string | — | Recipient phone number. For `outbound` messages, the destination phone number; for `inbound` messages, an SMS-enabled number on the Wavix platform. |
| type | string | yes | Message direction for filtering. Allowed values are `inbound`, `outbound`. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sms_and_mms_messages_list_all ~221
Returns SMS and MMS messages in newline-delimited JSON (NDJSON) format.
| Name | Type | Req | Description |
|---|---|---|---|
| from | string | — | Message sender. For `outbound` messages, the Sender ID used to send the message; for `inbound` messages, the originating phone number. |
| message_type | string | — | Message type for filtering. Allowed values are `sms`, `mms`. |
| sent_after | string | — | Start date in `YYYY-MM-DDTHH:MM:SS` format. |
| sent_before | string | — | End date in `YYYY-MM-DDTHH:MM:SS` format. |
| status | — | — | Message delivery status for filtering. |
| tag | string | — | Tag for filtering. Supported for outbound messages only. |
| to | string | — | Message recipient. For `outbound` messages, the destination phone number; for `inbound` messages, the SMS-enabled number that received the message. |
| type | string | yes | Message direction for filtering. Allowed values are `inbound`, `outbound`. |
No output schema declared.
No examples provided.
sms_and_mms_messages_send ~127
Sends SMS or MMS messages. MMS is supported for U.S. numbers only. **Rate limit**: 20 messages per phone number in 24 hours.
| Name | Type | Req | Description |
|---|---|---|---|
| callback_url | string | — | Callback URL for delivery reports. |
| from | string | yes | Sender ID. Numeric or alphanumeric. |
| message_body | object | yes | — |
| tag | string | — | Tag to group messages, such as for a specific campaign. |
| to | string | yes | Recipient phone number. |
| validity | integer | — | Message validity period in seconds. Delivery attempts stop after this period expires. |
| Name | Type | Req | Description |
|---|---|---|---|
| carrier_fees | string|null | — | Mobile carrier fees in USD. |
| charge | string | — | Total charge for the message in USD. |
| delivered_at | string|null | — | Date and time the message was delivered in ISO 8601 format. |
| direction | string | — | Message direction. Possible values are `outbound`, `inbound`. |
| error_message | string|null | — | Error message. |
| from | string | — | Sender ID. |
| mcc | string|null | — | Mobile country code. |
| message_body | object | — | — |
| message_id | string | — | Message ID. |
| message_type | string | — | Message type. |
| mnc | string|null | — | Mobile network code. |
| segments | integer | — | Number of SMS segments. Always 1 for MMS. |
| sent_at | string|null | — | Date and time the message was sent in ISO 8601 format. |
| status | string | — | Message status. |
| submitted_at | string | — | Date and time the message was submitted in ISO 8601 format. |
| tag | string|null | — | Message tag. |
| to | string | — | Recipient phone number. |
No examples provided.
sms_and_mms_opt_outs_create ~42
Creates an opt-out for a Sender ID, 10DLC campaign, or all outbound messages.
| Name | Type | Req | Description |
|---|---|---|---|
| opt_out | object | yes | — |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sms_and_mms_opt_outs_list ~135
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.
| Name | Type | Req | Description |
|---|---|---|---|
| campaign_id | string | — | 10DLC campaign for filtering. |
| created_after | string | — | Start date in `YYYY-MM-DD` format. |
| created_before | string | — | End date in `YYYY-MM-DD` format. |
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| sender_id | string | — | Sender ID for filtering. |
| Name | Type | Req | Description |
|---|---|---|---|
| items | array | — | — |
| pagination | object | — | — |
No examples provided.
sms_and_mms_sender_ids_create ~120
Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US.
| Name | Type | Req | Description |
|---|---|---|---|
| countries | array | yes | Two-letter ISO country codes where the Sender ID is allowlisted. |
| monthly_volume | string | — | Expected monthly volume. |
| samples | array | — | Message samples. |
| sender_id | string | yes | Sender ID name. Can be either an alphanumeric string or a phone number. |
| type | string | yes | Sender ID type. |
| usecase | string | yes | Use case for the Sender ID |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sms_and_mms_sender_ids_delete ~28
Deletes a Sender ID.
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | Sender ID ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sms_and_mms_sender_ids_get ~28
Returns a Sender ID.
| Name | Type | Req | Description |
|---|---|---|---|
| id | string | yes | Sender ID ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
sms_and_mms_sender_ids_list ~20
Returns a list of Sender IDs.
Input schema present but exposes no named parameters.
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
speech_analytics_create ~209
Uploads an audio file for transcription. Wavix sends a POST callback to the specified callback URL when the transcription is complete. Callback body: ```json { "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.
| Name | Type | Req | Description |
|---|---|---|---|
| callback_url | string | — | Callback URL for transcription status updates. |
| file | string | — | Binary file content. Maximum size is 25 MB. Wavix supports WAV, MP3, and MP4 stereo formats. |
| insights | boolean | — | Indicates whether to enable insights generation. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
speech_analytics_file_get ~72
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.
| Name | Type | Req | Description |
|---|---|---|---|
| uuid | string | yes | — |
Structured output declared, but exposes no named fields.
No examples provided.
speech_analytics_get ~25
Returns a transcription.
| Name | Type | Req | Description |
|---|---|---|---|
| uuid | string | yes | Transcription request ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
speech_analytics_retranscribe ~57
Retranscribes an uploaded file.
| Name | Type | Req | Description |
|---|---|---|---|
| callback_url | string | — | Callback URL for transcription status updates. |
| insights | boolean | — | Indicates whether to enable insights generation. |
| uuid | string | yes | Transcription request ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| success | boolean | — | Indicates whether the request was successful. |
No examples provided.
sub_accounts_create ~42
Creates a sub-account.
| Name | Type | Req | Description |
|---|---|---|---|
| default_destinations | object | — | Default webhook URLs for inbound messages and delivery reports. |
| name | string | yes | Sub-account name. |
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | yes | Sub-account API key. |
| created_at | string | yes | Date and time the sub-account was created in ISO 8601 format. |
| default_destinations | object | yes | Default webhook URLs for inbound messages and delivery reports. |
| id | integer | yes | Sub-account ID. |
| master_organization | integer | yes | Master account ID. |
| name | string | yes | Sub-account name. |
| status | string | yes | Sub-account status. |
No examples provided.
sub_accounts_get ~50
Returns a specific sub-account. Results are limited to 25 records per page by default. Use `page` and `per_page` to navigate results.
| Name | Type | Req | Description |
|---|---|---|---|
| id | integer | yes | Sub-account ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | yes | Sub-account API key. |
| created_at | string | yes | Date and time the sub-account was created in ISO 8601 format. |
| default_destinations | object | yes | Default webhook URLs for inbound messages and delivery reports. |
| id | integer | yes | Sub-account ID. |
| master_organization | integer | yes | Master account ID. |
| name | string | yes | Sub-account name. |
| status | string | yes | Sub-account status. |
No examples provided.
sub_accounts_list ~56
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.
| Name | Type | Req | Description |
|---|---|---|---|
| status | string | — | Account status to filter results. |
| Name | Type | Req | Description |
|---|---|---|---|
| pagination | object | — | — |
| sub_organizations | array | — | — |
No examples provided.
sub_accounts_transactions_list ~134
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.
| Name | Type | Req | Description |
|---|---|---|---|
| from_date | string | yes | Start date in `YYYY-MM-DD` format. |
| id | integer | yes | Sub-account ID. |
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| to_date | string | yes | End date in `YYYY-MM-DD` format. |
| type | — | — | Transaction types to filter results. |
| Name | Type | Req | Description |
|---|---|---|---|
| pagination | object | — | — |
| transactions | array | — | — |
No examples provided.
sub_accounts_update ~64
Updates a sub-account's configuration.
| Name | Type | Req | Description |
|---|---|---|---|
| default_destinations | object | — | Default webhook URLs for inbound messages and delivery reports. |
| id | integer | yes | Sub-account ID. |
| name | string | yes | Sub-account name. |
| status | string | — | Sub-account status. |
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | yes | Sub-account API key. |
| created_at | string | yes | Date and time the sub-account was created in ISO 8601 format. |
| default_destinations | object | yes | Default webhook URLs for inbound messages and delivery reports. |
| id | integer | yes | Sub-account ID. |
| master_organization | integer | yes | Master account ID. |
| name | string | yes | Sub-account name. |
| status | string | yes | Sub-account status. |
No examples provided.
ten_dlc_brand_appeals_create ~211
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.
| Name | Type | Req | Description |
|---|---|---|---|
| appeal_categories | array | yes | List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT` |
| brand_id | string | yes | Brand ID. |
| evidence | array | yes | List of evidence IDs associated with the appeal. |
| explanation | string | — | Appeal comment or justification. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_appeals_list ~33
Returns a list of brand identity verification appeals.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | array | yes | — |
No examples provided.
ten_dlc_brand_campaigns_create ~547
Registers a 10DLC Campaign.
| Name | Type | Req | Description |
|---|---|---|---|
| affiliate_marketing | boolean | yes | Indicates whether the Campaign is used for affiliate marketing |
| age_gated | boolean | yes | Indicates whether the Campaign messages contain age-gated content |
| auto_renewal | boolean | yes | Indicates whether the Campaign should be automatically renewed |
| brand_id | string | yes | Brand ID. |
| description | string | yes | The Campaign description |
| direct_lending | boolean | yes | Indicates whether the Campaign messages contain direct lending content |
| embedded_link_sample | string|null | yes | An embedded link sample |
| embedded_links | boolean | yes | Indicates whether the Campaign messages contain embedded links |
| embedded_phones | boolean|null | yes | Indicates whether the Campaign messages contain embedded phone numbers |
| help | boolean | yes | Indicates whether the campaign has a help system (e.g. keyword: HELP, INFO) that subscribers can use or not. |
| help_keywords | string | yes | A comma-separated list of HELP keywords. The HELP keywords are case-insensitive. |
| help_message | string | yes | An acknowledgement to be sent when a HELP keyword is received |
| mock | boolean | yes | Indicates a mock Campaign. The mock Campaigns cannot be used to send production traffic |
| name | string | yes | A user-defined Campaign name |
| optin | boolean | yes | Indicates whether the campaign requires a subscriber to opt-in before receiving messages or not. |
| optin_keywords | string | yes | A comma-separated list of OPT-IN keywords. The OPT-IN keywords are case-insensitive. |
| optin_message | string | yes | An acknowledgement to be sent when an OPT-IN keyword is received |
| optin_workflow | string | yes | The opt-in workflow - the process through which consumers opt-in to the Campaign |
| optout | boolean | yes | Indicates whether the campaign has an opt-out system (e.g. keyword: STOP, QUIT) that subscribers can use or not. |
| optout_keywords | string | yes | A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive. |
| optout_message | string | yes | An acknowledgement to be sent when an OPT-OUT keyword is received |
| privacy_policy | string | — | A link to the Campaign privacy policy |
| sample1 | string | yes | Message sample |
| sample2 | string|null | yes | Message sample |
| sample3 | string|null | yes | Message sample |
| sample4 | string|null | yes | Message sample |
| sample5 | string|null | yes | Message sample |
| terms_conditions | string | yes | A link to the Campaign terms and conditions |
| usecase | string | yes | The Campaign use case |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_campaigns_delete ~56
Deletes a 10DLC Campaign. Associated phone numbers cannot be used as Sender IDs once the Campaign is deleted.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| campaign_id | string | yes | Campaign ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_campaigns_get ~41
Returns a 10DLC Campaign.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| campaign_id | string | yes | Campaign ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_campaigns_list ~166
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.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| created_after | string | — | Campaign creation start date in `YYYY-MM-DD` format. |
| created_before | string | — | Campaign creation end date in `YYYY-MM-DD` format. |
| mock | boolean | — | Indicates whether to include mock Campaigns only. |
| name | string | — | Campaign name. |
| page | integer | — | Page number to retrieve. |
| per_page | integer | — | Number of records per page. |
| status | string | — | Campaign status. |
| usecase | string | — | Use case. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_campaigns_update ~467
Updates a 10DLC Campaign.
| Name | Type | Req | Description |
|---|---|---|---|
| age_gated | boolean | — | Indicates whether the Campaign messages contain age-gated content |
| auto_renewal | boolean | — | Indicates whether the Campaign should be automatically renewed |
| brand_id | string | yes | Brand ID. |
| campaign_id | string | yes | Campaign ID. |
| description | string | — | The Campaign description |
| direct_lending | boolean | — | Indicates whether the Campaign messages contain direct lending content |
| embedded_link_sample | string | — | An embedded link sample |
| embedded_links | boolean | — | Indicates whether the Campaign messages contain embedded links |
| embedded_phones | boolean | — | Indicates whether the Campaign messages contain embedded phone numbers |
| help | boolean | — | Indicates whether the Campaign provides HELP responses |
| help_keywords | string | — | A comma-separated list of HELP keywords. The HELP keywords are case-insensitive. |
| help_message | string | — | An acknowledgement to be sent when a HELP keyword is received |
| name | string | — | A user-defined Campaign name |
| optin | boolean | — | Indicates whether the Campaign supports opt-in functionality |
| optin_keywords | string | — | A comma-separated list of OPT-IN keywords. The OPT-IN keywords are case-insensitive. |
| optin_message | string | — | An acknowledgement to be sent when an OPT-IN keyword is received |
| optin_workflow | string | — | The opt-in workflow - the process through which consumers opt-in to the Campaign |
| optout | boolean | — | Indicates whether the Campaign supports opt-out functionality |
| optout_keywords | string | — | A comma-separated list of OPT-OUT keywords. The OPT-OUT keywords are case-insensitive. |
| optout_message | string | — | An acknowledgement to be sent when an OPT-OUT keyword is received |
| privacy_policy | string | — | A link to the Campaign privacy policy |
| sample1 | string | — | Message sample |
| sample2 | string | — | Message sample |
| sample3 | string | — | Message sample |
| sample4 | string | — | Message sample |
| sample5 | string | — | Message sample |
| terms_conditions | string | — | A link to the Campaign terms and conditions |
| usecase | string | — | Campaign use case |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_evidence_delete ~42
Deletes a 10DLC Brand evidence file.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| uuid | string | yes | Evidence ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_evidence_get ~75
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.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | — |
| uuid | string | yes | — |
Structured output declared, but exposes no named fields.
No examples provided.
ten_dlc_brand_evidence_list ~37
Use this method to list previously uploaded Brand appeal evidence.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Unique identifier of a Brand |
| Name | Type | Req | Description |
|---|---|---|---|
| items | array | yes | List of uploaded evidence files |
No examples provided.
ten_dlc_brand_evidence_upload ~66
Uploads 10DLC Brand evidence. Supported formats include .jpg, .png, .pdf, and more. File size must be under 10MB.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| file | string | — | File to upload. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_usecase_qualify ~61
Returns the qualification results for a 10DLC Brand use case. Includes MNO-specific attributes, restrictions, and fees.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| use_case | string | yes | Use case name. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_vetting_appeals_create ~128
Submits an appeal for a 10DLC Brand external vetting.
| Name | Type | Req | Description |
|---|---|---|---|
| appeal_categories | array | yes | List of appeal categories. Allowed values: `VERIFY_TAX_ID`, `VERIFY_NON_PROFIT`, `VERIFY_GOVERNMENT`, `LOW_SCORE`. |
| brand_id | string | yes | Brand ID. |
| evidence | array | yes | List of evidence IDs associated with the appeal. |
| evp_id | string | — | EVP ID. |
| explanation | string | — | Appeal comment or justification. |
| vetting_id | string | — | Vetting ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_vetting_appeals_list ~42
Returns a list of external vetting appeals for a 10DLC Brand.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | array | yes | — |
No examples provided.
ten_dlc_brand_vettings_create ~87
Requests external vetting for a 10DLC Brand. Supported providers: `AEGIS`, `CV`, `WMC`. Supported classes: `STANDARD`, `ENHANCED`.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| evp_id | string | yes | External vetting provider code |
| vetting_class | string | yes | The vetting class |
| Name | Type | Req | Description |
|---|---|---|---|
| create_date | string | yes | The date and time the vetting request is created |
| evp_id | string | yes | External vetting provider code |
| reasons | array|null | yes | Reason |
| vetted_date | string|null | yes | The date and time the vetting request is competed |
| vetting_class | string | yes | The vetting class |
| vetting_details | object | — | Additional details of the vetting request |
| vetting_id | string | yes | Unique identifier of the vetting request |
| vetting_score | integer|null | yes | The assigned Brand vetting score |
| vetting_status | string | yes | Status of the vetting request |
| vetting_token | string|null | yes | Unique vetting token |
No examples provided.
ten_dlc_brand_vettings_import ~80
Imports an existing external vetting for a 10DLC Brand.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| evp_id | string | yes | External vetting provider code |
| vetting_id | string | yes | Unique identifier of the vetting request |
| vetting_token | string | yes | Unique vetting token |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brand_vettings_list ~38
Returns a list of external vettings for a 10DLC Brand.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | array | yes | — |
No examples provided.
ten_dlc_brands_create ~387
Registers a 10DLC Brand. TCR automatically verifies the brand identity. Only brands with `VERIFIED` or `VETTED_VERIFIED` identity status can register 10DLC Campaigns.
| Name | Type | Req | Description |
|---|---|---|---|
| city | string | yes | The city name |
| company_name | string | yes | Legal name of the company |
| country | string | yes | 2-letter ISO country code the business address |
| dba_name | string | yes | Brand name or DBA |
| ein_taxid | string | 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. |
| ein_taxid_country | string | yes | 2-letter ISO country code of the Tax ID issuing country |
| string | yes | The email address of the support contact | |
| entity_type | string | yes | The company entity type |
| first_name | string | yes | The first name of the business contact |
| last_name | string | yes | The last name of the business contact |
| mock | boolean | — | Indicates a mock Brand. You can create mock Brands for testing purposes only, production traffic with the mock Brands is prohibited. |
| phone_number | string | yes | The support contact telephone in E.164 format |
| state_or_province | string|null | yes | State or province. For the United States, use 2 character codes. |
| stock_exchange | string|null | — | The stock exchange code. For PUBLIC_PROFIT Brands only. |
| stock_symbol | string|null | — | The stock symbol of the Brand. For PUBLIC_PROFIT Brands only. |
| street_address | string | yes | Street name and house number |
| vertical | string | yes | The segment the business operates in |
| website | string | — | The website of the business |
| zip | string | yes | The business zip or postal code |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brands_delete ~38
Deletes a 10DLC Brand. Brands with active campaigns cannot be deleted.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.
ten_dlc_brands_get ~30
Returns a 10DLC Brand.
| Name | Type | Req | Description |
|---|---|---|---|
| brand_id | string | yes | Brand ID. |
| Name | Type | Req | Description |
|---|---|---|---|
| result | — | yes | — |
No examples provided.