Skip to content

Latest commit

 

History

History
2129 lines (2065 loc) · 198 KB

README.md

File metadata and controls

2129 lines (2065 loc) · 198 KB
Raw

telnyx

Telnyx API

  • API version: 2.0.0

  • Generator version: 7.4.0

SIP trunking, SMS, MMS, Call Control and Telephony Data Services.

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

  1. Java 1.8+
  2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.telnyx.sdk</groupId>
  <artifactId>telnyx</artifactId>
  <version>3.0.0</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'telnyx' jar has been published to maven central.
    mavenLocal()       // Needed if the 'telnyx' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.telnyx.sdk:telnyx:3.0.0"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

  • target/telnyx-3.0.0.jar
  • target/lib/*.jar

Usage

To add a HTTP proxy for the API client, use ClientConfig:

import org.glassfish.jersey.apache.connector.ApacheConnectorProvider;
import org.glassfish.jersey.client.ClientConfig;
import org.glassfish.jersey.client.ClientProperties;
import com.telnyx.sdk.*;
import com.telnyx.sdk.api.AccessTokensApi;

...

ApiClient defaultClient = Configuration.getDefaultApiClient();
ClientConfig clientConfig = defaultClient.getClientConfig();
clientConfig.connectorProvider(new ApacheConnectorProvider());
clientConfig.property(ClientProperties.PROXY_URI, "http://proxy_url_here");
clientConfig.property(ClientProperties.PROXY_USERNAME, "proxy_username");
clientConfig.property(ClientProperties.PROXY_PASSWORD, "proxy_password");
defaultClient.setClientConfig(clientConfig);

AccessTokensApi apiInstance = new AccessTokensApi(defaultClient);

Getting Started

Please follow the installation instruction and execute the following Java code:

import com.telnyx.sdk.*;
import com.telnyx.sdk.auth.*;
import com.telnyx.sdk.model.*;
import com.telnyx.sdk.api.AccessTokensApi;

public class AccessTokensApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setBasePath("https://api.telnyx.com/v2");
        
        // Configure HTTP bearer authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setBearerToken("BEARER TOKEN");

        AccessTokensApi apiInstance = new AccessTokensApi(defaultClient);
        String id = "id_example"; // String | Identifies the resource.
        try {
            String result = apiInstance.createTelephonyCredentialToken(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessTokensApi#createTelephonyCredentialToken");
            System.err.println("Status code: " + e.getCode());
            System.err.println("Reason: " + e.getResponseBody());
            System.err.println("Response headers: " + e.getResponseHeaders());
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.telnyx.com/v2

Class Method HTTP request Description
AccessTokensApi createTelephonyCredentialToken POST /telephony_credentials/{id}/token Create an Access Token.
AddressesApi acceptAddressSuggestions POST /addresses/{id}/actions/accept_suggestions Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft.
AddressesApi createAddress POST /addresses Creates an address
AddressesApi deleteAddress DELETE /addresses/{id} Deletes an address
AddressesApi findAddresses GET /addresses List all addresses
AddressesApi getAddress GET /addresses/{id} Retrieve an address
AddressesApi validateAddress POST /addresses/actions/validate Validate an address
AdvancedOptInOptOutApi createAutorespConfig POST /messaging_profiles/{profile_id}/autoresp_configs Create Auto-Reponse Setting
AdvancedOptInOptOutApi deleteAutorespConfig DELETE /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id} Delete Auto-Response Setting
AdvancedOptInOptOutApi getAutorespConfig GET /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id} Get Auto-Response Setting
AdvancedOptInOptOutApi getAutorespConfigs GET /messaging_profiles/{profile_id}/autoresp_configs List Auto-Response Settings
AdvancedOptInOptOutApi updateAutoRespConfig PUT /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id} Update Auto-Response Setting
AssistantsApi createNewAssistantPublicAssistantsPost POST /ai/assistants Create an assistant
AssistantsApi deleteAssistantPublicAssistantsAssistantIdDelete DELETE /ai/assistants/{assistant_id} Delete an assistant
AssistantsApi getAssistantPublicAssistantsAssistantIdGet GET /ai/assistants/{assistant_id} Get an assistant
AssistantsApi getAssistantsPublicAssistantsGet GET /ai/assistants List assistants
AssistantsApi updateAssistantPublicAssistantsAssistantIdPost POST /ai/assistants/{assistant_id} Update an assistant
AudioApi audioPublicAudioTranscriptionsPost POST /ai/audio/transcriptions Transcribe speech to text (BETA)
AuthenticationProvidersApi createAuthenticationProvider POST /authentication_providers Creates an authentication provider
AuthenticationProvidersApi deleteAuthenticationProvider DELETE /authentication_providers/{id} Deletes an authentication provider
AuthenticationProvidersApi findAuthenticationProviders GET /authentication_providers List all SSO authentication providers
AuthenticationProvidersApi getAuthenticationProvider GET /authentication_providers/{id} Retrieve an authentication provider
AuthenticationProvidersApi updateAuthenticationProvider PATCH /authentication_providers/{id} Update a authentication provider
AutoRechargePreferencesApi getAutoRechargePrefs GET /payment/auto_recharge_prefs List auto recharge preferences
AutoRechargePreferencesApi updateAutoRechargePrefs PATCH /payment/auto_recharge_prefs Update auto recharge preferences
BillingApi getUserBalance GET /balance Get user balance details
BillingGroupsApi createBillingGroup POST /billing_groups Create a billing group
BillingGroupsApi deleteBillingGroup DELETE /billing_groups/{id} Delete a billing group
BillingGroupsApi getBillingGroup GET /billing_groups/{id} Get a billing group
BillingGroupsApi listBillingGroups GET /billing_groups List all billing groups
BillingGroupsApi updateBillingGroup PATCH /billing_groups/{id} Update a billing group
BrandsApi createBrandPost POST /brand Create Brand
BrandsApi deleteBrand DELETE /brand/{brandId} Delete Brand
BrandsApi getBrand GET /brand/{brandId} Get Brand
BrandsApi getBrandFeedbackById GET /brand/feedback/{brandId} Get Brand Feedback By Id
BrandsApi getBrands GET /brand List Brands
BrandsApi listExternalVettings GET /brand/{brandId}/externalVetting List External Vettings
BrandsApi postOrderExternalVetting POST /brand/{brandId}/externalVetting Order Brand External Vetting
BrandsApi putExternalVettingRecord PUT /brand/{brandId}/externalVetting Import External Vetting Record
BrandsApi revetBrand PUT /brand/{brandId}/revet Revet Brand
BrandsApi updateBrand PUT /brand/{brandId} Update Brand
BucketApi createBucket PUT /{bucketName} CreateBucket
BucketApi deleteBucket DELETE /{bucketName} DeleteBucket
BucketApi headBucket HEAD /{bucketName} HeadBucket
BucketApi listBuckets GET / ListBuckets
BucketUsageApi getBucketUsage GET /storage/buckets/{bucketName}/usage/storage Get Bucket Usage
BucketUsageApi getStorageAPIUsage GET /storage/buckets/{bucketName}/usage/api Get API Usage
BulkCredentialsApi bulkCredentialAction POST /actions/{action}/telephony_credentials Perform activate or deactivate action on all credentials filtered by the provided tag.
BulkCredentialsApi createBulkTelephonyCredentials POST /actions/bulk/telephony_credentials Creates several credentials
BulkCredentialsApi deleteTelephonyCredentials DELETE /actions/bulk/telephony_credentials Delete several credentials
BulkCredentialsApi updateBulkTelephonyCredential PATCH /actions/bulk/telephony_credentials Update several credentials
BulkPhoneNumberCampaignsApi getAssignmentTaskStatus GET /phoneNumberAssignmentByProfile/{taskId} Get Assignment Task Status
BulkPhoneNumberCampaignsApi getPhoneNumberStatus GET /phoneNumberAssignmentByProfile/{taskId}/phoneNumbers Get Phone Number Status
BulkPhoneNumberCampaignsApi postAssignMessagingProfileToCampaign POST /phoneNumberAssignmentByProfile Assign Messaging Profile To Campaign
BulkPhoneNumberOperationsApi createDeletePhoneNumbersJob POST /phone_numbers/jobs/delete_phone_numbers Delete a batch of numbers
BulkPhoneNumberOperationsApi createPhoneNumbersJobUpdateEmergencySettings POST /phone_numbers/jobs/update_emergency_settings Update the emergency settings from a batch of numbers
BulkPhoneNumberOperationsApi createUpdatePhoneNumbersJob POST /phone_numbers/jobs/update_phone_numbers Update a batch of numbers
BulkPhoneNumberOperationsApi listPhoneNumbersJobs GET /phone_numbers/jobs Lists the phone numbers jobs
BulkPhoneNumberOperationsApi retrievePhoneNumbersJob GET /phone_numbers/jobs/{id} Retrieve a phone numbers job
BulkSoleProprietorCreationApi getAllTasks GET /bulkCreation Get All Tasks
BulkSoleProprietorCreationApi getBulkCreationTaskStatus GET /bulkCreation/{taskId} Get Task Status
BulkSoleProprietorCreationApi getTaskDetailedStatus GET /bulkCreation/{taskId}/detailedStatus Get Detailed Task Status
BulkSoleProprietorCreationApi postBulkCreation POST /bulkCreation Bulk Creation
BusinessIdentityApi createBusinessIdentity POST /business_identities Creates a Business Identity
BusinessIdentityApi deleteBusinessIdentity DELETE /business_identities/{id} Delete a Business Identity
BusinessIdentityApi displayBusinessIdentity GET /business_identities/{id} Display the Business Identity
BusinessIdentityApi listBusinessIdentities GET /business_identities Lists the Business Identities owned by the current user/organization
BusinessIdentityApi updateBusinessIdentity PATCH /business_identities/{id} Update a Business Identity
CallCommandsApi answerCall POST /calls/{call_control_id}/actions/answer Answer call
CallCommandsApi bridgeCall POST /calls/{call_control_id}/actions/bridge Bridge calls
CallCommandsApi dialCall POST /calls Dial
CallCommandsApi enqueueCall POST /calls/{call_control_id}/actions/enqueue Enqueue call
CallCommandsApi gatherCall POST /calls/{call_control_id}/actions/gather Gather
CallCommandsApi gatherUsingAudio POST /calls/{call_control_id}/actions/gather_using_audio Gather using audio
CallCommandsApi gatherUsingSpeak POST /calls/{call_control_id}/actions/gather_using_speak Gather using speak
CallCommandsApi hangupCall POST /calls/{call_control_id}/actions/hangup Hangup call
CallCommandsApi leaveQueue POST /calls/{call_control_id}/actions/leave_queue Remove call from a queue
CallCommandsApi noiseSuppressionStart POST /calls/{call_control_id}/actions/suppression_start Noise Suppression Start (BETA)
CallCommandsApi noiseSuppressionStop POST /calls/{call_control_id}/actions/suppression_stop Noise Suppression Stop (BETA)
CallCommandsApi pauseCallRecording POST /calls/{call_control_id}/actions/record_pause Record pause
CallCommandsApi referCall POST /calls/{call_control_id}/actions/refer SIP Refer a call
CallCommandsApi rejectCall POST /calls/{call_control_id}/actions/reject Reject a call
CallCommandsApi resumeCallRecording POST /calls/{call_control_id}/actions/record_resume Record resume
CallCommandsApi sendDTMF POST /calls/{call_control_id}/actions/send_dtmf Send DTMF
CallCommandsApi speakCall POST /calls/{call_control_id}/actions/speak Speak text
CallCommandsApi startCallFork POST /calls/{call_control_id}/actions/fork_start Forking start
CallCommandsApi startCallPlayback POST /calls/{call_control_id}/actions/playback_start Play audio URL
CallCommandsApi startCallRecord POST /calls/{call_control_id}/actions/record_start Recording start
CallCommandsApi startCallStreaming POST /calls/{call_control_id}/actions/streaming_start Streaming start
CallCommandsApi startCallTranscription POST /calls/{call_control_id}/actions/transcription_start Transcription start
CallCommandsApi stopCallFork POST /calls/{call_control_id}/actions/fork_stop Forking stop
CallCommandsApi stopCallGather POST /calls/{call_control_id}/actions/gather_stop Gather stop
CallCommandsApi stopCallPlayback POST /calls/{call_control_id}/actions/playback_stop Stop audio playback
CallCommandsApi stopCallRecording POST /calls/{call_control_id}/actions/record_stop Recording stop
CallCommandsApi stopCallStreaming POST /calls/{call_control_id}/actions/streaming_stop Streaming stop
CallCommandsApi stopCallTranscription POST /calls/{call_control_id}/actions/transcription_stop Transcription stop
CallCommandsApi transferCall POST /calls/{call_control_id}/actions/transfer Transfer call
CallCommandsApi updateClientState PUT /calls/{call_control_id}/actions/client_state_update Update client state
CallControlApplicationsApi createCallControlApplication POST /call_control_applications Create a call control application
CallControlApplicationsApi deleteCallControlApplication DELETE /call_control_applications/{id} Delete a call control application
CallControlApplicationsApi listCallControlApplications GET /call_control_applications List call control applications
CallControlApplicationsApi retrieveCallControlApplication GET /call_control_applications/{id} Retrieve a call control application
CallControlApplicationsApi updateCallControlApplication PATCH /call_control_applications/{id} Update a call control application
CallInformationApi listConnectionActiveCalls GET /connections/{connection_id}/active_calls List all active calls for given connection
CallInformationApi retrieveCallStatus GET /calls/{call_control_id} Retrieve a call status
CallRecordingsApi createCustomStorageCredentials POST /custom_storage_credentials/{connection_id} Create a custom storage credential
CallRecordingsApi deleteCustomStorageCredentials DELETE /custom_storage_credentials/{connection_id} Delete a stored credential
CallRecordingsApi deleteRecording DELETE /recordings/{recording_id} Delete a call recording
CallRecordingsApi deleteRecordingTranscription DELETE /recording_transcriptions/{recording_transcription_id} Delete a recording transcription
CallRecordingsApi deleteRecordings DELETE /recordings/actions/delete Delete a list of call recordings
CallRecordingsApi getCustomStorageCredentials GET /custom_storage_credentials/{connection_id} Retrieve a stored credential
CallRecordingsApi getRecording GET /recordings/{recording_id} Retrieve a call recording
CallRecordingsApi getRecordingTranscription GET /recording_transcriptions/{recording_transcription_id} Retrieve a recording transcription
CallRecordingsApi getRecordingTranscriptions GET /recording_transcriptions List all recording transcriptions
CallRecordingsApi getRecordings GET /recordings List all call recordings
CallRecordingsApi updateCustomStorageCredentials PUT /custom_storage_credentials/{connection_id} Update a stored credential
CampaignApi acceptCampaign POST /campaign/acceptSharing/{campaignId} Accept Shared Campaign
CampaignApi deactivateCampaign DELETE /campaign/{campaignId} Deactivate My Campaign
CampaignApi getCampaign GET /campaign/{campaignId} Get My Campaign
CampaignApi getCampaignCost GET /campaign/usecase/cost Get Campaign Cost
CampaignApi getCampaignMnoMetadata GET /campaign/{campaignId}/mnoMetadata Get Campaign Mno Metadata
CampaignApi getCampaignOperationStatus GET /campaign/{campaignId}/operationStatus Get My Campaign Operation Status
CampaignApi getCampaignOsrAttributes GET /campaign/{campaignId}/osr/attributes Get My Osr Campaign Attributes
CampaignApi getCampaignSharingStatus GET /campaign/{campaignId}/sharing Get Sharing Status
CampaignApi getCampaigns GET /campaign List Campaigns
CampaignApi getUsecaseQualification GET /campaignBuilder/brand/{brandId}/usecase/{usecase} Qualify By Usecase
CampaignApi postCampaign POST /campaignBuilder Submit Campaign
CampaignApi updateCampaign PUT /campaign/{campaignId} Update My Campaign
CdrUsageReportsApi getUsageReportSync GET /reports/cdr_usage_reports/sync
ChannelZonesApi assignPhoneNumber POST /channel_zones/{channel_zone_id}/channel_zone_phone_numbers Assign a phone number to a channel zone
ChannelZonesApi getChannelZone GET /channel_zones/{channel_zone_id} Get a specific channel zone
ChannelZonesApi getChannelZones GET /channel_zones Get list of channel zones
ChannelZonesApi getPhoneNumbers GET /channel_zones/{channel_zone_id}/channel_zone_phone_numbers Get the list of phone numbers assigned to a channel zone
ChannelZonesApi patchChannelZone PATCH /channel_zones/{channel_zone_id} Patch a channel zone
ChannelZonesApi unassignPhoneNumber DELETE /channel_zones/{channel_zone_id}/channel_zone_phone_numbers/{phone_number} Unassign a phone number from a channel zone
ChatApi chatPublicChatCompletionsPost POST /ai/chat/completions Create a chat completion
ChatApi getModelsPublicModelsGet GET /ai/models Get available models
ChatApi postSummary POST /ai/summarize Summarize file content
ConferenceCommandsApi createConference POST /conferences Create conference
ConferenceCommandsApi holdConferenceParticipants POST /conferences/{id}/actions/hold Hold conference participants
ConferenceCommandsApi joinConference POST /conferences/{id}/actions/join Join a conference
ConferenceCommandsApi leaveConference POST /conferences/{id}/actions/leave Leave a conference
ConferenceCommandsApi listConferenceParticipants GET /conferences/{conference_id}/participants List conference participants
ConferenceCommandsApi listConferences GET /conferences List conferences
ConferenceCommandsApi muteConferenceParticipants POST /conferences/{id}/actions/mute Mute conference participants
ConferenceCommandsApi pauseConferenceRecording POST /conferences/{id}/actions/record_pause Conference recording pause
ConferenceCommandsApi playConferenceAudio POST /conferences/{id}/actions/play Play audio to conference participants
ConferenceCommandsApi resumeConferenceRecording POST /conferences/{id}/actions/record_resume Conference recording resume
ConferenceCommandsApi retrieveConference GET /conferences/{id} Retrieve a conference
ConferenceCommandsApi speakTextToConference POST /conferences/{id}/actions/speak Speak text to conference participants
ConferenceCommandsApi startConferenceRecording POST /conferences/{id}/actions/record_start Conference recording start
ConferenceCommandsApi stopConferenceAudio POST /conferences/{id}/actions/stop Stop audio being played on the conference
ConferenceCommandsApi stopConferenceRecording POST /conferences/{id}/actions/record_stop Conference recording stop
ConferenceCommandsApi unholdConferenceParticipants POST /conferences/{id}/actions/unhold Unhold conference participants
ConferenceCommandsApi unmuteConferenceParticipants POST /conferences/{id}/actions/unmute Unmute conference participants
ConferenceCommandsApi updateConference POST /conferences/{id}/actions/update Update conference participant
ConnectionsApi listConnections GET /connections List connections
ConnectionsApi retrieveConnection GET /connections/{id} Retrieve a connection
CredentialConnectionsApi checkRegistrationStatus POST /credential_connections/{id}/actions/check_registration_status Update a credential connection registration status
CredentialConnectionsApi createCredentialConnection POST /credential_connections Create a credential connection
CredentialConnectionsApi deleteCredentialConnection DELETE /credential_connections/{id} Delete a credential connection
CredentialConnectionsApi listCredentialConnections GET /credential_connections List credential connections
CredentialConnectionsApi retrieveCredentialConnection GET /credential_connections/{id} Retrieve a credential connection
CredentialConnectionsApi updateCredentialConnection PATCH /credential_connections/{id} Update a credential connection
CredentialsApi createTelephonyCredential POST /telephony_credentials Create a credential
CredentialsApi deleteTelephonyCredential DELETE /telephony_credentials/{id} Delete a credential
CredentialsApi findTelephonyCredentials GET /telephony_credentials List all credentials
CredentialsApi getTelephonyCredential GET /telephony_credentials/{id} Get a credential
CredentialsApi listTags GET /telephony_credentials/tags List all tags
CredentialsApi performCredentialAction POST /telephony_credentials/{id}/actions/{action} Perform activate or deactivate action on provided Credential
CredentialsApi updateTelephonyCredential PATCH /telephony_credentials/{id} Update a credential
CsvDownloadsApi createCsvDownload POST /phone_numbers/csv_downloads Create a CSV download
CsvDownloadsApi getCsvDownload GET /phone_numbers/csv_downloads/{id} Retrieve a CSV download
CsvDownloadsApi listCsvDownloads GET /phone_numbers/csv_downloads List CSV downloads
CustomerServiceRecordApi createCustomerServiceRecord POST /customer_service_records Create a customer service record
CustomerServiceRecordApi getCustomerServiceRecord GET /customer_service_records/{customer_service_record_id} Get a customer service record
CustomerServiceRecordApi listCustomerServiceRecords GET /customer_service_records List customer service records
CustomerServiceRecordApi verifyPhoneNumberCoverage POST /customer_service_records/phone_number_coverages Verify CSR phone number coverage
DebuggingApi listCallEvents GET /call_events List call events
DetailRecordsApi searchDetailRecords GET /detail_records Search detail records
DialogflowIntegrationApi createDialogflowConnection POST /dialogflow_connections/{connection_id} Create a Dialogflow Connection
DialogflowIntegrationApi deleteDialogflowConnection DELETE /dialogflow_connections/{connection_id} Delete stored Dialogflow Connection
DialogflowIntegrationApi getDialogflowConnection GET /dialogflow_connections/{connection_id} Retrieve stored Dialogflow Connection
DialogflowIntegrationApi updateDialogflowConnection PUT /dialogflow_connections/{connection_id} Update stored Dialogflow Connection
DocumentsApi createDocument POST /documents Upload a document
DocumentsApi deleteDocument DELETE /documents/{id} Delete a document
DocumentsApi downloadDocument GET /documents/{id}/download Download a document
DocumentsApi listDocumentLinks GET /document_links List all document links
DocumentsApi listDocuments GET /documents List all documents
DocumentsApi retrieveDocument GET /documents/{id} Retrieve a document
DocumentsApi updateDocument PATCH /documents/{id} Update a document
DynamicEmergencyAddressesApi createDynamicEmergencyAddress POST /dynamic_emergency_addresses Create a dynamic emergency address.
DynamicEmergencyAddressesApi deleteDynamicEmergencyAddress DELETE /dynamic_emergency_addresses/{id} Delete a dynamic emergency address
DynamicEmergencyAddressesApi getDynamicEmergencyAddress GET /dynamic_emergency_addresses/{id} Get a dynamic emergency address
DynamicEmergencyAddressesApi listDynamicEmergencyAddresses GET /dynamic_emergency_addresses List dynamic emergency addresses
DynamicEmergencyEndpointsApi createDynamicEmergencyEndpoint POST /dynamic_emergency_endpoints Create a dynamic emergency endpoint.
DynamicEmergencyEndpointsApi deleteDynamicEmergencyEndpoint DELETE /dynamic_emergency_endpoints/{id} Delete a dynamic emergency endpoint
DynamicEmergencyEndpointsApi getDynamicEmergencyEndpoint GET /dynamic_emergency_endpoints/{id} Get a dynamic emergency endpoint
DynamicEmergencyEndpointsApi listDynamicEmergencyEndpoints GET /dynamic_emergency_endpoints List dynamic emergency endpoints
EmbeddingsApi embeddingBucketFilesPublicEmbeddingBucketsBucketNameDelete DELETE /ai/embeddings/buckets/{bucket_name} Disable AI for an Embedded Bucket
EmbeddingsApi getBucketName GET /ai/embeddings/buckets/{bucket_name} Get file-level embedding statuses for a bucket
EmbeddingsApi getEmbeddingBuckets GET /ai/embeddings/buckets List embedded buckets
EmbeddingsApi getEmbeddingTask GET /ai/embeddings/{task_id} Get an embedding task's status
EmbeddingsApi postEmbedding POST /ai/embeddings Embed documents
EmbeddingsApi postEmbeddingSimilaritySearch POST /ai/embeddings/similarity-search Search for documents
EnumApi getEnumEndpoint GET /enum/{endpoint} Get Enum
ErrorApi listErrorCodes GET /error List Error Codes
ExternalConnectionsApi createExternalConnection POST /external_connections Creates an External Connection
ExternalConnectionsApi createExternalConnectionUpload POST /external_connections/{id}/uploads Creates an Upload request
ExternalConnectionsApi deleteExternalConnection DELETE /external_connections/{id} Deletes an External Connection
ExternalConnectionsApi deleteExternalConnectionLogMessage DELETE /external_connections/log_messages/{id} Dismiss a log message
ExternalConnectionsApi getExternalConnection GET /external_connections/{id} Retrieve an External Connection
ExternalConnectionsApi getExternalConnectionCivicAddress GET /external_connections/{id}/civic_addresses/{address_id} Retrieve a Civic Address
ExternalConnectionsApi getExternalConnectionLogMessage GET /external_connections/log_messages/{id} Retrieve a log message
ExternalConnectionsApi getExternalConnectionPhoneNumber GET /external_connections/{id}/phone_numbers/{phone_number_id} Retrieve a phone number
ExternalConnectionsApi getExternalConnectionRelease GET /external_connections/{id}/releases/{release_id} Retrieve a Release request
ExternalConnectionsApi getExternalConnectionUpload GET /external_connections/{id}/uploads/{ticket_id} Retrieve an Upload request
ExternalConnectionsApi getExternalConnectionUploadsStatus GET /external_connections/{id}/uploads/status Get the count of pending upload requests
ExternalConnectionsApi listCivicAddresses GET /external_connections/{id}/civic_addresses List all civic addresses and locations
ExternalConnectionsApi listExternalConnectionLogMessages GET /external_connections/log_messages List all log messages
ExternalConnectionsApi listExternalConnectionPhoneNumbers GET /external_connections/{id}/phone_numbers List all phone numbers
ExternalConnectionsApi listExternalConnectionReleases GET /external_connections/{id}/releases List all Releases
ExternalConnectionsApi listExternalConnectionUploads GET /external_connections/{id}/uploads List all Upload requests
ExternalConnectionsApi listExternalConnections GET /external_connections List all External Connections
ExternalConnectionsApi refreshExternalConnectionUploads POST /external_connections/{id}/uploads/refresh Refresh the status of all Upload requests
ExternalConnectionsApi retryUpload POST /external_connections/{id}/uploads/{ticket_id}/retry Retry an Upload request
ExternalConnectionsApi updateExternalConnection PATCH /external_connections/{id} Update an External Connection
ExternalConnectionsApi updateExternalConnectionPhoneNumber PATCH /external_connections/{id}/phone_numbers/{phone_number_id} Update a phone number
ExternalConnectionsApi updateLocation PATCH /v2/external_connections/{id}/locations/{location_id} Update a location's static emergency address
FqdnConnectionsApi createFqdnConnection POST /fqdn_connections Create an FQDN connection
FqdnConnectionsApi deleteFqdnConnection DELETE /fqdn_connections/{id} Delete an FQDN connection
FqdnConnectionsApi listFqdnConnections GET /fqdn_connections List FQDN connections
FqdnConnectionsApi retrieveFqdnConnection GET /fqdn_connections/{id} Retrieve an FQDN connection
FqdnConnectionsApi updateFqdnConnection PATCH /fqdn_connections/{id} Update an FQDN connection
FqdnsApi createFqdn POST /fqdns Create an FQDN
FqdnsApi deleteFqdn DELETE /fqdns/{id} Delete an FQDN
FqdnsApi listFqdns GET /fqdns List FQDNs
FqdnsApi retrieveFqdn GET /fqdns/{id} Retrieve an FQDN
FqdnsApi updateFqdn PATCH /fqdns/{id} Update an FQDN
GlobalIpsApi createGlobalIp POST /global_ips Create a Global IP
GlobalIpsApi createGlobalIpAssignment POST /global_ip_assignments Create a Global IP assignment
GlobalIpsApi createGlobalIpHealthCheck POST /global_ip_health_checks Create a Global IP health check
GlobalIpsApi deleteGlobalIp DELETE /global_ips/{id} Delete a Global IP
GlobalIpsApi deleteGlobalIpAssignment DELETE /global_ip_assignments/{id} Delete a Global IP assignment
GlobalIpsApi deleteGlobalIpHealthCheck DELETE /global_ip_health_checks/{id} Delete a Global IP health check
GlobalIpsApi getGlobalIp GET /global_ips/{id} Retrieve a Global IP
GlobalIpsApi getGlobalIpAssignment GET /global_ip_assignments/{id} Retrieve a Global IP
GlobalIpsApi getGlobalIpAssignmentHealth GET /global_ip_assignment_health
GlobalIpsApi getGlobalIpAssignmentUsage GET /global_ip_assignments_usage
GlobalIpsApi getGlobalIpHealthCheck GET /global_ip_health_checks/{id} Retrieve a Global IP health check
GlobalIpsApi getGlobalIpLatency GET /global_ip_latency
GlobalIpsApi getGlobalIpUsage GET /global_ip_usage
GlobalIpsApi listGlobalIpAllowedPorts GET /global_ip_allowed_ports List all Global IP Allowed Ports
GlobalIpsApi listGlobalIpAssignments GET /global_ip_assignments List all Global IP assignments
GlobalIpsApi listGlobalIpHealthCheckTypes GET /global_ip_health_check_types List all Global IP Health check types
GlobalIpsApi listGlobalIpHealthChecks GET /global_ip_health_checks List all Global IP health checks
GlobalIpsApi listGlobalIpProtocols GET /global_ip_protocols List all Global IP Protocols
GlobalIpsApi listGlobalIps GET /global_ips List all Global IPs
GlobalIpsApi updateGlobalIpAssignment PATCH /global_ip_assignments/{id} Update a Global IP assignment
InboundChannelsApi listInboundChannels GET /phone_numbers/inbound_channels List your inbound channels
InboundChannelsApi updateOutboundChannels PATCH /phone_numbers/inbound_channels Update inbound channels
InventoryLevelApi createInventoryCoverage GET /inventory_coverage Create an inventory coverage request
IpAddressesApi createAccessIpAddress POST /access_ip_address Create new Access IP Address
IpAddressesApi deleteAccessIpAddress DELETE /access_ip_address/{access_ip_address_id} Delete access IP address
IpAddressesApi getAccessIpAddress GET /access_ip_address/{access_ip_address_id} Retrieve an access IP address
IpAddressesApi listAccessIpAddresses GET /access_ip_address List all Access IP Addresses
IpConnectionsApi createIpConnection POST /ip_connections Create an Ip connection
IpConnectionsApi deleteIpConnection DELETE /ip_connections/{id} Delete an Ip connection
IpConnectionsApi listIpConnections GET /ip_connections List Ip connections
IpConnectionsApi retrieveIpConnection GET /ip_connections/{id} Retrieve an Ip connection
IpConnectionsApi updateIpConnection PATCH /ip_connections/{id} Update an Ip connection
IpRangesApi accessIpRangesAccessIpRangeIdDelete DELETE /access_ip_ranges/{access_ip_range_id} Delete access IP ranges
IpRangesApi createAccessIPRange POST /access_ip_ranges Create new Access IP Range
IpRangesApi listAccessIpRanges GET /access_ip_ranges List all Access IP Ranges
IpsApi createIp POST /ips Create an Ip
IpsApi deleteIp DELETE /ips/{id} Delete an Ip
IpsApi listIps GET /ips List Ips
IpsApi retrieveIp GET /ips/{id} Retrieve an Ip
IpsApi updateIp PATCH /ips/{id} Update an Ip
ManagedAccountsApi createManagedAccount POST /managed_accounts Create a new managed account.
ManagedAccountsApi disableManagedAccount POST /managed_accounts/{id}/actions/disable Disables a managed account
ManagedAccountsApi enableManagedAccount POST /managed_accounts/{id}/actions/enable Enables a managed account
ManagedAccountsApi listAllocatableGlobalOutboundChannels GET /managed_accounts/allocatable_global_outbound_channels Display information about allocatable global outbound channels for the current user.
ManagedAccountsApi listManagedAccounts GET /managed_accounts Lists accounts managed by the current user.
ManagedAccountsApi retrieveManagedAccount GET /managed_accounts/{id} Retrieve a managed account
ManagedAccountsApi updateManagedAccount PATCH /managed_accounts/{id} Update a managed account
ManagedAccountsApi updateManagedAccountGlobalChannelLimit PATCH /managed_accounts/{id}/update_global_channel_limit Update the amount of allocatable global outbound channels allocated to a specific managed account.
MdrDetailReportsApi deleteMdrRequest DELETE /reports/batch_mdr_reports/{id}
MdrDetailReportsApi getCdrRequests GET /reports/batch_mdr_reports
MdrDetailReportsApi getMdrRequest GET /reports/batch_mdr_reports/{id}
MdrDetailReportsApi getPaginatedMdrs GET /reports/mdrs
MdrDetailReportsApi submitMdrRequest POST /reports/batch_mdr_reports
MdrUsageReportsApi deleteUsageReport DELETE /reports/mdr_usage_reports/{id}
MdrUsageReportsApi getUsageReport GET /reports/mdr_usage_reports/{id}
MdrUsageReportsApi getUsageReportSync GET /reports/mdr_usage_reports/sync
MdrUsageReportsApi getUsageReports GET /reports/mdr_usage_reports
MdrUsageReportsApi submitUsageReport POST /reports/mdr_usage_reports
MediaStorageApiApi createMediaStorage POST /media Upload media
MediaStorageApiApi deleteMediaStorage DELETE /media/{media_name} Deletes stored media
MediaStorageApiApi downloadMedia GET /media/{media_name}/download Download stored media
MediaStorageApiApi getMediaStorage GET /media/{media_name} Retrieve stored media
MediaStorageApiApi listMediaStorage GET /media List uploaded media
MediaStorageApiApi updateMediaStorage PUT /media/{media_name} Update stored media
MessagesApi createGroupMmsMessage POST /messages/group_mms Send a group MMS message
MessagesApi createLongCodeMessage POST /messages/long_code Send a long code message
MessagesApi createNumberPoolMessage POST /messages/number_pool Send a message using number pool
MessagesApi createShortCodeMessage POST /messages/short_code Send a short code message
MessagesApi getMessage GET /messages/{id} Retrieve a message
MessagesApi sendMessage POST /messages Send a message
MessagingHostedNumberApi createMessagingHostedNumberOrder POST /messaging_hosted_number_orders Create a messaging hosted number order
MessagingHostedNumberApi deleteMessagingHostedNumber DELETE /messaging_hosted_numbers/{id} Delete a messaging hosted number
MessagingHostedNumberApi getMessagingHostedNumberOrder GET /messaging_hosted_number_orders/{id} Retrieve a messaging hosted number order
MessagingHostedNumberApi listMessagingHostedNumberOrders GET /messaging_hosted_number_orders List messaging hosted number orders
MessagingHostedNumberApi uploadMessagingHostedNumberOrderFile POST /messaging_hosted_number_orders/{id}/actions/file_upload Upload file required for a messaging hosted number order
MessagingProfilesApi createMessagingProfile POST /messaging_profiles Create a messaging profile
MessagingProfilesApi deleteMessagingProfile DELETE /messaging_profiles/{id} Delete a messaging profile
MessagingProfilesApi getMessagingProfileMetrics GET /messaging_profiles/{id}/metrics Retrieve messaging profile metrics
MessagingProfilesApi listMessagingProfiles GET /messaging_profiles List messaging profiles
MessagingProfilesApi listProfileMetrics GET /messaging_profile_metrics List messaging profile metrics
MessagingProfilesApi listProfilePhoneNumbers GET /messaging_profiles/{id}/phone_numbers List phone numbers associated with a messaging profile
MessagingProfilesApi listProfileShortCodes GET /messaging_profiles/{id}/short_codes List short codes associated with a messaging profile
MessagingProfilesApi retrieveMessagingProfile GET /messaging_profiles/{id} Retrieve a messaging profile
MessagingProfilesApi updateMessagingProfile PATCH /messaging_profiles/{id} Update a messaging profile
MessagingTollfreeVerificationApi deleteVerificationRequest DELETE /messaging_tollfree/verification/requests/{id} Delete Verification Request
MessagingTollfreeVerificationApi getVerificationRequest GET /messaging_tollfree/verification/requests/{id} Get Verification Request
MessagingTollfreeVerificationApi listVerificationRequests GET /messaging_tollfree/verification/requests List Verification Requests
MessagingTollfreeVerificationApi submitVerificationRequest POST /messaging_tollfree/verification/requests Submit Verification Request
MessagingTollfreeVerificationApi updateVerificationRequest PATCH /messaging_tollfree/verification/requests/{id} Update Verification Request
MessagingUrlDomainsApi listMessagingUrlDomains GET /messaging_url_domains List messaging URL domains
MobileNetworkOperatorsApi getMobileNetworkOperators GET /mobile_network_operators List mobile network operators
NetworksApi createDefaultGateway POST /networks/{id}/default_gateway Create Default Gateway.
NetworksApi createNetwork POST /networks Create a Network
NetworksApi deleteDefaultGateway DELETE /networks/{id}/default_gateway Delete Default Gateway.
NetworksApi deleteNetwork DELETE /networks/{id} Delete a Network
NetworksApi getDefaultGateway GET /networks/{id}/default_gateway Get Default Gateway status.
NetworksApi getNetwork GET /networks/{id} Retrieve a Network
NetworksApi listNetworkInterfaces GET /networks/{id}/network_interfaces List all Interfaces for a Network.
NetworksApi listNetworks GET /networks List all Networks
NetworksApi updateNetwork PATCH /networks/{id} Update a Network
NotificationsApi createNotificationChannels POST /notification_channels Create a notification channel
NotificationsApi createNotificationProfile POST /notification_profiles Create a notification profile
NotificationsApi createNotificationSetting POST /notification_settings Add a Notification Setting
NotificationsApi deleteNotificationChannel DELETE /notification_channels/{id} Delete a notification channel
NotificationsApi deleteNotificationProfile DELETE /notification_profiles/{id} Delete a notification profile
NotificationsApi deleteNotificationSetting DELETE /notification_settings/{id} Delete a notification setting
NotificationsApi findNotificationsEvents GET /notification_events List all Notifications Events
NotificationsApi findNotificationsEventsConditions GET /notification_event_conditions List all Notifications Events Conditions
NotificationsApi findNotificationsProfiles GET /notification_profiles List all Notifications Profiles
NotificationsApi getNotificationChannel GET /notification_channels/{id} Get a notification channel
NotificationsApi getNotificationProfile GET /notification_profiles/{id} Get a notification profile
NotificationsApi getNotificationSetting GET /notification_settings/{id} Get a notification setting
NotificationsApi listNotificationChannels GET /notification_channels List notification channels
NotificationsApi listNotificationSettings GET /notification_settings List notification settings
NotificationsApi updateNotificationChannel PATCH /notification_channels/{id} Update a notification channel
NotificationsApi updateNotificationProfile PATCH /notification_profiles/{id} Update a notification profile
NumberConfigurationsApi getPhoneNumberMessagingSettings GET /phone_numbers/{id}/messaging Retrieve a phone number with messaging settings
NumberConfigurationsApi listPhoneNumbersWithMessagingSettings GET /phone_numbers/messaging List phone numbers with messaging settings
NumberConfigurationsApi updatePhoneNumberMessagingSettings PATCH /phone_numbers/{id}/messaging Update a phone number with messaging settings
NumberLookupApi lookupNumber GET /number_lookup/{phone_number} Lookup phone number data
NumberPortoutApi findPortoutComments GET /portouts/{id}/comments List all comments for a portout request
NumberPortoutApi findPortoutRequest GET /portouts/{id} Get a portout request
NumberPortoutApi getPortRequestSupportingDocuments GET /portouts/{id}/supporting_documents List supporting documents on a portout request
NumberPortoutApi listPortoutRequest GET /portouts List portout requests
NumberPortoutApi postPortRequestComment POST /portouts/{id}/comments Create a comment on a portout request
NumberPortoutApi postPortRequestSupportingDocuments POST /portouts/{id}/supporting_documents Create a list of supporting documents on a portout request
NumberPortoutApi updatePortoutStatus PATCH /portouts/{id}/{status} Update Status
NumbersFeaturesApi postNumbersFeatures POST /numbers_features Retrieve the features for a list of numbers
ObjectApi deleteObject DELETE /{bucketName}/{objectName} DeleteObject
ObjectApi deleteObjects POST /{bucketName} DeleteObjects
ObjectApi getObject GET /{bucketName}/{objectName} GetObject
ObjectApi headObject HEAD /{bucketName}/{objectName} HeadObject
ObjectApi listObjects GET /{bucketName} ListObjectsV2
ObjectApi putObject PUT /{bucketName}/{objectName} PutObject
OtaUpdatesApi getOtaUpdate GET /ota_updates/{id} Get OTA update
OtaUpdatesApi listOtaUpdates GET /ota_updates List OTA updates
OutboundVoiceProfilesApi createVoiceProfile POST /outbound_voice_profiles Create an outbound voice profile
OutboundVoiceProfilesApi deleteOutboundVoiceProfile DELETE /outbound_voice_profiles/{id} Delete an outbound voice profile
OutboundVoiceProfilesApi getOutboundVoiceProfile GET /outbound_voice_profiles/{id} Retrieve an outbound voice profile
OutboundVoiceProfilesApi listOutboundVoiceProfiles GET /outbound_voice_profiles Get all outbound voice profiles
OutboundVoiceProfilesApi updateOutboundVoiceProfile PATCH /outbound_voice_profiles/{id} Updates an existing outbound voice profile.
PhoneNumberBlockOrdersApi createNumberBlockOrder POST /number_block_orders Create a number block order
PhoneNumberBlockOrdersApi listNumberBlockOrders GET /number_block_orders List number block orders
PhoneNumberBlockOrdersApi retrieveNumberBlockOrder GET /number_block_orders/{number_block_order_id} Retrieve a number block order
PhoneNumberBlocksBackgroundJobsApi createPhoneNumberBlockDeletionJob POST /phone_number_blocks/jobs/delete_phone_number_block Deletes all numbers associated with a phone number block
PhoneNumberBlocksBackgroundJobsApi getPhoneNumberBlocksJob GET /phone_number_blocks/jobs/{id} Retrieves a phone number blocks job
PhoneNumberBlocksBackgroundJobsApi listPhoneNumberBlocksJobs GET /phone_number_blocks/jobs Lists the phone number blocks jobs
PhoneNumberCampaignsApi createPhoneNumberCampaign POST /phoneNumberCampaign Create New Phone Number Campaign
PhoneNumberCampaignsApi createPhoneNumberCampaign_0 PUT /phoneNumberCampaign/{phoneNumber} Create New Phone Number Campaign
PhoneNumberCampaignsApi createPhoneNumberCampaign_1 POST /phone_number_campaigns Create New Phone Number Campaign
PhoneNumberCampaignsApi deletePhoneNumberCampaign DELETE /phoneNumberCampaign/{phoneNumber} Delete Phone Number Campaign
PhoneNumberCampaignsApi deletePhoneNumberCampaign_0 DELETE /phone_number_campaigns/{phoneNumber} Delete Phone Number Campaign
PhoneNumberCampaignsApi getAllPhoneNumberCampaigns GET /phoneNumberCampaign Retrieve All Phone Number Campaigns
PhoneNumberCampaignsApi getAllPhoneNumberCampaigns_0 GET /phone_number_campaigns Retrieve All Phone Number Campaigns
PhoneNumberCampaignsApi getPhoneNumberCampaign GET /phoneNumberCampaign/{phoneNumber} Get Single Phone Number Campaign
PhoneNumberCampaignsApi getSinglePhoneNumberCampaign GET /phone_number_campaigns/{phoneNumber} Get Single Phone Number Campaign
PhoneNumberCampaignsApi putPhoneNumberCampaign PUT /phone_number_campaigns/{phoneNumber} Create New Phone Number Campaign
PhoneNumberConfigurationsApi deletePhoneNumber DELETE /phone_numbers/{id} Delete a phone number
PhoneNumberConfigurationsApi enablePhoneNumberEmergency POST /phone_numbers/{id}/actions/enable_emergency Enable emergency for a phone number
PhoneNumberConfigurationsApi getPhoneNumberVoiceSettings GET /phone_numbers/{id}/voice Retrieve a phone number with voice settings
PhoneNumberConfigurationsApi listPhoneNumbers GET /phone_numbers List phone numbers
PhoneNumberConfigurationsApi listPhoneNumbersWithVoiceSettings GET /phone_numbers/voice List phone numbers with voice settings
PhoneNumberConfigurationsApi retrievePhoneNumber GET /phone_numbers/{id} Retrieve a phone number
PhoneNumberConfigurationsApi slimListPhoneNumbers GET /phone_numbers/slim Slim List phone numbers
PhoneNumberConfigurationsApi updatePhoneNumber PATCH /phone_numbers/{id} Update a phone number
PhoneNumberConfigurationsApi updatePhoneNumberVoiceSettings PATCH /phone_numbers/{id}/voice Update a phone number with voice settings
PhoneNumberOrderDocumentsApi createNumberOrderDocument POST /number_order_documents Create a number order document
PhoneNumberOrderDocumentsApi listNumberOrderDocuments GET /number_order_documents List number order documents
PhoneNumberOrderDocumentsApi retrieveNumberOrderDocument GET /number_order_documents/{number_order_document_id} Retrieve a number order document
PhoneNumberOrderDocumentsApi updateNumberOrderDocument PATCH /number_order_documents/{number_order_document_id} Update a number order document
PhoneNumberOrdersApi createComment POST /comments Create a comment
PhoneNumberOrdersApi createNumberOrder POST /number_orders Create a number order
PhoneNumberOrdersApi getNumberOrderPhoneNumber GET /number_order_phone_numbers/{number_order_phone_number_id} Retrieve a number order phone number.
PhoneNumberOrdersApi getSubNumberOrder GET /sub_number_orders/{sub_number_order_id} Retrieve a sub number order
PhoneNumberOrdersApi listComments GET /comments Retrieve all comments
PhoneNumberOrdersApi listNumberOrders GET /number_orders List number orders
PhoneNumberOrdersApi listRegulatoryRequirements GET /phone_numbers_regulatory_requirements Retrieve regulartory requirements
PhoneNumberOrdersApi listSubNumberOrders GET /sub_number_orders List sub number orders
PhoneNumberOrdersApi markCommentRead PATCH /comments/{id}/read Mark a comment as read
PhoneNumberOrdersApi retrieveComment GET /comments/{id} Retrieve a comment
PhoneNumberOrdersApi retrieveNumberOrder GET /number_orders/{number_order_id} Retrieve a number order
PhoneNumberOrdersApi retrieveOrderPhoneNumbers GET /number_order_phone_numbers Retrieve a list of phone numbers associated to orders
PhoneNumberOrdersApi updateNumberOrder PATCH /number_orders/{number_order_id} Update a number order
PhoneNumberOrdersApi updateNumberOrderPhoneNumber PATCH /number_order_phone_numbers/{number_order_phone_number_id} Update a number order phone number.
PhoneNumberOrdersApi updateSubNumberOrder PATCH /sub_number_orders/{sub_number_order_id} Update a sub number order
PhoneNumberPortingApi postPortabilityCheck POST /portability_checks Run a portability check
PhoneNumberReservationsApi createNumberReservation POST /number_reservations Create a number reservation
PhoneNumberReservationsApi extendNumberReservationExpiryTime POST /number_reservations/{number_reservation_id}/actions/extend Extend a number reservation
PhoneNumberReservationsApi listNumberReservations GET /number_reservations List number reservations
PhoneNumberReservationsApi retrieveNumberReservation GET /number_reservations/{number_reservation_id} Retrieve a number reservation
PhoneNumberSearchApi listAvailablePhoneNumberBlocks GET /available_phone_number_blocks List available phone number blocks
PhoneNumberSearchApi listAvailablePhoneNumbers GET /available_phone_numbers List available phone numbers
PortingOrderApi activatePortingOrder POST /porting_orders/{id}/actions/activate Activate every number in a porting order asynchronously.
PortingOrderApi cancelPortingOrder POST /porting_orders/{id}/actions/cancel Cancel a porting order
PortingOrderApi confirmPortingOrder POST /porting_orders/{id}/actions/confirm Submit a porting order.
PortingOrderApi createAdditionalDocuments POST /porting_orders/{id}/additional_documents Create a list of additional documents
PortingOrderApi createComment POST /porting_orders/{id}/comments Create a comment for a porting order
PortingOrderApi createLoaConfiguration POST /porting/loa_configurations Create a LOA configuration
PortingOrderApi createPhoneNumberConfigurations POST /porting_orders/phone_number_configurations Create a list of phone number configurations
PortingOrderApi createPortingOrder POST /porting_orders Create a porting order
PortingOrderApi createPortingReport POST /porting/reports Create a porting related report
PortingOrderApi deleteAdditionalDocument DELETE /porting_orders/{id}/additional_documents/{additional_document_id} Delete an additional document
PortingOrderApi deleteLoaConfiguration DELETE /porting/loa_configurations/{id} Delete a LOA configuration
PortingOrderApi deletePortingOrder DELETE /porting_orders/{id} Delete a porting order
PortingOrderApi getLoaConfiguration GET /porting/loa_configurations/{id} Retrieve a LOA configuration
PortingOrderApi getPortingOrder GET /porting_orders/{id} Retrieve a porting order
PortingOrderApi getPortingOrderLoaTemplate GET /porting_orders/{id}/loa_template Download a porting order loa template
PortingOrderApi getPortingOrderSubRequest GET /porting_orders/{id}/sub_request Retrieve the associated V1 sub_request_id and port_request_id
PortingOrderApi getPortingOrdersActivationJob GET /porting_orders/{id}/activation_jobs/{activationJobId} Retrieve a porting activation job
PortingOrderApi getPortingReport GET /porting/reports/{id} Retrieve a report
PortingOrderApi listAdditionalDocuments GET /porting_orders/{id}/additional_documents List additional documents
PortingOrderApi listAllowedFocWindows GET /porting_orders/{id}/allowed_foc_windows List allowed FOC dates
PortingOrderApi listExceptionTypes GET /porting_orders/exception_types List all exception types
PortingOrderApi listLoaConfigurations GET /porting/loa_configurations List LOA configurations
PortingOrderApi listPhoneNumberConfigurations GET /porting_orders/phone_number_configurations List all phone number configurations
PortingOrderApi listPortingOrderActivationJobs GET /porting_orders/{id}/activation_jobs List all porting activation jobs
PortingOrderApi listPortingOrderComments GET /porting_orders/{id}/comments List all comments of a porting order
PortingOrderApi listPortingOrderRequirements GET /porting_orders/{id}/requirements List porting order requirements
PortingOrderApi listPortingOrders GET /porting_orders List all porting orders
PortingOrderApi listPortingPhoneNumbers GET /porting_phone_numbers List all porting phone numbers
PortingOrderApi listPortingReports GET /porting/reports List porting related reports
PortingOrderApi listVerificationCodes GET /porting_orders/{id}/verification_codes List verification codes
PortingOrderApi previewLoaConfiguration GET /porting/loa_configurations/{id}/preview Preview a LOA configuration
PortingOrderApi previewLoaConfigurationParams POST /porting/loa_configuration/preview Preview the LOA configuration parameters
PortingOrderApi sendPortingVerificationCodes POST /porting_orders/{id}/verification_codes/send Send the verification codes
PortingOrderApi sharePortingOrder POST /porting_orders/{id}/actions/share Share a porting order
PortingOrderApi updateLoaConfiguration PATCH /porting/loa_configurations/{id} Update a LOA configuration
PortingOrderApi updatePortingOrder PATCH /porting_orders/{id} Edit a porting order
PortingOrderApi updatePortingOrdersActivationJob PATCH /porting_orders/{id}/activation_jobs/{activationJobId} Update a porting activation job
PortingOrderApi verifyPortingVerificationCodes POST /porting_orders/{id}/verification_codes/verify Verify the verification code for a list of phone numbers
PresignedObjectUrlsApi createPresignedObjectUrl POST /storage/buckets/{bucketName}/{objectName}/presigned_url Create Presigned Object URL
PrivateWirelessGatewaysApi createPrivateWirelessGateway POST /private_wireless_gateways Create a Private Wireless Gateway
PrivateWirelessGatewaysApi deleteWirelessGateway DELETE /private_wireless_gateways/{id} Delete a Private Wireless Gateway
PrivateWirelessGatewaysApi getPrivateWirelessGateway GET /private_wireless_gateways/{id} Get a Private Wireless Gateway
PrivateWirelessGatewaysApi getPrivateWirelessGateways GET /private_wireless_gateways Get all Private Wireless Gateways
ProgrammableFaxApplicationsApi createFaxApplication POST /fax_applications Creates a Fax Application
ProgrammableFaxApplicationsApi deleteFaxApplication DELETE /fax_applications/{id} Deletes a Fax Application
ProgrammableFaxApplicationsApi getFaxApplication GET /fax_applications/{id} Retrieve a Fax Application
ProgrammableFaxApplicationsApi listFaxApplications GET /fax_applications List all Fax Applications
ProgrammableFaxApplicationsApi updateFaxApplication PATCH /fax_applications/{id} Update a Fax Application
ProgrammableFaxCommandsApi cancelFax POST /faxes/{id}/actions/cancel Cancel a fax
ProgrammableFaxCommandsApi deleteFax DELETE /faxes/{id} Delete a fax
ProgrammableFaxCommandsApi listFaxes GET /faxes View a list of faxes
ProgrammableFaxCommandsApi refreshFax POST /faxes/{id}/actions/refresh Refresh a fax
ProgrammableFaxCommandsApi sendFax POST /faxes Send a fax
ProgrammableFaxCommandsApi viewFax GET /faxes/{id} View a fax
PublicInternetGatewaysApi createPublicInternetGateway POST /public_internet_gateways Create a Public Internet Gateway
PublicInternetGatewaysApi deletePublicInternetGateway DELETE /public_internet_gateways/{id} Delete a Public Internet Gateway
PublicInternetGatewaysApi getPublicInternetGateway GET /public_internet_gateways/{id} Retrieve a Public Internet Gateway
PublicInternetGatewaysApi listPublicInternetGateways GET /public_internet_gateways List all Public Internet Gateways
PushCredentialsApi createPushCredential POST /mobile_push_credentials Creates a new mobile push credential
PushCredentialsApi deletePushCredentialById DELETE /mobile_push_credentials/{push_credential_id} Deletes a mobile push credential
PushCredentialsApi getPushCredentialById GET /mobile_push_credentials/{push_credential_id} Retrieves a mobile push credential
PushCredentialsApi listPushCredentials GET /mobile_push_credentials List mobile push credentials
QueueCommandsApi listQueueCalls GET /queues/{queue_name}/calls Retrieve calls from a queue
QueueCommandsApi retrieveCallFromQueue GET /queues/{queue_name}/calls/{call_control_id} Retrieve a call from a queue
QueueCommandsApi retrieveCallQueue GET /queues/{queue_name} Retrieve a call queue
RegionsApi listRegions GET /regions List all Regions
RegisterCallApi registerCall POST /calls/register Register the call for Google Verified Calls
ReportingApi createWdrReport POST /wireless/detail_records_reports Create a Wireless Detail Records (WDRs) Report
ReportingApi deleteWdrReport DELETE /wireless/detail_records_reports/{id} Delete a Wireless Detail Record (WDR) Report
ReportingApi getWdrReport GET /wireless/detail_records_reports/{id} Get a Wireless Detail Record (WDR) Report
ReportingApi getWdrReports GET /wireless/detail_records_reports Get all Wireless Detail Records (WDRs) Reports
ReportsApi createBillingGroupReport POST /ledger_billing_group_reports Create a ledger billing group report
ReportsApi getBillingGroupReport GET /ledger_billing_group_reports/{id} Get a ledger billing group report
RequirementTypesApi listRequirementTypes GET /requirement_types List all requirement types
RequirementTypesApi retrieveRequirementType GET /requirement_types/{id} Retrieve a requirement types
RequirementsApi listRequirements GET /requirements List all requirements
RequirementsApi retrieveDocumentRequirements GET /requirements/{id} Retrieve a document requirement
RoomCompositionsApi createRoomComposition POST /room_compositions Create a room composition.
RoomCompositionsApi deleteRoomComposition DELETE /room_compositions/{room_composition_id} Delete a room composition.
RoomCompositionsApi listRoomCompositions GET /room_compositions View a list of room compositions.
RoomCompositionsApi viewRoomComposition GET /room_compositions/{room_composition_id} View a room composition.
RoomParticipantsApi listRoomParticipants GET /room_participants View a list of room participants.
RoomParticipantsApi viewRoomParticipant GET /room_participants/{room_participant_id} View a room participant.
RoomRecordingsApi deleteRoomRecording DELETE /room_recordings/{room_recording_id} Delete a room recording.
RoomRecordingsApi deleteRoomRecordings DELETE /room_recordings Delete several room recordings in a bulk.
RoomRecordingsApi listRoomRecordings GET /room_recordings View a list of room recordings.
RoomRecordingsApi viewRoomRecording GET /room_recordings/{room_recording_id} View a room recording.
RoomSessionsApi endSession POST /room_sessions/{room_session_id}/actions/end End a room session.
RoomSessionsApi kickParticipantInSession POST /room_sessions/{room_session_id}/actions/kick Kick participants from a room session.
RoomSessionsApi listRoomParticipants GET /room_sessions/{room_session_id}/participants View a list of room participants.
RoomSessionsApi listRoomSessions GET /room_sessions View a list of room sessions.
RoomSessionsApi muteParticipantInSession POST /room_sessions/{room_session_id}/actions/mute Mute participants in room session.
RoomSessionsApi unmuteParticipantInSession POST /room_sessions/{room_session_id}/actions/unmute Unmute participants in room session.
RoomSessionsApi viewRoomSession GET /room_sessions/{room_session_id} View a room session.
RoomsApi createRoom POST /rooms Create a room.
RoomsApi deleteRoom DELETE /rooms/{room_id} Delete a room.
RoomsApi listRoomSessions GET /rooms/{room_id}/sessions View a list of room sessions.
RoomsApi listRooms GET /rooms View a list of rooms.
RoomsApi updateRoom PATCH /rooms/{room_id} Update a room.
RoomsApi viewRoom GET /rooms/{room_id} View a room.
RoomsClientTokensApi createRoomClientToken POST /rooms/{room_id}/actions/generate_join_client_token Create Client Token to join a room.
RoomsClientTokensApi refreshRoomClientToken POST /rooms/{room_id}/actions/refresh_client_token Refresh Client Token to join a room.
SharedCampaignsApi getCampaignSharingStatus GET /partnerCampaign/{campaignId}/sharing Get Sharing Status
SharedCampaignsApi getPartnerCampaignsSharedByUser GET /partnerCampaign/sharedByMe Get Partner Campaigns Shared By User
ShortCodesApi listShortCodes GET /short_codes List short codes
ShortCodesApi retrieveShortCode GET /short_codes/{id} Retrieve a short code
ShortCodesApi updateShortCode PATCH /short_codes/{id} Update short code
SimCardActionsApi getBulkSimCardAction GET /bulk_sim_card_actions/{id} Get bulk SIM card action details
SimCardActionsApi getSimCardAction GET /sim_card_actions/{id} Get SIM card action details
SimCardActionsApi listSimCardActions GET /bulk_sim_card_actions List bulk SIM card actions
SimCardActionsApi listSimCardActions_0 GET /sim_card_actions List SIM card actions
SimCardGroupActionsApi getSimCardGroupAction GET /sim_card_group_actions/{id} Get SIM card group action details
SimCardGroupActionsApi getSimCardGroupActions GET /sim_card_group_actions List SIM card group actions
SimCardGroupsApi createSimCardGroup POST /sim_card_groups Create a SIM card group
SimCardGroupsApi deleteSimCardGroup DELETE /sim_card_groups/{id} Delete a SIM card group
SimCardGroupsApi getAllSimCardGroups GET /sim_card_groups Get all SIM card groups
SimCardGroupsApi getSimCardGroup GET /sim_card_groups/{id} Get SIM card group
SimCardGroupsApi removeSimCardGroupPrivateWirelessGateway POST /sim_card_groups/{id}/actions/remove_private_wireless_gateway Request Private Wireless Gateway removal from SIM card group
SimCardGroupsApi setPrivateWirelessGatewayForSimCardGroup POST /sim_card_groups/{id}/actions/set_private_wireless_gateway Request Private Wireless Gateway assignment for SIM card group
SimCardGroupsApi updateSimCardGroup PATCH /sim_card_groups/{id} Update a SIM card group
SimCardOrdersApi createSimCardOrder POST /sim_card_orders Create a SIM card order
SimCardOrdersApi getSimCardOrder GET /sim_card_orders/{id} Get a single SIM card order
SimCardOrdersApi getSimCardOrders GET /sim_card_orders Get all SIM card orders
SimCardOrdersApi previewSimCardOrders POST /sim_card_order_preview Preview SIM card orders
SimCardsApi bulkSimCardNetworkPreferences PUT /actions/network_preferences/sim_cards Bulk Network Preferences for SIM cards
SimCardsApi deleteNetworkPreferences POST /sim_cards/{id}/actions/delete_network_preferences Delete network preferences for a SIM card
SimCardsApi deleteSIMCardNetworkPreferences DELETE /sim_cards/{sim_card_id}/network_preferences DELETE network preferences
SimCardsApi deleteSimCard DELETE /sim_cards/{id} Deletes a SIM card
SimCardsApi deleteSimCardDataUsageNotifications DELETE /sim_card_data_usage_notifications/{id} Delete SIM card data usage notifications
SimCardsApi disableSimCard POST /sim_cards/{id}/actions/disable Request a SIM card disable
SimCardsApi enableSimCard POST /sim_cards/{id}/actions/enable Request a SIM card enable
SimCardsApi getSimCard GET /sim_cards/{id} Get SIM card
SimCardsApi getSimCardActivationCode GET /sim_cards/{sim_card_id}/activation_code Get activation QR code for an eSIM
SimCardsApi getSimCardDataUsageNotification GET /sim_card_data_usage_notifications/{id} Get a single SIM card data usage notification
SimCardsApi getSimCardDeviceDetails GET /sim_cards/{sim_card_id}/device_details Get SIM card device details
SimCardsApi getSimCardNetworkPreferences GET /sim_cards/{sim_card_id}/network_preferences Get network preferences
SimCardsApi getSimCardPublicIp GET /sim_cards/{sim_card_id}/public_ip Get SIM card public IP definition
SimCardsApi getSimCards GET /sim_cards Get all SIM cards
SimCardsApi getWirelessConnectivityLogs GET /sim_cards/{sim_card_id}/wireless_connectivity_logs List wireless connectivity logs
SimCardsApi listDataUsageNotifications GET /sim_card_data_usage_notifications List SIM card data usage notifications
SimCardsApi patchSimCardDataUsageNotification PATCH /sim_card_data_usage_notifications/{id} Updates information for a SIM Card Data Usage Notification
SimCardsApi postSimCardDataUsageNotification POST /sim_card_data_usage_notifications Create a new SIM card data usage notification
SimCardsApi purchaseESim POST /actions/purchase/esims Purchase eSIMs
SimCardsApi putSimCardNetworkPreferences PUT /sim_cards/{sim_card_id}/network_preferences Set network preferences
SimCardsApi registerSimCards POST /actions/register/sim_cards Register SIM cards
SimCardsApi removeSimCardPublicIp POST /sim_cards/{id}/actions/remove_public_ip Request removing a SIM card public IP
SimCardsApi setNetworkPreference POST /sim_cards/{id}/actions/set_network_preferences Create or update network preferences for a SIM card
SimCardsApi setNetworkPreferencesBulk POST /sim_cards/actions/bulk_set_network_preferences Request bulk setting of network preferences for SIM cards.
SimCardsApi setPublicIPsBulk POST /sim_cards/actions/bulk_set_public_ips Request bulk setting SIM card public IPs.
SimCardsApi setSimCardPublicIp POST /sim_cards/{id}/actions/set_public_ip Request setting a SIM card public IP
SimCardsApi setSimCardStandby POST /sim_cards/{id}/actions/set_standby Request setting a SIM card to standby
SimCardsApi updateSimCard PATCH /sim_cards/{id} Update a SIM card
SimCardsApi validateRegistrationCodes POST /sim_cards/actions/validate_registration_codes Validate SIM cards registration codes
TeXmlApplicationsApi createTexmlApplication POST /texml_applications Creates a TeXML Application
TeXmlApplicationsApi deleteTexmlApplication DELETE /texml_applications/{id} Deletes a TeXML Application
TeXmlApplicationsApi findTexmlApplications GET /texml_applications List all TeXML Applications
TeXmlApplicationsApi getTexmlApplication GET /texml_applications/{id} Retrieve a TeXML Application
TeXmlApplicationsApi updateTexmlApplication PATCH /texml_applications/{id} Update a TeXML Application
TeXmlRestCommandsApi createTexmlSecret POST /texml/secrets Create a TeXML secret
TeXmlRestCommandsApi deleteTeXMLCallRecording DELETE /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json Delete recording resource
TeXmlRestCommandsApi deleteTexmlConferenceParticipant DELETE /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid} Delete a conference participant
TeXmlRestCommandsApi dialTexmlConferenceParticipant POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants Dial a new conference participant
TeXmlRestCommandsApi fetchTeXMLCallRecordings GET /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json Fetch recordings for a call
TeXmlRestCommandsApi fetchTeXMLConferenceRecordings GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json Fetch recordings for a conference
TeXmlRestCommandsApi getTeXMLCallRecording GET /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json Fetch recording resource
TeXmlRestCommandsApi getTeXMLCallRecordings GET /texml/Accounts/{account_sid}/Recordings.json Fetch multiple recording resources
TeXmlRestCommandsApi getTexmlCall GET /texml/Accounts/{account_sid}/Calls/{call_sid} Fetch a call
TeXmlRestCommandsApi getTexmlCalls GET /texml/Accounts/{account_sid}/Calls Fetch multiple call resources
TeXmlRestCommandsApi getTexmlConference GET /texml/Accounts/{account_sid}/Conferences/{conference_sid} Fetch a conference resource
TeXmlRestCommandsApi getTexmlConferenceParticipant GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid} Get conference participant resource
TeXmlRestCommandsApi getTexmlConferenceParticipants GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants List conference participants
TeXmlRestCommandsApi getTexmlConferenceRecordings GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings List conference recordings
TeXmlRestCommandsApi getTexmlConferences GET /texml/Accounts/{account_sid}/Conferences List conference resources
TeXmlRestCommandsApi initiateTexmlCall POST /texml/Accounts/{account_sid}/Calls Initiate an outbound call
TeXmlRestCommandsApi initiateTexmlCall_0 POST /texml/calls/{application_id} Initiate an outbound call
TeXmlRestCommandsApi startTeXMLCallRecording POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json Request recording for a call
TeXmlRestCommandsApi updateTeXMLCallRecording POST /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings/{recording_sid}.json Update recording on a call
TeXmlRestCommandsApi updateTexmlCall POST /texml/Accounts/{account_sid}/Calls/{call_sid} Update call
TeXmlRestCommandsApi updateTexmlCall_0 POST /texml/calls/{call_sid}/update Update call
TeXmlRestCommandsApi updateTexmlConference POST /texml/Accounts/{account_sid}/Conferences/{conference_sid} Update a conference resource
TeXmlRestCommandsApi updateTexmlConferenceParticipant POST /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid} Update a conference participant
TeXmlTwilioCompatibleRestCommandsApi deleteTeXMLRecordingTranscription DELETE /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json Delete a recording transcription
TeXmlTwilioCompatibleRestCommandsApi getTeXMLRecordingTranscription GET /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json Fetch a recording transcription resource
TeXmlTwilioCompatibleRestCommandsApi getTeXMLRecordingTranscriptions GET /texml/Accounts/{account_sid}/Transcriptions.json List recording transcriptions
VerifiedCallsDisplayProfileApi createProfile POST /verified_calls_display_profiles Creates a Verified Calls Display Profile
VerifiedCallsDisplayProfileApi createProfileVerificationRequest POST /verified_calls_display_profiles/{id}/verification_request Creates a Verification Request
VerifiedCallsDisplayProfileApi deleteProfile DELETE /verified_calls_display_profiles/{id} Deletes the Verified Calls Display Profile
VerifiedCallsDisplayProfileApi displayProfile GET /verified_calls_display_profiles/{id} Display the Verified Calls Display Profile
VerifiedCallsDisplayProfileApi listProfiles GET /verified_calls_display_profiles Lists the Verified Calls Display Profiles owned by the current user/organization
VerifiedCallsDisplayProfileApi updateProfile PATCH /verified_calls_display_profiles/{id} Update a Verified Calls Display Profile
VerifiedNumbersApi createVerifiedNumber POST /verified_numbers Request phone number verification
VerifiedNumbersApi deleteVerifiedNumber DELETE /verified_numbers/{phone_number} Delete a verified number
VerifiedNumbersApi getVerifiedNumber GET /verified_numbers/{phone_number} Retrieve a verified number
VerifiedNumbersApi listVerifiedNumbers GET /verified_numbers List all Verified Numbers
VerifiedNumbersApi verifyVerificationCode POST /verified_numbers/{phone_number}/actions/verify Submit verification code
VerifyApi createFlashcallVerification POST /verifications/flashcall Trigger a Flash call verification
VerifyApi createVerificationCall POST /verifications/call Trigger a Call verification
VerifyApi createVerificationSms POST /verifications/sms Trigger a SMS verification
VerifyApi createVerifyProfile POST /verify_profiles Create a Verify profile
VerifyApi deleteProfile DELETE /verify_profiles/{verify_profile_id} Delete a Verify profile
VerifyApi getVerifyProfile GET /verify_profiles/{verify_profile_id} Retrieve a Verify profile
VerifyApi listProfileMessageTemplates GET /verify_profiles/templates Retrieve a Verify profile message templates
VerifyApi listProfiles GET /verify_profiles List all Verify profiles
VerifyApi listVerifications GET /verifications/by_phone_number/{phone_number} List verifications by phone number
VerifyApi retrieveVerification GET /verifications/{verification_id} Retrieve a verification
VerifyApi updateVerifyProfile PATCH /verify_profiles/{verify_profile_id} Update a Verify profile
VerifyApi verifyVerificationCode POST /verifications/by_phone_number/{phone_number}/actions/verify Submit a verification code. Deprecation notice: `verify_profile_id' is now a mandatory field. The sunset date for this change is 2022-04-02 00:00:00.
VirtualCrossConnectsApi createVirtualCrossConnect POST /virtual_cross_connects Create a Virtual Cross Connect
VirtualCrossConnectsApi deleteVirtualCrossConnect DELETE /virtual_cross_connects/{id} Delete a Virtual Cross Connect
VirtualCrossConnectsApi getVirtualCrossConnect GET /virtual_cross_connects/{id} Retrieve a Virtual Cross Connect
VirtualCrossConnectsApi getVirtualCrossConnectRegion GET /virtual_cross_connect_regions/{id} Retrieve a Virtual Cross Connect Cloud Regions
VirtualCrossConnectsApi listVirtualCrossConnectRegions GET /virtual_cross_connect_regions List all Virtual Cross Connect Cloud Regions
VirtualCrossConnectsApi listVirtualCrossConnects GET /virtual_cross_connects List all Virtual Cross Connects
VirtualCrossConnectsApi provisionVirtualCrossConnect POST /virtual_cross_connects/{id}/actions/provision Provision a Virtual Cross Connect
VirtualCrossConnectsApi updateVirtualCrossConnect PATCH /virtual_cross_connects/{id} Update the Virtual Cross Connect
WdrDetailReportsApi getPaginatedWdrs GET /reports/wdrs
WebhooksApi getWebhookDeliveries GET /webhook_deliveries List webhook deliveries
WebhooksApi getWebhookDelivery GET /webhook_deliveries/{id} Find webhook_delivery details by ID
WireGuardInterfacesApi createWireguardInterface POST /wireguard_interfaces Create a WireGuard Interface
WireGuardInterfacesApi createWireguardPeer POST /wireguard_peers Create a WireGuard Peer
WireGuardInterfacesApi deleteWireguardInterface DELETE /wireguard_interfaces/{id} Delete a WireGuard Interface
WireGuardInterfacesApi deleteWireguardPeer DELETE /wireguard_peers/{id} Delete the WireGuard Peer
WireGuardInterfacesApi getWireguardInterface GET /wireguard_interfaces/{id} Retrieve a WireGuard Interfaces
WireGuardInterfacesApi getWireguardPeer GET /wireguard_peers/{id} Retrieve the WireGuard Peer
WireGuardInterfacesApi getWireguardPeerAllowedIp GET /wireguard_peers/{id}/allowed_ips/{child_id} Retrieve the Allowed IP
WireGuardInterfacesApi getWireguardPeerConfig GET /wireguard_peers/{id}/config Retrieve Wireguard config template for Peer
WireGuardInterfacesApi listWireguardInterfaces GET /wireguard_interfaces List all WireGuard Interfaces
WireGuardInterfacesApi listWireguardPeerAllowedIps GET /wireguard_peers/{id}/allowed_ips List all Allowed IPs for a WireGuard Peer
WireGuardInterfacesApi listWireguardPeers GET /wireguard_peers List all WireGuard Peers
WireGuardInterfacesApi updateWireguardPeer PATCH /wireguard_peers/{id} Update the WireGuard Peer

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

BearerAuth

  • Type: HTTP Bearer Token authentication

bearerAuth

  • Type: HTTP Bearer Token authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]