Sim_card_orders
GET
/sim_card_orders/{id}
Get a single SIM card order
GET
/sim_card_orders
Get all SIM card orders
POST
/sim_card_orders
Create a SIM card order
Verifications
POST
/verifications/flashcall
Trigger a Flash call verification
POST
/verifications/psd2
Trigger a PSD2 verification
POST
/verifications/sms
Trigger a SMS verification
POST
/verifications/whatsapp
Trigger a Whatsapp verification
GET
/verifications/{verification_id}
Retrieve a verification
GET
/verifications/by_phone_number/{phone_number}
List verifications by phone number
POST
/verifications/by_phone_number/{phone_number}/actions/verify
Submit a verification code
POST
/verifications/call
Trigger a Call verification
Verify_profiles
PATCH
/verify_profiles/{verify_profile_id}
Update a Verify profile
GET
/verify_profiles
List all Verify profiles
POST
/verify_profiles
Create a Verify profile
DELETE
/verify_profiles/{verify_profile_id}
Delete a Verify profile
GET
/verify_profiles/{verify_profile_id}
Retrieve a Verify profile
Actions
DELETE
/actions/bulk/telephony_credentials
Delete several credentials
PATCH
/actions/bulk/telephony_credentials
Update several credentials
POST
/actions/bulk/telephony_credentials
Creates several credentials
PUT
/actions/network_preferences/sim_cards
Bulk Network Preferences for SIM cards
POST
/actions/register/sim_cards
Register SIM cards
POST
/actions/{action}/telephony_credentials
Perform activate or deactivate action on all credentials filtered by the provided tag.
Addresses
GET
/addresses
List all addresses
POST
/addresses
Creates an address
POST
/addresses/actions/validate
Validate an address
DELETE
/addresses/{id}
Deletes an address
GET
/addresses/{id}
Retrieve an address
Authentication_providers
GET
/authentication_providers
List all SSO authentication providers
POST
/authentication_providers
Creates an authentication provider
DELETE
/authentication_providers/{id}
Deletes an authentication provider
GET
/authentication_providers/{id}
Retrieve an authentication provider
PATCH
/authentication_providers/{id}
Update a authentication provider
Calls
POST
/calls/{call_control_id}/actions/hangup
Hangup call
POST
/calls/{call_control_id}/actions/leave_queue
Remove call from a queue
POST
GET
/calls/{call_control_id}
Retrieve a call status
POST
/calls/{call_control_id}/actions/answer
Answer call
POST
/calls/{call_control_id}/actions/bridge
Bridge calls
POST
/calls/{call_control_id}/actions/enqueue
Enqueue call
POST
/calls/{call_control_id}/actions/fork_start
Forking start
POST
/calls/{call_control_id}/actions/fork_stop
Forking stop
POST
/calls/{call_control_id}/actions/gather_stop
Gather stop
POST
/calls/{call_control_id}/actions/gather_using_audio
Gather using audio
POST
/calls/{call_control_id}/actions/gather_using_speak
Gather using speak
POST
/calls/{call_control_id}/actions/playback_start
Play audio URL
POST
/calls/{call_control_id}/actions/playback_stop
Stop audio playback
POST
/calls/{call_control_id}/actions/record_pause
Record pause
POST
/calls/{call_control_id}/actions/record_resume
Record resume
POST
/calls/{call_control_id}/actions/record_start
Recording start
POST
/calls/{call_control_id}/actions/record_stop
Recording stop
POST
/calls/{call_control_id}/actions/refer
SIP Refer a call
POST
/calls/{call_control_id}/actions/reject
Reject a call
POST
/calls/{call_control_id}/actions/send_dtmf
Send DTMF
POST
/calls/{call_control_id}/actions/speak
Speak text
POST
/calls/{call_control_id}/actions/transcription_start
Transcription start
POST
/calls/{call_control_id}/actions/transcription_stop
Transcription stop
POST
/calls/{call_control_id}/actions/transfer
Transfer call
Available_phone_number_blocks
GET
/available_phone_number_blocks
List available phone number blocks
Available_phone_numbers
GET
/available_phone_numbers
List available phone numbers
Balance
GET
/balance
Retrieve user balance details
Billing_groups
GET
/billing_groups
List all billing groups
POST
/billing_groups
Create a billing group
DELETE
/billing_groups/{id}
Delete a billing group
GET
/billing_groups/{id}
Retrieve a billing group
PATCH
/billing_groups/{id}
Update a billing group
Call_control_applications
GET
/call_control_applications
List call control applications
POST
/call_control_applications
Create a call control application
DELETE
/call_control_applications/{id}
Delete a call control application
GET
/call_control_applications/{id}
Retrieve a call control application
PATCH
/call_control_applications/{id}
Update a call control application
Call_events
GET
/call_events
List call events
Comments
GET
/comments
Retrieve all comments
POST
/comments
Create a comment
GET
/comments/{id}
Retrieve a comment
PATCH
/comments/{id}/read
Mark a comment as read
Conferences
GET
/conferences
List conferences
POST
/conferences
Create conference
GET
/conferences/{conference_id}/participants
List conference participants
GET
/conferences/{id}
Retrieve a conference
POST
/conferences/{id}/actions/dial_participant
Dial a new participant into a conference
POST
/conferences/{id}/actions/hold
Hold conference participants
POST
/conferences/{id}/actions/join
Join a conference
POST
/conferences/{id}/actions/leave
Leave a conference
POST
/conferences/{id}/actions/mute
Mute conference participants
POST
/conferences/{id}/actions/play
Play audio to conference participants
POST
/conferences/{id}/actions/record_start
Conference recording start
POST
/conferences/{id}/actions/record_stop
Conference recording stop
POST
/conferences/{id}/actions/speak
Speak text to conference participants
POST
/conferences/{id}/actions/stop
Stop audio being played on the conference
POST
/conferences/{id}/actions/unhold
Unhold conference participants
POST
/conferences/{id}/actions/unmute
Unmute conference participants
POST
/conferences/{id}/actions/update
Update conference participant
Connections
GET
/connections
List connections
GET
/connections/{id}
Retrieve a connection
Credential_connections
GET
/credential_connections
List credential connections
POST
/credential_connections
Create a credential connection
DELETE
/credential_connections/{id}
Delete a credential connection
GET
/credential_connections/{id}
Retrieve a credential connection
PATCH
/credential_connections/{id}
Update a credential connection
Detail_records
GET
/detail_records
Search detail records
Messages
GET
/messages/{id}
Retrieve a message
POST
POST
/messages/long_code
Send a long code message
POST
/messages/number_pool
Send a message using number pool
POST
/messages/short_code
Send a short code message
Messaging_hosted_number_orders
GET
/messaging_hosted_number_orders
List messaging hosted number orders
POST
/messaging_hosted_number_orders
Create a messaging hosted number order
GET
/messaging_hosted_number_orders/{id}
Retrieve a messaging hosted number order
POST
/messaging_hosted_number_orders/{id}/actions/file_upload
Upload file required for a messaging hosted number order
Document_links
GET
/document_links
List all document links
Documents
GET
/documents
List all documents
POST
/documents
Upload a document
DELETE
/documents/{id}
Delete a document
GET
/documents/{id}
Retrieve a document
PATCH
/documents/{id}
Update a document
GET
/documents/{id}/download
Download a document
Fax_applications
GET
/fax_applications
List all Fax Applications
POST
/fax_applications
Creates a Fax Application
DELETE
/fax_applications/{id}
Deletes a Fax Application
GET
/fax_applications/{id}
Retrieve a Fax Application
PATCH
/fax_applications/{id}
Update a Fax Application
Faxes
GET
/faxes
View a list of faxes
POST
DELETE
GET
POST
/faxes/{id}/actions/refresh
Refresh a fax
Fqdn_connections
GET
/fqdn_connections
List FQDN connections
POST
/fqdn_connections
Create an FQDN connection
DELETE
/fqdn_connections/{id}
Delete an FQDN connection
GET
/fqdn_connections/{id}
Retrieve an FQDN connection
PATCH
/fqdn_connections/{id}
Update an FQDN connection
Fqdns
GET
POST
DELETE
/fqdns/{id}
Delete an FQDN
GET
/fqdns/{id}
Retrieve an FQDN
PATCH
/fqdns/{id}
Update an FQDN
Inventory_coverage
GET
/inventory_coverage
Create an inventory coverage request
Ip_connections
GET
/ip_connections
List Ip connections
POST
/ip_connections
Create an Ip connection
DELETE
/ip_connections/{id}
Delete an Ip connection
GET
/ip_connections/{id}
Retrieve an Ip connection
PATCH
/ip_connections/{id}
Update an Ip connection
Ledger_billing_group_reports
POST
/ledger_billing_group_reports
Create a ledger billing group report
GET
/ledger_billing_group_reports/{id}
Retrieve a ledger billing group report
Messaging_hosted_numbers
DELETE
/messaging_hosted_numbers/{id}
Delete a messaging hosted number
Managed_accounts
GET
/managed_accounts
Lists accounts managed by the current user.
POST
/managed_accounts
Create a new managed account.
GET
/managed_accounts/{id}
Retrieve a managed account
POST
/managed_accounts/{id}/actions/disable
Disables a managed account
POST
/managed_accounts/{id}/actions/enable
Enables a managed account
Media
GET
/media
List uploaded media
POST
DELETE
/media/{media_name}
Deletes stored media
GET
/media/{media_name}
Retrieve stored media
PUT
/media/{media_name}
Update stored media
GET
/media/{media_name}/download
Download stored media
Message_detail_records
GET
/message_detail_records
Fetch messaging detail records.
GET
/message_detail_records/{id}/message_body
Fetch message body by id.
Messaging_profile_metrics
GET
/messaging_profile_metrics
List messaging profile metrics
Messaging_profiles
GET
/messaging_profiles
List messaging profiles
POST
/messaging_profiles
Create a messaging profile
DELETE
/messaging_profiles/{id}
Delete a messaging profile
GET
/messaging_profiles/{id}
Retrieve a messaging profile
PATCH
/messaging_profiles/{id}
Update a messaging profile
GET
/messaging_profiles/{id}/metrics
Retrieve messaging profile metrics
GET
/messaging_profiles/{id}/phone_numbers
List phone numbers associated with a messaging profile
GET
/messaging_profiles/{id}/short_codes
List short codes associated with a messaging profile
Messaging_url_domains
GET
/messaging_url_domains
List messaging URL domains
Mobile_operator_networks
GET
/mobile_operator_networks
List mobile operator networks
Notification_channels
GET
/notification_channels
List notification channels
POST
/notification_channels
Create a notification channel
DELETE
/notification_channels/{id}
Delete a notification channel
GET
/notification_channels/{id}
Retrieve a notification channel
PATCH
/notification_channels/{id}
Update a notification channel
Reports
GET
/reports/mdr_usage_reports/{id}
Fetch a single messaging usage report by id
GET
/reports/mdrs
Fetch all Mdr records
GET
/reports/batch_mdr_reports
Fetch all previous requests for messaging detail reports. Messaging detail reports are reports for pulling all messaging records.
POST
/reports/batch_mdr_reports
Submit a request for new messaging detail report. Messaging detail report pulls all raw messaging data according to defined filters.
DELETE
/reports/batch_mdr_reports/{id}
Delete generated messaging detail report by id
GET
/reports/batch_mdr_reports/{id}
Fetch single messaging detail report by id.
GET
/reports/cdr_usage_reports/sync
Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.
GET
/reports/mdr_usage_reports
Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown
POST
/reports/mdr_usage_reports
Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period.
GET
/reports/mdr_usage_reports/sync
Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.
DELETE
/reports/mdr_usage_reports/{id}
Delete messaging usage report by id
GET
/reports/wdrs
Fetch all Wdr records
Notification_event_conditions
GET
/notification_event_conditions
List all Notifications Events Conditions
Notification_events
GET
/notification_events
List all Notifications Events
Notification_profiles
GET
/notification_profiles
List all Notifications Profiles
POST
/notification_profiles
Create a notification profile
DELETE
/notification_profiles/{id}
Delete a notification profile
GET
/notification_profiles/{id}
Retrieve a notification profile
PATCH
/notification_profiles/{id}
Update a notification profile
Notification_settings
GET
/notification_settings
List notification settings
POST
/notification_settings
Add a Notification Setting
DELETE
/notification_settings/{id}
Delete a notification setting
GET
/notification_settings/{id}
Retrieve a notification setting
Number_block_orders
GET
/number_block_orders
List number block orders
POST
/number_block_orders
Create a number block order
GET
/number_block_orders/{number_block_order_id}
Retrieve a number block order
Number_lookup
GET
/number_lookup/{phone_number}
Lookup phone number data
Number_order_documents
GET
/number_order_documents
List number order documents
POST
/number_order_documents
Create a number order document
GET
/number_order_documents/{number_order_document_id}
Retrieve a number order document
PATCH
/number_order_documents/{number_order_document_id}
Update a number order document
Number_order_phone_numbers
GET
/number_order_phone_numbers
Retrieve a list of phone numbers associated to orders
GET
/number_order_phone_numbers/{number_order_phone_number_id}
Retrieve a number order phone number.
PATCH
/number_order_phone_numbers/{number_order_phone_number_id}
Update a number order phone number.
Number_orders
GET
/number_orders
List number orders
POST
/number_orders
Create a number order
GET
/number_orders/{number_order_id}
Retrieve a number order
PATCH
/number_orders/{number_order_id}
Update a number order
Number_reservations
GET
/number_reservations
List number reservations
POST
/number_reservations
Create a number reservation
GET
/number_reservations/{number_reservation_id}
Retrieve a number reservation
POST
/number_reservations/{number_reservation_id}/actions/extend
Extend a number reservation
Ota_updates
GET
/ota_updates
List OTA updates
GET
/ota_updates/{id}
Get OTA update
Outbound_voice_profiles
GET
/outbound_voice_profiles
Get all outbound voice profiles
POST
/outbound_voice_profiles
Create an outbound voice profile
DELETE
/outbound_voice_profiles/{id}
Delete an outbound voice profile
GET
/outbound_voice_profiles/{id}
Retrieve an outbound voice profile
PATCH
/outbound_voice_profiles/{id}
Updates an existing outbound voice profile.
Phone_number_blocks
GET
/phone_number_blocks/jobs
Lists the phone number blocks jobs
POST
/phone_number_blocks/jobs/delete_phone_number_block
Deletes all numbers associated with a phone number block
GET
/phone_number_blocks/jobs/{id}
Retrieves a phone number blocks job
Phone_numbers
GET
/phone_numbers
List phone numbers
GET
/phone_numbers/csv_downloads
List CSV downloads
POST
/phone_numbers/csv_downloads
Create a CSV download
GET
/phone_numbers/csv_downloads/{id}
Retrieve a CSV download
GET
/phone_numbers/inbound_channels
Retrieve your inbound channels
PATCH
/phone_numbers/inbound_channels
Update inbound channels
GET
/phone_numbers/jobs
Lists the phone numbers jobs
POST
/phone_numbers/jobs/delete_phone_numbers
Delete a batch of numbers
POST
/phone_numbers/jobs/update_emergency_settings
Update the emergency settings from a batch of numbers
POST
/phone_numbers/jobs/update_phone_numbers
Update a batch of numbers
GET
/phone_numbers/jobs/{id}
Retrieve a phone numbers job
GET
/phone_numbers/messaging
List phone numbers with messaging settings
GET
/phone_numbers/voice
List phone numbers with voice settings
DELETE
/phone_numbers/{id}
Delete a phone number
GET
/phone_numbers/{id}
Retrieve a phone number
PATCH
/phone_numbers/{id}
Update a phone number
POST
/phone_numbers/{id}/actions/enable_emergency
Enable emergency for a phone number
GET
/phone_numbers/{id}/messaging
Retrieve a phone number with messaging settings
PATCH
/phone_numbers/{id}/messaging
Update a phone number with messaging settings
GET
/phone_numbers/{id}/voice
Retrieve a phone number with voice settings
PATCH
/phone_numbers/{id}/voice
Update a phone number with voice settings
Portability_checks
POST
/portability_checks
Run a portability check
Porting_orders
GET
/porting_orders
List all porting orders
POST
/porting_orders
Create a porting order
GET
/porting_orders/exception_types
List all exception types
DELETE
/porting_orders/{id}
Request cancellation
GET
/porting_orders/{id}
Retrieve a porting order
PATCH
/porting_orders/{id}
Edit a porting order
POST
/porting_orders/{id}/actions/activate
Activates every number on a porting order.
POST
/porting_orders/{id}/actions/cancel
Cancel this porting order
POST
/porting_orders/{id}/actions/confirm
Confirms the porting order is ready to be actioned.
GET
/porting_orders/{id}/activation_jobs
List all porting activation jobs
GET
/porting_orders/{id}/activation_jobs/{activationJobId}
Retrieve a porting activation job
GET
/porting_orders/{id}/comments
List all comments of a porting order
POST
/porting_orders/{id}/comments
Create a comment for a porting order
GET
/porting_orders/{id}/loa_template
Download a porting order loa template
Porting_phone_numbers
GET
/porting_phone_numbers
List all porting phone numbers
Portouts
GET
/portouts
Retrieve a list of portout requests
GET
/portouts/{id}
Retrieve a portout request
GET
/portouts/{id}/comments
List all comments for a portout request
POST
/portouts/{id}/comments
Create a comment on a portout request
PATCH
/portouts/{id}/{status}
Update Status
Private_wireless_gateways
GET
/private_wireless_gateways
Get all Private Wireless Gateways
POST
/private_wireless_gateways
Create a Private Wireless Gateway
DELETE
/private_wireless_gateways/{id}
Delete a Private Wireless Gateway
GET
/private_wireless_gateways/{id}
Get a Private Wireless Gateway
Queues
GET
/queues/{queue_name}
Retrieve a call queue
GET
/queues/{queue_name}/calls
Retrieve calls from a queue
GET
/queues/{queue_name}/calls/{call_control_id}
Retrieve a call from a queue
Recordings
GET
/recordings
List recordings
GET
/recordings/{id}
Retrieve a recording
Requirement_types
GET
/requirement_types
List all requirement types
GET
/requirement_types/{id}
Retrieve a requirement types
Requirements
GET
/requirements
List all requirements
GET
/requirements/{id}
Retrieve a document requirement
Room_participants
GET
/room_participants
View a list of room participants.
GET
/room_participants/{room_participant_id}
View a room participant.
Room_sessions
GET
/room_sessions
View a list of room sessions.
GET
/room_sessions/{room_session_id}
View a room session.
GET
/room_sessions/{room_session_id}/participants
View a list of room participants.
Sim_card_groups
POST
/sim_card_groups/{id}/actions/set_private_wireless_gateway
Request Private Wireless Gateway assignment for SIM card group
GET
/sim_card_groups
Get all SIM card groups
POST
/sim_card_groups
Create a SIM card group
DELETE
/sim_card_groups/{id}
Delete a SIM card group
GET
/sim_card_groups/{id}
Get SIM card group
PATCH
/sim_card_groups/{id}
Update a SIM card group
POST
/sim_card_groups/{id}/actions/remove_private_wireless_gateway
Request Private Wireless Gateway removal from SIM card group
Sim_card_order_preview
POST
/sim_card_order_preview
Preview SIM card orders
Rooms
GET
/rooms
View a list of rooms.
POST
DELETE
/rooms/{room_id}
Delete a room.
GET
/rooms/{room_id}
View a room.
POST
/rooms/{room_id}/actions/generate_join_client_token
Create Client Token to join a room.
POST
/rooms/{room_id}/actions/refresh_client_token
Refresh Client Token to join a room.
GET
/rooms/{room_id}/sessions
View a list of room sessions.
Short_codes
GET
/short_codes
List short codes
GET
/short_codes/{id}
Retrieve a short code
PATCH
/short_codes/{id}
Update short code
Sim_card_group_actions
GET
/sim_card_group_actions
List SIM card group actions
GET
/sim_card_group_actions/{id}
Get SIM card group action details
Sim_cards
GET
/sim_cards
Get all SIM cards
POST
/sim_cards/actions/validate_registration_codes
Validate SIM cards registration codes
DELETE
/sim_cards/{id}
Deletes a SIM card
GET
/sim_cards/{id}
Get SIM card
PATCH
/sim_cards/{id}
Update a SIM card
POST
/sim_cards/{id}/actions/disable
Request a SIM card disable
POST
/sim_cards/{id}/actions/enable
Request a SIM card enable
POST
/sim_cards/{id}/actions/set_standby
Request setting a SIM card to standby
DELETE
/sim_cards/{sim_card_id}/network_preferences
DELETE network preferences
GET
/sim_cards/{sim_card_id}/network_preferences
Get network preferences
PUT
/sim_cards/{sim_card_id}/network_preferences
Set network preferences
DELETE
/sim_cards/{sim_card_id}/public_ip
Delete SIM card public IP
GET
/sim_cards/{sim_card_id}/public_ip
Get SIM card public IP definition
POST
/sim_cards/{sim_card_id}/public_ip
Set SIM card public IP
GET
/sim_cards/{sim_card_id}/wireless_connectivity_logs
List wireless connectivity logs
Sub_number_orders
GET
/sub_number_orders
List sub number orders
GET
/sub_number_orders/{sub_number_order_id}
Retrieve a sub number order
PATCH
/sub_number_orders/{sub_number_order_id}
Update a sub number order
Telephony_credentials
GET
/telephony_credentials
List all credentials
POST
/telephony_credentials
Create a credential
GET
/telephony_credentials/tags
List all tags
DELETE
/telephony_credentials/{id}
Delete a credential
GET
/telephony_credentials/{id}
Get a credential
PATCH
/telephony_credentials/{id}
Update a credential
POST
/telephony_credentials/{id}/actions/{action}
Perform activate or deactivate action on provided Credential
POST
/telephony_credentials/{id}/token
Create an Access Token.
Texml_applications
GET
/texml_applications
List all TeXML Applications
POST
/texml_applications
Creates a TeXML Application
DELETE
/texml_applications/{id}
Deletes a TeXML Application
GET
/texml_applications/{id}
Retrieve a TeXML Application
PATCH
/texml_applications/{id}
Update a TeXML Application
Webhook_deliveries
GET
/webhook_deliveries
List webhook deliveries
GET
/webhook_deliveries/{id}
Find webhook_delivery details by ID
Whatsapp_contacts
POST
/whatsapp_contacts
Check Contact
Whatsapp_detail_record_reports
GET
/whatsapp_detail_record_reports
Fetch all previous requests for WhatsApp detail reports. WhatsApp detail reports are reports for pulling all WhatsApp records.
POST
/whatsapp_detail_record_reports
Submit a request for new WhatsApp detail report. WhatsApp detail report pulls all raw WhatsApp data according to defined filters.
DELETE
/whatsapp_detail_record_reports/{id}
Delete generated WhatsApp detail report by id
GET
/whatsapp_detail_record_reports/{id}
Fetch single whatsapp detail report by id.
Whatsapp_media
POST
/whatsapp_media
Upload Media
DELETE
/whatsapp_media/{whatsapp_user_id}/{media_id}
Delete Media
GET
/whatsapp_media/{whatsapp_user_id}/{media_id}
Download Media
Whatsapp_messages
POST
/whatsapp_messages
Send Message
PATCH
/whatsapp_messages/{message_id}
Mark Message As Read
Whatsapp_usage_aggregations
GET
/whatsapp_usage_aggregations
Generate and fetch WhatsApp usage aggregations synchronously. This endpoint will both generate and fetch the WhatsApp aggregations over a specified time period.
Whatsapp_users
GET
/whatsapp_users/{whatsapp_user_id}
Get User
PATCH
/whatsapp_users/{whatsapp_user_id}
Update WhatsApp User
Wireless
GET
/wireless/detail_records_reports
Get all Wireless Detail Records (WDRs) Reports
POST
/wireless/detail_records_reports
Create a Wireless Detail Records (WDRs) Report
DELETE
/wireless/detail_records_reports/{id}
Delete a Wireless Detail Record (WDR) Report
GET
/wireless/detail_records_reports/{id}
Get a Wireless Detail Record (WDR) Report