Wavix

- call_recording_get: 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.
- billing_invoices_download: 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.
- speech_analytics_file_get: 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.
- ten_dlc_brand_evidence_get: 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.
- api_keys_list: Returns a list of API keys.
- api_keys_create: Creates an API key. Optional IP restrictions can be configured to limit access.
- api_keys_delete: Deletes an API key. This action is permanent.
- api_keys_activate: Activates an API key. Once activated, the API key can be used for authentication again.
- api_keys_deactivate: Deactivates an API key. Once deactivated, the API key cannot be used for authentication.
- sip_trunks_list: 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.
- sip_trunks_create: Creates a SIP trunk.
- sip_trunks_get: Returns a SIP trunk configuration.
- sip_trunks_update: Updates a SIP trunk configuration.
- sip_trunks_delete: Deletes a SIP trunk.
- buy_countries_list: Returns a list of countries where phone numbers are available.
- buy_regions_list: Returns a list of regions (states or provinces) for countries where has_provinces_or_states is true.
- buy_cities_list: Returns a list of cities for countries where
has_provinces_or_states is false.
- buy_region_cities_list: Returns a list of cities in the specified region for countries where has_provinces_or_states is true.
- buy_numbers_list: Returns a paginated list of phone numbers available for purchase.
- cart_get: Returns the cart.
- cart_add: Adds phone numbers to the cart.
- cart_remove: Removes phone numbers from the cart.
- cart_checkout: Checks out the cart. Activation and monthly fees are deducted from the account balance.
- my_numbers_list: 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.
- my_numbers_delete: Releases phone numbers back to stock.
- my_numbers_get: Returns a phone number.
- my_numbers_update: Updates a phone number.
- my_numbers_sms_update: Enables or disables inbound SMS support for a phone number.
- my_numbers_destinations_update: Updates inbound call routing for phone numbers.
- my_numbers_papers_upload: 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
- cdrs_list: Returns a paginated list of CDRs.
- cdrs_search: Searches call transcriptions for specific keywords or phrases.
- cdrs_retranscribe: Transcribes a recorded call.
- cdrs_transcription_get: Returns a recorded call transcription.
- cdrs_get: Returns call details.
- cdrs_list_all: Returns CDRs in NDJSON format for bulk export.
- call_recording_list: Returns a paginated list of call recordings.
- call_recording_delete: Deletes a call recording.
- speech_analytics_create: Uploads an audio file for transcription. Wavix sends a POST callback to the specified callback URL when the transcription is complete.

   {

        "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.
- speech_analytics_get: Returns a transcription.
- speech_analytics_retranscribe: Retranscribes an uploaded file.
- call_webhooks_list: Returns a list of configured call webhooks. Wavix sends POST callbacks for on-call and post-call events.
- call_webhooks_create: Creates a call webhook. Wavix sends POST callbacks for on-call and post-call events.
- call_webhooks_delete: Deletes a call webhook.
- call_control_list: Returns a list of active calls.
- call_control_create: Starts an outbound call.
- call_control_get: Returns a call.
- call_control_delete: Ends an active call.
- call_control_update: Updates an active call. Only the tag field can be modified.
- call_control_answer: Answers an inbound call. Optionally initiate media streaming upon answering.
- call_control_streams_create: Starts call media streaming.
- call_control_streams_delete: Stops call media streaming.
- call_control_audio_play: Plays audio in an active call.
- call_control_audio_stop: Stops audio playback in an active call.
- call_control_collect: Collects DTMF input in an active call.
- webrtc_tokens_list: 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.
- webrtc_tokens_create: Creates a Wavix Embeddable widget token.
- webrtc_tokens_get: Returns a Wavix Embeddable widget token configuration.
- webrtc_tokens_update: Updates the payload for a Wavix Embeddable widget token.
- webrtc_tokens_delete: 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.
- sms_and_mms_sender_ids_list: Returns a list of Sender IDs.
- sms_and_mms_sender_ids_create: Creates a Sender ID. Use the 10DLC API to create Sender IDs in the US.
- sms_and_mms_sender_ids_get: Returns a Sender ID.
- sms_and_mms_sender_ids_delete: Deletes a Sender ID.
- sms_and_mms_opt_outs_list: 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.
- sms_and_mms_opt_outs_create: Creates an opt-out for a Sender ID, 10DLC campaign,
or all outbound messages.
- sms_and_mms_messages_list: Returns a paginated list of SMS and MMS messages.
- sms_and_mms_messages_send: Sends SMS or MMS messages. MMS is supported for U.S. numbers only.
Rate limit: 20 messages per phone number in 24 hours.
- sms_and_mms_messages_get: Returns a message.
- sms_and_mms_messages_list_all: Returns SMS and MMS messages in newline-delimited JSON (NDJSON) format.
- ten_dlc_brands_list: 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.
- ten_dlc_brands_create: Registers a 10DLC Brand. TCR automatically verifies the brand identity. Only brands with VERIFIED or VETTED_VERIFIED identity status can register 10DLC Campaigns.
- ten_dlc_brands_get: Returns a 10DLC Brand.
- ten_dlc_brands_update: 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.
- ten_dlc_brands_delete: Deletes a 10DLC Brand. Brands with active campaigns cannot be deleted.
- ten_dlc_brand_appeals_list: Returns a list of brand identity verification appeals.
- ten_dlc_brand_appeals_create: 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.
- ten_dlc_brand_evidence_list: Use this method to list previously uploaded Brand appeal evidence.
- ten_dlc_brand_evidence_upload: Uploads 10DLC Brand evidence. Supported formats include .jpg, .png, .pdf, and more. File size must be under 10MB.
- ten_dlc_brand_evidence_delete: Deletes a 10DLC Brand evidence file.
- ten_dlc_brand_vettings_list: Returns a list of external vettings for a 10DLC Brand.
- ten_dlc_brand_vettings_import: Imports an existing external vetting for a 10DLC Brand.
- ten_dlc_brand_vettings_create: Requests external vetting for a 10DLC Brand. Supported providers: AEGIS, CV, WMC. Supported classes: STANDARD, ENHANCED.
- ten_dlc_brand_vetting_appeals_list: Returns a list of external vetting appeals for a 10DLC Brand.
- ten_dlc_brand_vetting_appeals_create: Submits an appeal for a 10DLC Brand external vetting.
- ten_dlc_brand_usecase_qualify: Returns the qualification results for a 10DLC Brand use case. Includes MNO-specific attributes, restrictions, and fees.
- ten_dlc_campaigns_list: 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.
- ten_dlc_brand_campaigns_list: 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.
- ten_dlc_brand_campaigns_create: Registers a 10DLC Campaign.
- ten_dlc_brand_campaigns_get: Returns a 10DLC Campaign.
- ten_dlc_brand_campaigns_update: Updates a 10DLC Campaign.
- ten_dlc_brand_campaigns_delete: Deletes a 10DLC Campaign. Associated phone numbers cannot be used as Sender IDs once the Campaign is deleted.
- ten_dlc_subscriptions_list: Returns a list of 10DLC event subscriptions.
- ten_dlc_subscriptions_create: Subscribes to Wavix 10DLC event callbacks.
- ten_dlc_subscriptions_delete: Deletes a 10DLC event subscription.
- ten_dlc_campaign_numbers_link: Links a phone number to a 10DLC Campaign. Wavix automatically creates a Sender ID once the number is approved.
- ten_dlc_campaign_numbers_unlink: Unlinks a phone number from a 10DLC Campaign. The associated Sender ID is also deleted.
- ten_dlc_campaign_numbers_list: Returns a list of phone numbers associated with a 10DLC Campaign.
- ten_dlc_campaigns_nudge: 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.
- number_validator_get: Returns details for a phone number.
- number_validator_create_bulk: Returns details for multiple phone numbers. If async is true, returns a token to poll for results.
- number_validator_results_get: Returns asynchronous validation results.
- voice_campaigns_create: Triggers an outbound call based on a pre-configured scenario.
- voice_campaigns_get: Returns a specific voice campaign.
- link_shortener_create: Creates a short link.
- link_shortener_metrics_list: Returns short link metrics.
- two_fa_verification_create: 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:
1. Create a Verification to generate and send an OTP.
2. Reuse the same Verification to resend the OTP if needed.
3. 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.
- two_fa_sessions_list: Returns a list of 2FA verifications. Filter by service or date.
- two_fa_verification_resend: Resends the verification code using the specified channel. Previously sent codes are invalidated.
- two_fa_verification_check: Validates the verification code.
- two_fa_verification_cancel: 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.
- two_fa_events_list: Returns a list of events for a specific 2FA Verification.
- billing_transactions_list: Returns a paginated list of financial transactions.
- billing_invoices_list: Returns a paginated list of financial statements.
- profile_get: Returns the account profile and billing details.
- profile_update: Updates the account profile and billing details.
- profile_config_get: Returns the account balance and configuration details.
- sub_accounts_list: 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.
- sub_accounts_create: Creates a sub-account.
- sub_accounts_get: Returns a specific sub-account. Results are limited to 25 records per page by default. Use page and per_page to navigate results.
- sub_accounts_update: Updates a sub-account's configuration.
- sub_accounts_transactions_list: 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.