Fundamentals
Access IPs — 7 methods
Access IPs — 7 methods
| Method | Endpoint |
|---|---|
client.accessIPAddress.list() | GET /access_ip_address |
client.accessIPAddress.create() | POST /access_ip_address |
client.accessIPAddress.delete() | DELETE /access_ip_address/{access_ip_address_id} |
client.accessIPAddress.retrieve() | GET /access_ip_address/{access_ip_address_id} |
client.accessIPRanges.list() | GET /access_ip_ranges |
client.accessIPRanges.create() | POST /access_ip_ranges |
client.accessIPRanges.delete() | DELETE /access_ip_ranges/{access_ip_range_id} |
Addresses — 9 methods
Addresses — 9 methods
| Method | Endpoint |
|---|---|
client.addresses.list() | GET /addresses |
client.addresses.create() | POST /addresses |
client.addresses.delete() | DELETE /addresses/{id} |
client.addresses.retrieve() | GET /addresses/{id} |
client.addresses.actions.validate() | POST /addresses/actions/validate |
client.addresses.actions.acceptSuggestions() | POST /addresses/{id}/actions/accept_suggestions |
client.userAddresses.list() | GET /user_addresses |
client.userAddresses.create() | POST /user_addresses |
client.userAddresses.retrieve() | GET /user_addresses/{id} |
auditEvents — 1 method
auditEvents — 1 method
| Method | Endpoint |
|---|---|
client.auditEvents.list() | GET /audit_events |
authenticationProviders — 5 methods
authenticationProviders — 5 methods
| Method | Endpoint |
|---|---|
client.authenticationProviders.list() | GET /authentication_providers |
client.authenticationProviders.create() | POST /authentication_providers |
client.authenticationProviders.delete() | DELETE /authentication_providers/{id} |
client.authenticationProviders.retrieve() | GET /authentication_providers/{id} |
client.authenticationProviders.update() | PATCH /authentication_providers/{id} |
balance — 1 method
balance — 1 method
| Method | Endpoint |
|---|---|
client.balance.retrieve() | GET /balance |
billingGroups — 5 methods
billingGroups — 5 methods
| Method | Endpoint |
|---|---|
client.billingGroups.list() | GET /billing_groups |
client.billingGroups.create() | POST /billing_groups |
client.billingGroups.delete() | DELETE /billing_groups/{id} |
client.billingGroups.retrieve() | GET /billing_groups/{id} |
client.billingGroups.update() | PATCH /billing_groups/{id} |
Charges — 2 methods
Charges — 2 methods
| Method | Endpoint |
|---|---|
client.chargesBreakdown.retrieve() | GET /charges_breakdown |
client.chargesSummary.retrieve() | GET /charges_summary |
detailRecords — 1 method
detailRecords — 1 method
| Method | Endpoint |
|---|---|
client.detailRecords.list() | GET /detail_records |
Fax — 11 methods
Fax — 11 methods
| Method | Endpoint |
|---|---|
client.faxApplications.list() | GET /fax_applications |
client.faxApplications.create() | POST /fax_applications |
client.faxApplications.delete() | DELETE /fax_applications/{id} |
client.faxApplications.retrieve() | GET /fax_applications/{id} |
client.faxApplications.update() | PATCH /fax_applications/{id} |
client.faxes.list() | GET /faxes |
client.faxes.create() | POST /faxes |
client.faxes.delete() | DELETE /faxes/{id} |
client.faxes.retrieve() | GET /faxes/{id} |
client.faxes.actions.cancel() | POST /faxes/{id}/actions/cancel |
client.faxes.actions.refresh() | POST /faxes/{id}/actions/refresh |
integrationSecrets — 3 methods
integrationSecrets — 3 methods
| Method | Endpoint |
|---|---|
client.integrationSecrets.list() | GET /integration_secrets |
client.integrationSecrets.create() | POST /integration_secrets |
client.integrationSecrets.delete() | DELETE /integration_secrets/{id} |
invoices — 2 methods
invoices — 2 methods
| Method | Endpoint |
|---|---|
client.invoices.list() | GET /invoices |
client.invoices.retrieve() | GET /invoices/{id} |
managedAccounts — 8 methods
managedAccounts — 8 methods
| Method | Endpoint |
|---|---|
client.managedAccounts.list() | GET /managed_accounts |
client.managedAccounts.create() | POST /managed_accounts |
client.managedAccounts.getAllocatableGlobalOutboundChannels() | GET /managed_accounts/allocatable_global_outbound_channels |
client.managedAccounts.retrieve() | GET /managed_accounts/{id} |
client.managedAccounts.update() | PATCH /managed_accounts/{id} |
client.managedAccounts.updateGlobalChannelLimit() | PATCH /managed_accounts/{id}/update_global_channel_limit |
client.managedAccounts.actions.disable() | POST /managed_accounts/{id}/actions/disable |
client.managedAccounts.actions.enable() | POST /managed_accounts/{id}/actions/enable |
Notifications — 16 methods
Notifications — 16 methods
| Method | Endpoint |
|---|---|
client.notificationChannels.list() | GET /notification_channels |
client.notificationChannels.create() | POST /notification_channels |
client.notificationChannels.delete() | DELETE /notification_channels/{id} |
client.notificationChannels.retrieve() | GET /notification_channels/{id} |
client.notificationChannels.update() | PATCH /notification_channels/{id} |
client.notificationEventConditions.list() | GET /notification_event_conditions |
client.notificationEvents.list() | GET /notification_events |
client.notificationProfiles.list() | GET /notification_profiles |
client.notificationProfiles.create() | POST /notification_profiles |
client.notificationProfiles.delete() | DELETE /notification_profiles/{id} |
client.notificationProfiles.retrieve() | GET /notification_profiles/{id} |
client.notificationProfiles.update() | PATCH /notification_profiles/{id} |
client.notificationSettings.list() | GET /notification_settings |
client.notificationSettings.create() | POST /notification_settings |
client.notificationSettings.delete() | DELETE /notification_settings/{id} |
client.notificationSettings.retrieve() | GET /notification_settings/{id} |
OAuth — 15 methods
OAuth — 15 methods
| Method | Endpoint |
|---|---|
client.oauth.retrieveAuthorize() | GET /oauth/authorize |
client.oauth.retrieve() | GET /oauth/consent/{consent_token} |
client.oauth.grants() | POST /oauth/grants |
client.oauth.introspect() | POST /oauth/introspect |
client.oauth.retrieveJwks() | GET /oauth/jwks |
client.oauth.register() | POST /oauth/register |
client.oauth.token() | POST /oauth/token |
client.oauthClients.list() | GET /oauth_clients |
client.oauthClients.create() | POST /oauth_clients |
client.oauthClients.delete() | DELETE /oauth_clients/{id} |
client.oauthClients.retrieve() | GET /oauth_clients/{id} |
client.oauthClients.update() | PUT /oauth_clients/{id} |
client.oauthGrants.list() | GET /oauth_grants |
client.oauthGrants.delete() | DELETE /oauth_grants/{id} |
client.oauthGrants.retrieve() | GET /oauth_grants/{id} |
organizations — 4 methods
organizations — 4 methods
| Method | Endpoint |
|---|---|
client.organizations.users.list() | GET /organizations/users |
client.organizations.users.getGroupsReport() | GET /organizations/users/users_groups_report |
client.organizations.users.retrieve() | GET /organizations/users/{id} |
client.organizations.users.actions.remove() | POST /organizations/users/{id}/actions/remove |
payment — 3 methods
payment — 3 methods
| Method | Endpoint |
|---|---|
client.payment.createStoredPaymentTransaction() | POST /v2/payment/stored_payment_transactions |
client.payment.autoRechargePrefs.list() | GET /payment/auto_recharge_prefs |
client.payment.autoRechargePrefs.update() | PATCH /payment/auto_recharge_prefs |
pricing — 2 methods
pricing — 2 methods
| Method | Endpoint |
|---|---|
client.pricing.products.list() | GET /pricing/products |
client.pricing.products.retrieve() | GET /pricing/products/{slug} |
Reports — 12 methods
Reports — 12 methods
| Method | Endpoint |
|---|---|
client.ledgerBillingGroupReports.create() | POST /ledger_billing_group_reports |
client.ledgerBillingGroupReports.retrieve() | GET /ledger_billing_group_reports/{id} |
client.reports.listMdrs() | GET /reports/mdrs |
client.reports.listWdrs() | GET /reports/wdrs |
client.reports.cdrUsageReports.fetchSync() | GET /reports/cdr_usage_reports/sync |
client.reports.mdrUsageReports.list() | GET /reports/mdr_usage_reports |
client.reports.mdrUsageReports.create() | POST /reports/mdr_usage_reports |
client.reports.mdrUsageReports.fetchSync() | GET /reports/mdr_usage_reports/sync |
client.reports.mdrUsageReports.delete() | DELETE /reports/mdr_usage_reports/{id} |
client.reports.mdrUsageReports.retrieve() | GET /reports/mdr_usage_reports/{id} |
client.usageReports.list() | GET /usage_reports |
client.usageReports.getOptions() | GET /usage_reports/options |
roomCompositions — 4 methods
roomCompositions — 4 methods
| Method | Endpoint |
|---|---|
client.roomCompositions.list() | GET /room_compositions |
client.roomCompositions.create() | POST /room_compositions |
client.roomCompositions.delete() | DELETE /room_compositions/{room_composition_id} |
client.roomCompositions.retrieve() | GET /room_compositions/{room_composition_id} |
roomParticipants — 2 methods
roomParticipants — 2 methods
| Method | Endpoint |
|---|---|
client.roomParticipants.list() | GET /room_participants |
client.roomParticipants.retrieve() | GET /room_participants/{room_participant_id} |
roomRecordings — 4 methods
roomRecordings — 4 methods
| Method | Endpoint |
|---|---|
client.roomRecordings.deleteBulk() | DELETE /room_recordings |
client.roomRecordings.list() | GET /room_recordings |
client.roomRecordings.delete() | DELETE /room_recordings/{room_recording_id} |
client.roomRecordings.retrieve() | GET /room_recordings/{room_recording_id} |
rooms — 15 methods
rooms — 15 methods
sessionAnalysis — 3 methods
sessionAnalysis — 3 methods
| Method | Endpoint |
|---|---|
client.sessionAnalysis.retrieve() | GET /session_analysis/{record_type}/{event_id} |
client.sessionAnalysis.metadata.retrieve() | GET /session_analysis/metadata |
client.sessionAnalysis.metadata.retrieveRecordType() | GET /session_analysis/metadata/{record_type} |
seti — 1 method
seti — 1 method
| Method | Endpoint |
|---|---|
client.seti.retrieveBlackBoxTestResults() | GET /seti/black_box_test_results |
userTags — 1 method
userTags — 1 method
| Method | Endpoint |
|---|---|
client.userTags.list() | GET /user_tags |
webhookDeliveries — 2 methods
webhookDeliveries — 2 methods
| Method | Endpoint |
|---|---|
client.webhookDeliveries.list() | GET /webhook_deliveries |
client.webhookDeliveries.retrieve() | GET /webhook_deliveries/{id} |
wellKnown — 2 methods
wellKnown — 2 methods
| Method | Endpoint |
|---|---|
client.wellKnown.retrieveAuthorizationServerMetadata() | GET /.well-known/oauth-authorization-server |
client.wellKnown.retrieveProtectedResourceMetadata() | GET /.well-known/oauth-protected-resource |
x402 — 2 methods
x402 — 2 methods
| Method | Endpoint |
|---|---|
client.x402.creditAccount.settle() | POST /v2/x402/credit_account |
client.x402.creditAccount.createQuote() | POST /v2/x402/credit_account/quote |
AI
ai — 158 methods
ai — 158 methods
Voice
pronunciationDicts — 5 methods
pronunciationDicts — 5 methods
| Method | Endpoint |
|---|---|
client.pronunciationDicts.list() | GET /pronunciation_dicts |
client.pronunciationDicts.create() | POST /pronunciation_dicts |
client.pronunciationDicts.delete() | DELETE /pronunciation_dicts/{id} |
client.pronunciationDicts.retrieve() | GET /pronunciation_dicts/{id} |
client.pronunciationDicts.update() | PATCH /pronunciation_dicts/{id} |
speechToText — 2 methods
speechToText — 2 methods
| Method | Endpoint |
|---|---|
client.speechToText.listProviders() | GET /speech-to-text/providers |
client.speechToText.retrieveTranscription() | GET /speech-to-text/transcription |
textToSpeech — 3 methods
textToSpeech — 3 methods
| Method | Endpoint |
|---|---|
client.textToSpeech.listVoices() | GET /text-to-speech/voices |
client.textToSpeech.generateSpeech() | POST /text-to-speech/speech |
client.textToSpeech.retrieveSpeech() | GET /text-to-speech/speech |
voiceClones — 6 methods
voiceClones — 6 methods
| Method | Endpoint |
|---|---|
client.voiceClones.list() | GET /voice_clones |
client.voiceClones.create() | POST /voice_clones |
client.voiceClones.createFromUpload() | POST /voice_clones/from_upload |
client.voiceClones.delete() | DELETE /voice_clones/{id} |
client.voiceClones.update() | PATCH /voice_clones/{id} |
client.voiceClones.downloadSample() | GET /voice_clones/{id}/sample |
voiceDesigns — 7 methods
voiceDesigns — 7 methods
| Method | Endpoint |
|---|---|
client.voiceDesigns.list() | GET /voice_designs |
client.voiceDesigns.create() | POST /voice_designs |
client.voiceDesigns.delete() | DELETE /voice_designs/{id} |
client.voiceDesigns.retrieve() | GET /voice_designs/{id} |
client.voiceDesigns.rename() | PATCH /voice_designs/{id} |
client.voiceDesigns.downloadSample() | GET /voice_designs/{id}/sample |
client.voiceDesigns.deleteVersion() | DELETE /voice_designs/{id}/versions/{version} |
Compute
Global IP — 20 methods
Global IP — 20 methods
| Method | Endpoint |
|---|---|
client.globalIPAllowedPorts.list() | GET /global_ip_allowed_ports |
client.globalIPAssignmentHealth.retrieve() | GET /global_ip_assignment_health |
client.globalIPAssignments.list() | GET /global_ip_assignments |
client.globalIPAssignments.create() | POST /global_ip_assignments |
client.globalIPAssignments.delete() | DELETE /global_ip_assignments/{id} |
client.globalIPAssignments.retrieve() | GET /global_ip_assignments/{id} |
client.globalIPAssignments.update() | PATCH /global_ip_assignments/{id} |
client.globalIPAssignmentsUsage.retrieve() | GET /global_ip_assignments_usage |
client.globalIPHealthCheckTypes.list() | GET /global_ip_health_check_types |
client.globalIPHealthChecks.list() | GET /global_ip_health_checks |
client.globalIPHealthChecks.create() | POST /global_ip_health_checks |
client.globalIPHealthChecks.delete() | DELETE /global_ip_health_checks/{id} |
client.globalIPHealthChecks.retrieve() | GET /global_ip_health_checks/{id} |
client.globalIPLatency.retrieve() | GET /global_ip_latency |
client.globalIPProtocols.list() | GET /global_ip_protocols |
client.globalIPUsage.retrieve() | GET /global_ip_usage |
client.globalIPs.list() | GET /global_ips |
client.globalIPs.create() | POST /global_ips |
client.globalIPs.delete() | DELETE /global_ips/{id} |
client.globalIPs.retrieve() | GET /global_ips/{id} |
networks — 9 methods
networks — 9 methods
| Method | Endpoint |
|---|---|
client.networks.list() | GET /networks |
client.networks.create() | POST /networks |
client.networks.delete() | DELETE /networks/{id} |
client.networks.retrieve() | GET /networks/{id} |
client.networks.update() | PATCH /networks/{id} |
client.networks.listInterfaces() | GET /networks/{id}/network_interfaces |
client.networks.defaultGateway.delete() | DELETE /networks/{id}/default_gateway |
client.networks.defaultGateway.retrieve() | GET /networks/{id}/default_gateway |
client.networks.defaultGateway.create() | POST /networks/{id}/default_gateway |
privateWirelessGateways — 4 methods
privateWirelessGateways — 4 methods
| Method | Endpoint |
|---|---|
client.privateWirelessGateways.list() | GET /private_wireless_gateways |
client.privateWirelessGateways.create() | POST /private_wireless_gateways |
client.privateWirelessGateways.delete() | DELETE /private_wireless_gateways/{id} |
client.privateWirelessGateways.retrieve() | GET /private_wireless_gateways/{id} |
publicInternetGateways — 4 methods
publicInternetGateways — 4 methods
| Method | Endpoint |
|---|---|
client.publicInternetGateways.list() | GET /public_internet_gateways |
client.publicInternetGateways.create() | POST /public_internet_gateways |
client.publicInternetGateways.delete() | DELETE /public_internet_gateways/{id} |
client.publicInternetGateways.retrieve() | GET /public_internet_gateways/{id} |
regions — 1 method
regions — 1 method
| Method | Endpoint |
|---|---|
client.regions.list() | GET /regions |
Virtual Cross Connects — 6 methods
Virtual Cross Connects — 6 methods
| Method | Endpoint |
|---|---|
client.virtualCrossConnects.list() | GET /virtual_cross_connects |
client.virtualCrossConnects.create() | POST /virtual_cross_connects |
client.virtualCrossConnects.delete() | DELETE /virtual_cross_connects/{id} |
client.virtualCrossConnects.retrieve() | GET /virtual_cross_connects/{id} |
client.virtualCrossConnects.update() | PATCH /virtual_cross_connects/{id} |
client.virtualCrossConnectsCoverage.list() | GET /virtual_cross_connects_coverage |
WireGuard — 10 methods
WireGuard — 10 methods
| Method | Endpoint |
|---|---|
client.wireguardInterfaces.list() | GET /wireguard_interfaces |
client.wireguardInterfaces.create() | POST /wireguard_interfaces |
client.wireguardInterfaces.delete() | DELETE /wireguard_interfaces/{id} |
client.wireguardInterfaces.retrieve() | GET /wireguard_interfaces/{id} |
client.wireguardPeers.list() | GET /wireguard_peers |
client.wireguardPeers.create() | POST /wireguard_peers |
client.wireguardPeers.delete() | DELETE /wireguard_peers/{id} |
client.wireguardPeers.retrieve() | GET /wireguard_peers/{id} |
client.wireguardPeers.update() | PATCH /wireguard_peers/{id} |
client.wireguardPeers.retrieveConfig() | GET /wireguard_peers/{id}/config |
Storage
Storage — 29 methods
Storage — 29 methods
| Method | Endpoint |
|---|---|
client.storage.listMigrationSourceCoverage() | GET /storage/migration_source_coverage |
client.storage.buckets.createPresignedURL() | POST /storage/buckets/{bucketName}/{objectName}/presigned_url |
client.storage.buckets.sslCertificate.delete() | DELETE /storage/buckets/{bucketName}/ssl_certificate |
client.storage.buckets.sslCertificate.retrieve() | GET /storage/buckets/{bucketName}/ssl_certificate |
client.storage.buckets.sslCertificate.create() | PUT /storage/buckets/{bucketName}/ssl_certificate |
client.storage.buckets.usage.getAPIUsage() | GET /storage/buckets/{bucketName}/usage/api |
client.storage.buckets.usage.getBucketUsage() | GET /storage/buckets/{bucketName}/usage/storage |
client.storage.migrationSources.list() | GET /storage/migration_sources |
client.storage.migrationSources.create() | POST /storage/migration_sources |
client.storage.migrationSources.delete() | DELETE /storage/migration_sources/{id} |
client.storage.migrationSources.retrieve() | GET /storage/migration_sources/{id} |
client.storage.migrations.list() | GET /storage/migrations |
client.storage.migrations.create() | POST /storage/migrations |
client.storage.migrations.retrieve() | GET /storage/migrations/{id} |
client.storage.migrations.actions.stop() | POST /storage/migrations/{id}/actions/stop |
client.storage.kvs.list() | GET /storage/kvs |
client.storage.kvs.create() | POST /storage/kvs |
client.storage.kvs.delete() | DELETE /storage/kvs/{id} |
client.storage.kvs.retrieve() | GET /storage/kvs/{id} |
client.storage.kvs.keys.list() | GET /storage/kvs/{id}/keys |
client.storage.kvs.keys.delete() | DELETE /storage/kvs/{id}/keys/{key} |
client.storage.kvs.keys.retrieve() | GET /storage/kvs/{id}/keys/{key} |
client.storage.kvs.keys.update() | PUT /storage/kvs/{id}/keys/{key} |
client.storage.cloudfs.list() | GET /storage/cloudfs |
client.storage.cloudfs.create() | POST /storage/cloudfs |
client.storage.cloudfs.delete() | DELETE /storage/cloudfs/{id} |
client.storage.cloudfs.retrieve() | GET /storage/cloudfs/{id} |
client.storage.cloudfs.update() | PATCH /storage/cloudfs/{id} |
client.storage.cloudfs.actions.rotateMetaToken() | POST /storage/cloudfs/{id}/actions/rotate-meta-token |
Calling
callControlApplications — 5 methods
callControlApplications — 5 methods
| Method | Endpoint |
|---|---|
client.callControlApplications.list() | GET /call_control_applications |
client.callControlApplications.create() | POST /call_control_applications |
client.callControlApplications.delete() | DELETE /call_control_applications/{id} |
client.callControlApplications.retrieve() | GET /call_control_applications/{id} |
client.callControlApplications.update() | PATCH /call_control_applications/{id} |
callEvents — 1 method
callEvents — 1 method
| Method | Endpoint |
|---|---|
client.callEvents.list() | GET /call_events |
callReasons — 2 methods
callReasons — 2 methods
| Method | Endpoint |
|---|---|
client.callReasons.list() | GET /call_reasons |
client.callReasons.validate() | POST /call_reasons/validate |
calls — 43 methods
calls — 43 methods
conferences — 23 methods
conferences — 23 methods
connections — 3 methods
connections — 3 methods
| Method | Endpoint |
|---|---|
client.connections.list() | GET /connections |
client.connections.listActiveCalls() | GET /connections/{connection_id}/active_calls |
client.connections.retrieve() | GET /connections/{id} |
credentialConnections — 6 methods
credentialConnections — 6 methods
| Method | Endpoint |
|---|---|
client.credentialConnections.list() | GET /credential_connections |
client.credentialConnections.create() | POST /credential_connections |
client.credentialConnections.delete() | DELETE /credential_connections/{id} |
client.credentialConnections.retrieve() | GET /credential_connections/{id} |
client.credentialConnections.update() | PATCH /credential_connections/{id} |
client.credentialConnections.actions.checkRegistrationStatus() | POST /credential_connections/{id}/actions/check_registration_status |
dialogflowConnections — 4 methods
dialogflowConnections — 4 methods
| Method | Endpoint |
|---|---|
client.dialogflowConnections.delete() | DELETE /dialogflow_connections/{connection_id} |
client.dialogflowConnections.retrieve() | GET /dialogflow_connections/{connection_id} |
client.dialogflowConnections.create() | POST /dialogflow_connections/{connection_id} |
client.dialogflowConnections.update() | PUT /dialogflow_connections/{connection_id} |
dir — 22 methods
dir — 22 methods
| Method | Endpoint |
|---|---|
client.dir.list() | GET /dir |
client.dir.listDocumentTypes() | GET /dir/document_types |
client.dir.delete() | DELETE /dir/{dir_id} |
client.dir.retrieve() | GET /dir/{dir_id} |
client.dir.update() | PATCH /dir/{dir_id} |
client.dir.listInfringementClaims() | GET /dir/{dir_id}/infringement_claims |
client.dir.updateInfringement() | PUT /dir/{dir_id}/infringement_update |
client.dir.submit() | POST /dir/{dir_id}/submit |
client.dir.newLoa() | POST /dir/{dir_id}/loa |
client.dir.comments.list() | GET /dir/{dir_id}/comments |
client.dir.comments.create() | POST /dir/{dir_id}/comments |
client.dir.phoneNumberBatches.list() | GET /dir/{dir_id}/phone_number_batches |
client.dir.phoneNumberBatches.retrieve() | GET /dir/{dir_id}/phone_number_batches/{batch_id} |
client.dir.phoneNumbers.remove() | DELETE /dir/{dir_id}/phone_numbers |
client.dir.phoneNumbers.list() | GET /dir/{dir_id}/phone_numbers |
client.dir.phoneNumbers.add() | POST /dir/{dir_id}/phone_numbers |
client.dir.references.list() | GET /dir/{dir_id}/references |
client.dir.references.create() | POST /dir/{dir_id}/references |
client.dir.references.update() | PATCH /dir/{dir_id}/references/{ref_type}/{slot} |
client.dir.verifyEmail.list() | GET /dir/{dir_id}/verify_email |
client.dir.verifyEmail.create() | POST /dir/{dir_id}/verify_email |
client.dir.verifyEmail.confirm() | POST /dir/{dir_id}/verify_email/confirm |
externalConnections — 22 methods
externalConnections — 22 methods
| Method | Endpoint |
|---|---|
client.externalConnections.list() | GET /external_connections |
client.externalConnections.create() | POST /external_connections |
client.externalConnections.delete() | DELETE /external_connections/{id} |
client.externalConnections.retrieve() | GET /external_connections/{id} |
client.externalConnections.update() | PATCH /external_connections/{id} |
client.externalConnections.updateLocation() | PATCH /external_connections/{id}/locations/{location_id} |
client.externalConnections.logMessages.list() | GET /external_connections/log_messages |
client.externalConnections.logMessages.dismiss() | DELETE /external_connections/log_messages/{id} |
client.externalConnections.logMessages.retrieve() | GET /external_connections/log_messages/{id} |
client.externalConnections.civicAddresses.list() | GET /external_connections/{id}/civic_addresses |
client.externalConnections.civicAddresses.retrieve() | GET /external_connections/{id}/civic_addresses/{address_id} |
client.externalConnections.phoneNumbers.list() | GET /external_connections/{id}/phone_numbers |
client.externalConnections.phoneNumbers.retrieve() | GET /external_connections/{id}/phone_numbers/{phone_number_id} |
client.externalConnections.phoneNumbers.update() | PATCH /external_connections/{id}/phone_numbers/{phone_number_id} |
client.externalConnections.releases.list() | GET /external_connections/{id}/releases |
client.externalConnections.releases.retrieve() | GET /external_connections/{id}/releases/{release_id} |
client.externalConnections.uploads.list() | GET /external_connections/{id}/uploads |
client.externalConnections.uploads.create() | POST /external_connections/{id}/uploads |
client.externalConnections.uploads.refreshStatus() | POST /external_connections/{id}/uploads/refresh |
client.externalConnections.uploads.pendingCount() | GET /external_connections/{id}/uploads/status |
client.externalConnections.uploads.retrieve() | GET /external_connections/{id}/uploads/{ticket_id} |
client.externalConnections.uploads.retry() | POST /external_connections/{id}/uploads/{ticket_id}/retry |
fqdnConnections — 7 methods
fqdnConnections — 7 methods
| Method | Endpoint |
|---|---|
client.fqdnConnections.list() | GET /fqdn_connections |
client.fqdnConnections.create() | POST /fqdn_connections |
client.fqdnConnections.delete() | DELETE /fqdn_connections/{id} |
client.fqdnConnections.retrieve() | GET /fqdn_connections/{id} |
client.fqdnConnections.update() | PATCH /fqdn_connections/{id} |
client.fqdnConnections.fqdnAuthentication.list() | GET /fqdn_connections/{fqdn_connection_id}/fqdn_authentication |
client.fqdnConnections.fqdnAuthentication.patchAll() | PATCH /fqdn_connections/{fqdn_connection_id}/fqdn_authentication |
fqdns — 5 methods
fqdns — 5 methods
| Method | Endpoint |
|---|---|
client.fqdns.list() | GET /fqdns |
client.fqdns.create() | POST /fqdns |
client.fqdns.delete() | DELETE /fqdns/{id} |
client.fqdns.retrieve() | GET /fqdns/{id} |
client.fqdns.update() | PATCH /fqdns/{id} |
infringementClaims — 2 methods
infringementClaims — 2 methods
| Method | Endpoint |
|---|---|
client.infringementClaims.retrieve() | GET /infringement_claims/{claim_id} |
client.infringementClaims.contest() | POST /infringement_claims/{claim_id}/contest |
ipConnections — 5 methods
ipConnections — 5 methods
| Method | Endpoint |
|---|---|
client.ipConnections.list() | GET /ip_connections |
client.ipConnections.create() | POST /ip_connections |
client.ipConnections.delete() | DELETE /ip_connections/{id} |
client.ipConnections.retrieve() | GET /ip_connections/{id} |
client.ipConnections.update() | PATCH /ip_connections/{id} |
ips — 5 methods
ips — 5 methods
| Method | Endpoint |
|---|---|
client.ips.list() | GET /ips |
client.ips.create() | POST /ips |
client.ips.delete() | DELETE /ips/{id} |
client.ips.retrieve() | GET /ips/{id} |
client.ips.update() | PATCH /ips/{id} |
media — 6 methods
media — 6 methods
| Method | Endpoint |
|---|---|
client.media.list() | GET /media |
client.media.upload() | POST /media |
client.media.delete() | DELETE /media/{media_name} |
client.media.retrieve() | GET /media/{media_name} |
client.media.update() | PUT /media/{media_name} |
client.media.download() | GET /media/{media_name}/download |
mobilePushCredentials — 4 methods
mobilePushCredentials — 4 methods
| Method | Endpoint |
|---|---|
client.mobilePushCredentials.list() | GET /mobile_push_credentials |
client.mobilePushCredentials.create() | POST /mobile_push_credentials |
client.mobilePushCredentials.delete() | DELETE /mobile_push_credentials/{push_credential_id} |
client.mobilePushCredentials.retrieve() | GET /mobile_push_credentials/{push_credential_id} |
operatorConnect — 1 method
operatorConnect — 1 method
| Method | Endpoint |
|---|---|
client.operatorConnect.actions.refresh() | POST /operator_connect/actions/refresh |
outboundVoiceProfiles — 5 methods
outboundVoiceProfiles — 5 methods
| Method | Endpoint |
|---|---|
client.outboundVoiceProfiles.list() | GET /outbound_voice_profiles |
client.outboundVoiceProfiles.create() | POST /outbound_voice_profiles |
client.outboundVoiceProfiles.delete() | DELETE /outbound_voice_profiles/{id} |
client.outboundVoiceProfiles.retrieve() | GET /outbound_voice_profiles/{id} |
client.outboundVoiceProfiles.update() | PATCH /outbound_voice_profiles/{id} |
Queues — 9 methods
Queues — 9 methods
| Method | Endpoint |
|---|---|
client.queues.retrieve() | GET /queues/{queue_name} |
client.queues.list() | GET /queues |
client.queues.create() | POST /queues |
client.queues.delete() | DELETE /queues/{queue_name} |
client.queues.update() | POST /queues/{queue_name} |
client.queues.calls.list() | GET /queues/{queue_name}/calls |
client.queues.calls.retrieve() | GET /queues/{queue_name}/calls/{call_control_id} |
client.queues.calls.remove() | DELETE /queues/{queue_name}/calls/{call_control_id} |
client.queues.calls.update() | PATCH /queues/{queue_name}/calls/{call_control_id} |
Recordings — 11 methods
Recordings — 11 methods
| Method | Endpoint |
|---|---|
client.customStorageCredentials.delete() | DELETE /custom_storage_credentials/{connection_id} |
client.customStorageCredentials.retrieve() | GET /custom_storage_credentials/{connection_id} |
client.customStorageCredentials.create() | POST /custom_storage_credentials/{connection_id} |
client.customStorageCredentials.update() | PUT /custom_storage_credentials/{connection_id} |
client.recordingTranscriptions.list() | GET /recording_transcriptions |
client.recordingTranscriptions.delete() | DELETE /recording_transcriptions/{recording_transcription_id} |
client.recordingTranscriptions.retrieve() | GET /recording_transcriptions/{recording_transcription_id} |
client.recordings.list() | GET /recordings |
client.recordings.delete() | DELETE /recordings/{recording_id} |
client.recordings.retrieve() | GET /recordings/{recording_id} |
client.recordings.actions.delete() | POST /recordings/actions/delete |
siprecConnectors — 4 methods
siprecConnectors — 4 methods
| Method | Endpoint |
|---|---|
client.siprecConnectors.create() | POST /siprec_connectors |
client.siprecConnectors.delete() | DELETE /siprec_connectors/{connector_name} |
client.siprecConnectors.retrieve() | GET /siprec_connectors/{connector_name} |
client.siprecConnectors.update() | PUT /siprec_connectors/{connector_name} |
telephonyCredentials — 6 methods
telephonyCredentials — 6 methods
| Method | Endpoint |
|---|---|
client.telephonyCredentials.list() | GET /telephony_credentials |
client.telephonyCredentials.create() | POST /telephony_credentials |
client.telephonyCredentials.delete() | DELETE /telephony_credentials/{id} |
client.telephonyCredentials.retrieve() | GET /telephony_credentials/{id} |
client.telephonyCredentials.update() | PATCH /telephony_credentials/{id} |
client.telephonyCredentials.createToken() | POST /telephony_credentials/{id}/token |
termsOfService — 6 methods
termsOfService — 6 methods
| Method | Endpoint |
|---|---|
client.termsOfService.retrieveStatus() | GET /terms_of_service/status |
client.termsOfService.retrieveInfo() | GET /terms_of_service/info |
client.termsOfService.numberReputation.agree() | POST /terms_of_service/number_reputation/agree |
client.termsOfService.agreements.list() | GET /terms_of_service/agreements |
client.termsOfService.agreements.retrieve() | GET /terms_of_service/agreements/{agreement_id} |
client.termsOfService.brandedCalling.agree() | POST /terms_of_service/branded_calling/agree |
texml — 34 methods
texml — 34 methods
texmlApplications — 5 methods
texmlApplications — 5 methods
| Method | Endpoint |
|---|---|
client.texmlApplications.list() | GET /texml_applications |
client.texmlApplications.create() | POST /texml_applications |
client.texmlApplications.delete() | DELETE /texml_applications/{id} |
client.texmlApplications.retrieve() | GET /texml_applications/{id} |
client.texmlApplications.update() | PATCH /texml_applications/{id} |
Traffic Policy Profiles — 6 methods
Traffic Policy Profiles — 6 methods
| Method | Endpoint |
|---|---|
client.trafficPolicyProfiles.list() | GET /traffic_policy_profiles |
client.trafficPolicyProfiles.create() | POST /traffic_policy_profiles |
client.trafficPolicyProfiles.listServices() | GET /traffic_policy_profiles/services |
client.trafficPolicyProfiles.delete() | DELETE /traffic_policy_profiles/{id} |
client.trafficPolicyProfiles.retrieve() | GET /traffic_policy_profiles/{id} |
client.trafficPolicyProfiles.update() | PATCH /traffic_policy_profiles/{id} |
UAC Connections — 7 methods
UAC Connections — 7 methods
| Method | Endpoint |
|---|---|
client.uacConnections.list() | GET /uac_connections |
client.uacConnections.create() | POST /uac_connections |
client.uacConnections.delete() | DELETE /uac_connections/{id} |
client.uacConnections.retrieve() | GET /uac_connections/{id} |
client.uacConnections.update() | PATCH /uac_connections/{id} |
client.uacConnections.actions.checkRegistrationStatus() | POST /uac_connections/{id}/actions/check_registration_status |
client.sipRegistrationStatus.retrieve() | GET /sip_registration_status |
voiceSDKCallReports — 2 methods
voiceSDKCallReports — 2 methods
| Method | Endpoint |
|---|---|
client.voiceSDKCallReports.list() | GET /voice_sdk_call_reports |
client.voiceSDKCallReports.retrieve() | GET /voice_sdk_call_reports/{call_id} |
Messaging
10DLC — 43 methods
10DLC — 43 methods
| Method | Endpoint |
|---|---|
client.messaging10dlc.getEnum() | GET /10dlc/enum/{endpoint} |
client.messaging10dlc.brand.list() | GET /10dlc/brand |
client.messaging10dlc.brand.create() | POST /10dlc/brand |
client.messaging10dlc.brand.getFeedback() | GET /10dlc/brand/feedback/{brandId} |
client.messaging10dlc.brand.delete() | DELETE /10dlc/brand/{brandId} |
client.messaging10dlc.brand.retrieve() | GET /10dlc/brand/{brandId} |
client.messaging10dlc.brand.update() | PUT /10dlc/brand/{brandId} |
client.messaging10dlc.brand.resend2faEmail() | POST /10dlc/brand/{brandId}/2faEmail |
client.messaging10dlc.brand.revet() | PUT /10dlc/brand/{brandId}/revet |
client.messaging10dlc.brand.retrieveSMSOtpStatus() | GET /10dlc/brand/{brandId}/smsOtp |
client.messaging10dlc.brand.triggerSMSOtp() | POST /10dlc/brand/{brandId}/smsOtp |
client.messaging10dlc.brand.verifySMSOtp() | PUT /10dlc/brand/{brandId}/smsOtp |
client.messaging10dlc.brand.getSMSOtpByReference() | GET /10dlc/brand/smsOtp/{referenceId} |
client.messaging10dlc.brand.externalVetting.list() | GET /10dlc/brand/{brandId}/externalVetting |
client.messaging10dlc.brand.externalVetting.order() | POST /10dlc/brand/{brandId}/externalVetting |
client.messaging10dlc.brand.externalVetting.imports() | PUT /10dlc/brand/{brandId}/externalVetting |
client.messaging10dlc.campaign.list() | GET /10dlc/campaign |
client.messaging10dlc.campaign.acceptSharing() | POST /10dlc/campaign/acceptSharing/{campaignId} |
client.messaging10dlc.campaign.deactivate() | DELETE /10dlc/campaign/{campaignId} |
client.messaging10dlc.campaign.retrieve() | GET /10dlc/campaign/{campaignId} |
client.messaging10dlc.campaign.update() | PUT /10dlc/campaign/{campaignId} |
client.messaging10dlc.campaign.submitAppeal() | POST /10dlc/campaign/{campaignId}/appeal |
client.messaging10dlc.campaign.getMnoMetadata() | GET /10dlc/campaign/{campaignId}/mnoMetadata |
client.messaging10dlc.campaign.getOperationStatus() | GET /10dlc/campaign/{campaignId}/operationStatus |
client.messaging10dlc.campaign.getSharingStatus() | GET /10dlc/campaign/{campaignId}/sharing |
client.messaging10dlc.campaign.usecase.getCost() | GET /10dlc/campaign/usecase/cost |
client.messaging10dlc.campaign.osr.getAttributes() | GET /10dlc/campaign/{campaignId}/osr/attributes |
client.messaging10dlc.campaignBuilder.submit() | POST /10dlc/campaignBuilder |
client.messaging10dlc.campaignBuilder.brand.qualifyByUsecase() | GET /10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase} |
client.messaging10dlc.partnerCampaigns.listSharedByMe() | GET /10dlc/partnerCampaign/sharedByMe |
client.messaging10dlc.partnerCampaigns.retrieveSharingStatus() | GET /10dlc/partnerCampaign/{campaignId}/sharing |
client.messaging10dlc.partnerCampaigns.list() | GET /10dlc/partner_campaigns |
client.messaging10dlc.partnerCampaigns.retrieve() | GET /10dlc/partner_campaigns/{campaignId} |
client.messaging10dlc.partnerCampaigns.update() | PATCH /10dlc/partner_campaigns/{campaignId} |
client.messaging10dlc.phoneNumberCampaigns.list() | GET /10dlc/phone_number_campaigns |
client.messaging10dlc.phoneNumberCampaigns.create() | POST /10dlc/phone_number_campaigns |
client.messaging10dlc.phoneNumberCampaigns.delete() | DELETE /10dlc/phone_number_campaigns/{phoneNumber} |
client.messaging10dlc.phoneNumberCampaigns.retrieve() | GET /10dlc/phone_number_campaigns/{phoneNumber} |
client.messaging10dlc.phoneNumberCampaigns.update() | PUT /10dlc/phone_number_campaigns/{phoneNumber} |
client.messaging10dlc.phoneNumberAssignmentByProfile.assign() | POST /10dlc/phoneNumberAssignmentByProfile |
client.messaging10dlc.phoneNumberAssignmentByProfile.retrieveStatus() | GET /10dlc/phoneNumberAssignmentByProfile/{taskId} |
client.messaging10dlc.phoneNumberAssignmentByProfile.retrievePhoneNumberStatus() | GET /10dlc/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers |
client.messaging10dlc.phoneNumberAssignmentByProfile.listPhoneNumberStatus() | GET /10dlc/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers |
Alphanumeric Sender IDs — 4 methods
Alphanumeric Sender IDs — 4 methods
| Method | Endpoint |
|---|---|
client.alphanumericSenderIDs.list() | GET /alphanumeric_sender_ids |
client.alphanumericSenderIDs.create() | POST /alphanumeric_sender_ids |
client.alphanumericSenderIDs.delete() | DELETE /alphanumeric_sender_ids/{id} |
client.alphanumericSenderIDs.retrieve() | GET /alphanumeric_sender_ids/{id} |
emailBlocks — 8 methods
emailBlocks — 8 methods
| Method | Endpoint |
|---|---|
client.emailBlocks.list() | GET /email_blocks |
client.emailBlocks.create() | POST /email_blocks |
client.emailBlocks.retrieveExport() | GET /email_blocks/export |
client.emailBlocks.delete() | DELETE /email_blocks/{id} |
client.emailBlocks.retrieve() | GET /email_blocks/{id} |
client.emailBlocks.retrieveEvents() | GET /email_blocks/{id}/events |
client.emailBlocks.import.create() | POST /email_blocks/import |
client.emailBlocks.import.retrieve() | GET /email_blocks/import/{id} |
emailDomains — 13 methods
emailDomains — 13 methods
| Method | Endpoint |
|---|---|
client.emailDomains.list() | GET /email_domains |
client.emailDomains.create() | POST /email_domains |
client.emailDomains.retrieveDNSRecords() | GET /email_domains/{domain_id}/dns_records |
client.emailDomains.verify() | POST /email_domains/{domain_id}/verify |
client.emailDomains.delete() | DELETE /email_domains/{id} |
client.emailDomains.retrieve() | GET /email_domains/{id} |
client.emailDomains.update() | PATCH /email_domains/{id} |
client.emailDomains.retrieveHealth() | GET /email_domains/{id}/health |
client.emailDomains.webhooks.list() | GET /email_domains/{domain_id}/webhooks |
client.emailDomains.webhooks.create() | POST /email_domains/{domain_id}/webhooks |
client.emailDomains.webhooks.delete() | DELETE /email_domains/{domain_id}/webhooks/{id} |
client.emailDomains.webhooks.retrieve() | GET /email_domains/{domain_id}/webhooks/{id} |
client.emailDomains.webhooks.update() | PATCH /email_domains/{domain_id}/webhooks/{id} |
emailEvents — 2 methods
emailEvents — 2 methods
| Method | Endpoint |
|---|---|
client.emailEvents.list() | GET /email_events |
client.emailEvents.retrieveStats() | GET /email_events/stats |
emailInboxes — 27 methods
emailInboxes — 27 methods
emailMessages — 10 methods
emailMessages — 10 methods
| Method | Endpoint |
|---|---|
client.emailMessages.deleteAll() | DELETE /email_messages |
client.emailMessages.list() | GET /email_messages |
client.emailMessages.create() | POST /email_messages |
client.emailMessages.batch() | POST /email_messages/batch |
client.emailMessages.retrieveEvents() | GET /email_messages/{email_id}/events |
client.emailMessages.deleteSchedule() | DELETE /email_messages/{email_id}/schedule |
client.emailMessages.delete() | DELETE /email_messages/{id} |
client.emailMessages.retrieve() | GET /email_messages/{id} |
client.emailMessages.recipients.list() | GET /email_messages/{email_id}/recipients |
client.emailMessages.recipients.retrieve() | GET /email_messages/{email_id}/recipients/{recipient_id} |
emailTemplates — 7 methods
emailTemplates — 7 methods
| Method | Endpoint |
|---|---|
client.emailTemplates.list() | GET /email_templates |
client.emailTemplates.create() | POST /email_templates |
client.emailTemplates.delete() | DELETE /email_templates/{id} |
client.emailTemplates.retrieve() | GET /email_templates/{id} |
client.emailTemplates.replace() | PUT /email_templates/{id} |
client.emailTemplates.update() | PATCH /email_templates/{id} |
client.emailTemplates.render() | POST /email_templates/{id}/render |
emailThreads — 2 methods
emailThreads — 2 methods
| Method | Endpoint |
|---|---|
client.emailThreads.list() | GET /email_threads |
client.emailThreads.retrieve() | GET /email_threads/{thread_id} |
emailUnsubscribeGroups — 8 methods
emailUnsubscribeGroups — 8 methods
| Method | Endpoint |
|---|---|
client.emailUnsubscribeGroups.list() | GET /email_unsubscribe_groups |
client.emailUnsubscribeGroups.create() | POST /email_unsubscribe_groups |
client.emailUnsubscribeGroups.delete() | DELETE /email_unsubscribe_groups/{id} |
client.emailUnsubscribeGroups.retrieve() | GET /email_unsubscribe_groups/{id} |
client.emailUnsubscribeGroups.update() | PATCH /email_unsubscribe_groups/{id} |
client.emailUnsubscribeGroups.suppressions.list() | GET /email_unsubscribe_groups/{id}/suppressions |
client.emailUnsubscribeGroups.suppressions.create() | POST /email_unsubscribe_groups/{id}/suppressions |
client.emailUnsubscribeGroups.suppressions.delete() | DELETE /email_unsubscribe_groups/{id}/suppressions/{email} |
emailValidations — 3 methods
emailValidations — 3 methods
| Method | Endpoint |
|---|---|
client.emailValidations.create() | POST /email_validations |
client.emailValidations.batch.create() | POST /email_validations/batch |
client.emailValidations.batch.retrieve() | GET /email_validations/batch/{id} |
Hosted Numbers — 12 methods
Hosted Numbers — 12 methods
| Method | Endpoint |
|---|---|
client.messagingHostedNumberOrders.list() | GET /messaging_hosted_number_orders |
client.messagingHostedNumberOrders.create() | POST /messaging_hosted_number_orders |
client.messagingHostedNumberOrders.checkEligibility() | POST /messaging_hosted_number_orders/eligibility_numbers_check |
client.messagingHostedNumberOrders.delete() | DELETE /messaging_hosted_number_orders/{id} |
client.messagingHostedNumberOrders.retrieve() | GET /messaging_hosted_number_orders/{id} |
client.messagingHostedNumberOrders.validateCodes() | POST /messaging_hosted_number_orders/{id}/validation_codes |
client.messagingHostedNumberOrders.createVerificationCodes() | POST /messaging_hosted_number_orders/{id}/verification_codes |
client.messagingHostedNumberOrders.actions.uploadFile() | POST /messaging_hosted_number_orders/{id}/actions/file_upload |
client.messagingHostedNumbers.delete() | DELETE /messaging_hosted_numbers/{id} |
client.messagingHostedNumbers.list() | GET /messaging_hosted_numbers |
client.messagingHostedNumbers.retrieve() | GET /messaging_hosted_numbers/{id} |
client.messagingHostedNumbers.update() | PATCH /messaging_hosted_numbers/{id} |
Messages — 13 methods
Messages — 13 methods
| Method | Endpoint |
|---|---|
client.messages.send() | POST /messages |
client.messages.sendLongCode() | POST /messages/long_code |
client.messages.sendNumberPool() | POST /messages/number_pool |
client.messages.sendShortCode() | POST /messages/short_code |
client.messages.sendGroupMms() | POST /messages/group_mms |
client.messages.schedule() | POST /messages/schedule |
client.messages.cancelScheduled() | DELETE /messages/{id} |
client.messages.retrieve() | GET /messages/{id} |
client.messages.sendWithAlphanumericSender() | POST /messages/alphanumeric_sender_id |
client.messages.retrieveGroupMessages() | GET /messages/group/{message_id} |
client.messages.whatsapp() | POST /messages/whatsapp |
client.messages.rcs.generateDeeplink() | GET /messages/rcs/deeplinks/{agent_id} |
client.messages.rcs.send() | POST /messages/rcs |
Messaging Number Bulk Updates — 2 methods
Messaging Number Bulk Updates — 2 methods
| Method | Endpoint |
|---|---|
client.messagingNumbersBulkUpdates.create() | POST /messaging_numbers_bulk_updates |
client.messagingNumbersBulkUpdates.retrieve() | GET /messaging_numbers_bulk_updates/{order_id} |
Messaging Profiles — 16 methods
Messaging Profiles — 16 methods
| Method | Endpoint |
|---|---|
client.messagingProfiles.list() | GET /messaging_profiles |
client.messagingProfiles.create() | POST /messaging_profiles |
client.messagingProfiles.delete() | DELETE /messaging_profiles/{id} |
client.messagingProfiles.retrieve() | GET /messaging_profiles/{id} |
client.messagingProfiles.update() | PATCH /messaging_profiles/{id} |
client.messagingProfiles.listPhoneNumbers() | GET /messaging_profiles/{id}/phone_numbers |
client.messagingProfiles.listShortCodes() | GET /messaging_profiles/{id}/short_codes |
client.messagingProfiles.listAlphanumericSenderIDs() | GET /messaging_profiles/{id}/alphanumeric_sender_ids |
client.messagingProfiles.retrieveMetrics() | GET /messaging_profiles/{id}/metrics |
client.messagingProfiles.autorespConfigs.list() | GET /messaging_profiles/{profile_id}/autoresp_configs |
client.messagingProfiles.autorespConfigs.create() | POST /messaging_profiles/{profile_id}/autoresp_configs |
client.messagingProfiles.autorespConfigs.delete() | DELETE /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id} |
client.messagingProfiles.autorespConfigs.retrieve() | GET /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id} |
client.messagingProfiles.autorespConfigs.update() | PUT /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id} |
client.messagingProfiles.actions.regenerateSecret() | POST /messaging_profiles/{id}/actions/regenerate_secret |
client.messagingProfileMetrics.list() | GET /messaging_profile_metrics |
Messaging URL Domains — 1 method
Messaging URL Domains — 1 method
| Method | Endpoint |
|---|---|
client.messagingURLDomains.list() | GET /messaging_url_domains |
messagingOptouts — 1 method
messagingOptouts — 1 method
| Method | Endpoint |
|---|---|
client.messagingOptouts.list() | GET /messaging_optouts |
messagingTollfree — 6 methods
messagingTollfree — 6 methods
| Method | Endpoint |
|---|---|
client.messagingTollfree.verification.requests.list() | GET /messaging_tollfree/verification/requests |
client.messagingTollfree.verification.requests.create() | POST /messaging_tollfree/verification/requests |
client.messagingTollfree.verification.requests.delete() | DELETE /messaging_tollfree/verification/requests/{id} |
client.messagingTollfree.verification.requests.retrieve() | GET /messaging_tollfree/verification/requests/{id} |
client.messagingTollfree.verification.requests.update() | PATCH /messaging_tollfree/verification/requests/{id} |
client.messagingTollfree.verification.requests.retrieveStatusHistory() | GET /messaging_tollfree/verification/requests/{id}/status_history |
RCS — 21 methods
RCS — 21 methods
| Method | Endpoint |
|---|---|
client.messaging.rcs.listBulkCapabilities() | POST /messaging/rcs/bulk_capabilities |
client.messaging.rcs.retrieveCapabilities() | GET /messaging/rcs/capabilities/{agent_id}/{phone_number} |
client.messaging.rcs.inviteTestNumber() | PUT /messaging/rcs/test_number_invite/{id}/{phone_number} |
client.messaging.rcs.agents.list() | GET /messaging/rcs/agents |
client.messaging.rcs.agents.retrieve() | GET /messaging/rcs/agents/{id} |
client.messaging.rcs.agents.update() | PATCH /messaging/rcs/agents/{id} |
client.rcs.agents.list() | GET /rcs/agents |
client.rcs.agents.create() | POST /rcs/agents |
client.rcs.agents.retrieve() | GET /rcs/agents/{id} |
client.rcs.agents.update() | PATCH /rcs/agents/{id} |
client.rcs.agents.retrieveCarrierApprovals() | GET /rcs/agents/{id}/carrier_approvals |
client.rcs.agents.launch() | POST /rcs/agents/{id}/launch |
client.rcs.agents.submit() | POST /rcs/agents/{id}/submit |
client.rcs.agents.testDevices.list() | GET /rcs/agents/{id}/test_devices |
client.rcs.agents.testDevices.create() | POST /rcs/agents/{id}/test_devices |
client.rcs.agents.testDevices.delete() | DELETE /rcs/agents/{id}/test_devices/{test_device_id} |
client.rcs.brands.list() | GET /rcs/brands |
client.rcs.brands.create() | POST /rcs/brands |
client.rcs.brands.retrieve() | GET /rcs/brands/{id} |
client.rcs.brands.update() | PATCH /rcs/brands/{id} |
client.rcs.brands.submit() | POST /rcs/brands/{id}/submit |
shortCodes — 3 methods
shortCodes — 3 methods
| Method | Endpoint |
|---|---|
client.shortCodes.list() | GET /short_codes |
client.shortCodes.retrieve() | GET /short_codes/{id} |
client.shortCodes.update() | PATCH /short_codes/{id} |
WhatsApp — 29 methods
WhatsApp — 29 methods
| Method | Endpoint |
|---|---|
client.whatsapp.businessAccounts.list() | GET /v2/whatsapp/business_accounts |
client.whatsapp.businessAccounts.delete() | DELETE /v2/whatsapp/business_accounts/{id} |
client.whatsapp.businessAccounts.retrieve() | GET /v2/whatsapp/business_accounts/{id} |
client.whatsapp.businessAccounts.phoneNumbers.list() | GET /v2/whatsapp/business_accounts/{id}/phone_numbers |
client.whatsapp.businessAccounts.phoneNumbers.initializeVerification() | POST /v2/whatsapp/business_accounts/{id}/phone_numbers |
client.whatsapp.businessAccounts.settings.retrieve() | GET /v2/whatsapp/business_accounts/{id}/settings |
client.whatsapp.businessAccounts.settings.update() | PATCH /v2/whatsapp/business_accounts/{id}/settings |
client.whatsapp.templates.list() | GET /v2/whatsapp/message_templates |
client.whatsapp.templates.create() | POST /v2/whatsapp/message_templates |
client.whatsapp.phoneNumbers.list() | GET /v2/whatsapp/phone_numbers |
client.whatsapp.phoneNumbers.delete() | DELETE /v2/whatsapp/phone_numbers/{phone_number} |
client.whatsapp.phoneNumbers.resendVerification() | POST /v2/whatsapp/phone_numbers/{phone_number}/resend_verification |
client.whatsapp.phoneNumbers.verify() | POST /v2/whatsapp/phone_numbers/{phone_number}/verify |
client.whatsapp.phoneNumbers.retrieveConversationWindow() | GET /v2/whatsapp/phone_numbers/{phone_number}/conversation_window |
client.whatsapp.phoneNumbers.get() | GET /whatsapp/phone_numbers |
client.whatsapp.phoneNumbers.callingSettings.retrieve() | GET /v2/whatsapp/phone_numbers/{phone_number}/calling_settings |
client.whatsapp.phoneNumbers.callingSettings.update() | PATCH /v2/whatsapp/phone_numbers/{phone_number}/calling_settings |
client.whatsapp.phoneNumbers.profile.retrieve() | GET /v2/whatsapp/phone_numbers/{phone_number}/profile |
client.whatsapp.phoneNumbers.profile.update() | PATCH /v2/whatsapp/phone_numbers/{phone_number}/profile |
client.whatsapp.phoneNumbers.profile.photo.delete() | DELETE /v2/whatsapp/phone_numbers/{phone_number}/profile/photo |
client.whatsapp.phoneNumbers.profile.photo.upload() | POST /v2/whatsapp/phone_numbers/{phone_number}/profile/photo |
client.whatsapp.phoneNumbers.profile.photo.retrieve() | GET /v2/whatsapp/phone_numbers/{phone_number}/profile/photo |
client.whatsapp.phoneNumbers.conversationalComponents.list() | GET /v2/whatsapp/phone_numbers/{phone_number}/conversational_components |
client.whatsapp.phoneNumbers.conversationalComponents.patchAll() | PATCH /v2/whatsapp/phone_numbers/{phone_number}/conversational_components |
client.whatsapp.userData.retrieve() | GET /v2/whatsapp/user_data |
client.whatsapp.userData.update() | PATCH /v2/whatsapp/user_data |
client.whatsappMessageTemplates.delete() | DELETE /v2/whatsapp_message_templates/{id} |
client.whatsappMessageTemplates.retrieve() | GET /v2/whatsapp_message_templates/{id} |
client.whatsappMessageTemplates.update() | PATCH /v2/whatsapp_message_templates/{id} |
Numbers
advancedOrders — 4 methods
advancedOrders — 4 methods
| Method | Endpoint |
|---|---|
client.advancedOrders.list() | GET /advanced_orders |
client.advancedOrders.create() | POST /advanced_orders |
client.advancedOrders.retrieve() | GET /advanced_orders/{order_id} |
client.advancedOrders.updateRequirementGroup() | PATCH /advanced_orders/{advanced-order-id}/requirement_group |
bundlePricing — 8 methods
bundlePricing — 8 methods
| Method | Endpoint |
|---|---|
client.bundlePricing.billingBundles.list() | GET /bundle_pricing/billing_bundles |
client.bundlePricing.billingBundles.retrieve() | GET /bundle_pricing/billing_bundles/{bundle_id} |
client.bundlePricing.userBundles.list() | GET /bundle_pricing/user_bundles |
client.bundlePricing.userBundles.create() | POST /bundle_pricing/user_bundles/bulk |
client.bundlePricing.userBundles.listUnused() | GET /bundle_pricing/user_bundles/unused |
client.bundlePricing.userBundles.deactivate() | DELETE /bundle_pricing/user_bundles/{user_bundle_id} |
client.bundlePricing.userBundles.retrieve() | GET /bundle_pricing/user_bundles/{user_bundle_id} |
client.bundlePricing.userBundles.listResources() | GET /bundle_pricing/user_bundles/{user_bundle_id}/resources |
countryCoverage — 2 methods
countryCoverage — 2 methods
| Method | Endpoint |
|---|---|
client.countryCoverage.retrieve() | GET /country_coverage |
client.countryCoverage.retrieveCountry() | GET /country_coverage/countries/{country_code} |
customerServiceRecords — 4 methods
customerServiceRecords — 4 methods
| Method | Endpoint |
|---|---|
client.customerServiceRecords.list() | GET /customer_service_records |
client.customerServiceRecords.create() | POST /customer_service_records |
client.customerServiceRecords.verifyPhoneNumberCoverage() | POST /customer_service_records/phone_number_coverages |
client.customerServiceRecords.retrieve() | GET /customer_service_records/{customer_service_record_id} |
Documents — 9 methods
Documents — 9 methods
| Method | Endpoint |
|---|---|
client.documentLinks.list() | GET /document_links |
client.documents.list() | GET /documents |
client.documents.upload() | POST /documents?content-type=multipart |
client.documents.uploadJson() | POST /documents |
client.documents.delete() | DELETE /documents/{id} |
client.documents.retrieve() | GET /documents/{id} |
client.documents.update() | PATCH /documents/{id} |
client.documents.download() | GET /documents/{id}/download |
client.documents.generateDownloadLink() | GET /documents/{id}/download_link |
Dynamic Emergency — 8 methods
Dynamic Emergency — 8 methods
| Method | Endpoint |
|---|---|
client.dynamicEmergencyAddresses.list() | GET /dynamic_emergency_addresses |
client.dynamicEmergencyAddresses.create() | POST /dynamic_emergency_addresses |
client.dynamicEmergencyAddresses.delete() | DELETE /dynamic_emergency_addresses/{id} |
client.dynamicEmergencyAddresses.retrieve() | GET /dynamic_emergency_addresses/{id} |
client.dynamicEmergencyEndpoints.list() | GET /dynamic_emergency_endpoints |
client.dynamicEmergencyEndpoints.create() | POST /dynamic_emergency_endpoints |
client.dynamicEmergencyEndpoints.delete() | DELETE /dynamic_emergency_endpoints/{id} |
client.dynamicEmergencyEndpoints.retrieve() | GET /dynamic_emergency_endpoints/{id} |
enterprises — 22 methods
enterprises — 22 methods
inexplicitNumberOrders — 3 methods
inexplicitNumberOrders — 3 methods
| Method | Endpoint |
|---|---|
client.inexplicitNumberOrders.list() | GET /inexplicit_number_orders |
client.inexplicitNumberOrders.create() | POST /inexplicit_number_orders |
client.inexplicitNumberOrders.retrieve() | GET /inexplicit_number_orders/{id} |
inventoryCoverage — 1 method
inventoryCoverage — 1 method
| Method | Endpoint |
|---|---|
client.inventoryCoverage.list() | GET /inventory_coverage |
numberBlockOrders — 3 methods
numberBlockOrders — 3 methods
| Method | Endpoint |
|---|---|
client.numberBlockOrders.list() | GET /number_block_orders |
client.numberBlockOrders.create() | POST /number_block_orders |
client.numberBlockOrders.retrieve() | GET /number_block_orders/{number_block_order_id} |
numberLookup — 1 method
numberLookup — 1 method
| Method | Endpoint |
|---|---|
client.numberLookup.retrieve() | GET /number_lookup/{phone_number} |
numberReservations — 4 methods
numberReservations — 4 methods
| Method | Endpoint |
|---|---|
client.numberReservations.list() | GET /number_reservations |
client.numberReservations.create() | POST /number_reservations |
client.numberReservations.retrieve() | GET /number_reservations/{number_reservation_id} |
client.numberReservations.actions.extend() | POST /number_reservations/{number_reservation_id}/actions/extend |
numbersFeatures — 1 method
numbersFeatures — 1 method
| Method | Endpoint |
|---|---|
client.numbersFeatures.create() | POST /numbers_features |
Phone Number Orders — 20 methods
Phone Number Orders — 20 methods
| Method | Endpoint |
|---|---|
client.comments.list() | GET /comments |
client.comments.create() | POST /comments |
client.comments.retrieve() | GET /comments/{id} |
client.comments.markAsRead() | PATCH /comments/{id}/read |
client.numberOrderPhoneNumbers.list() | GET /number_order_phone_numbers |
client.numberOrderPhoneNumbers.updateRequirementGroup() | POST /number_order_phone_numbers/{id}/requirement_group |
client.numberOrderPhoneNumbers.retrieve() | GET /number_order_phone_numbers/{number_order_phone_number_id} |
client.numberOrderPhoneNumbers.updateRequirements() | PATCH /number_order_phone_numbers/{number_order_phone_number_id} |
client.numberOrders.list() | GET /number_orders |
client.numberOrders.create() | POST /number_orders |
client.numberOrders.retrieve() | GET /number_orders/{number_order_id} |
client.numberOrders.update() | PATCH /number_orders/{number_order_id} |
client.subNumberOrders.list() | GET /sub_number_orders |
client.subNumberOrders.updateRequirementGroup() | POST /sub_number_orders/{id}/requirement_group |
client.subNumberOrders.retrieve() | GET /sub_number_orders/{sub_number_order_id} |
client.subNumberOrders.update() | PATCH /sub_number_orders/{sub_number_order_id} |
client.subNumberOrders.cancel() | PATCH /sub_number_orders/{sub_number_order_id}/cancel |
client.subNumberOrdersReport.create() | POST /sub_number_orders_report |
client.subNumberOrdersReport.retrieve() | GET /sub_number_orders_report/{report_id} |
client.subNumberOrdersReport.download() | GET /sub_number_orders_report/{report_id}/download |
Phone Number Search — 2 methods
Phone Number Search — 2 methods
| Method | Endpoint |
|---|---|
client.availablePhoneNumberBlocks.list() | GET /available_phone_number_blocks |
client.availablePhoneNumbers.list() | GET /available_phone_numbers |
phoneNumberBlocks — 3 methods
phoneNumberBlocks — 3 methods
| Method | Endpoint |
|---|---|
client.phoneNumberBlocks.jobs.list() | GET /phone_number_blocks/jobs |
client.phoneNumberBlocks.jobs.deletePhoneNumberBlock() | POST /phone_number_blocks/jobs/delete_phone_number_block |
client.phoneNumberBlocks.jobs.retrieve() | GET /phone_number_blocks/jobs/{id} |
phoneNumbers — 25 methods
phoneNumbers — 25 methods
| Method | Endpoint |
|---|---|
client.phoneNumbers.list() | GET /phone_numbers |
client.phoneNumbers.slimList() | GET /phone_numbers/slim |
client.phoneNumbers.delete() | DELETE /phone_numbers/{id} |
client.phoneNumbers.retrieve() | GET /phone_numbers/{id} |
client.phoneNumbers.update() | PATCH /phone_numbers/{id} |
client.phoneNumbers.actions.verifyOwnership() | POST /phone_numbers/actions/verify_ownership |
client.phoneNumbers.actions.changeBundleStatus() | PATCH /phone_numbers/{id}/actions/bundle_status_change |
client.phoneNumbers.actions.enableEmergency() | POST /phone_numbers/{id}/actions/enable_emergency |
client.phoneNumbers.csvDownloads.list() | GET /phone_numbers/csv_downloads |
client.phoneNumbers.csvDownloads.create() | POST /phone_numbers/csv_downloads |
client.phoneNumbers.csvDownloads.retrieve() | GET /phone_numbers/csv_downloads/{id} |
client.phoneNumbers.jobs.list() | GET /phone_numbers/jobs |
client.phoneNumbers.jobs.deleteBatch() | POST /phone_numbers/jobs/delete_phone_numbers |
client.phoneNumbers.jobs.updateEmergencySettingsBatch() | POST /phone_numbers/jobs/update_emergency_settings |
client.phoneNumbers.jobs.updateBatch() | POST /phone_numbers/jobs/update_phone_numbers |
client.phoneNumbers.jobs.retrieve() | GET /phone_numbers/jobs/{id} |
client.phoneNumbers.messaging.list() | GET /phone_numbers/messaging |
client.phoneNumbers.messaging.retrieve() | GET /phone_numbers/{id}/messaging |
client.phoneNumbers.messaging.update() | PATCH /phone_numbers/{id}/messaging |
client.phoneNumbers.voice.list() | GET /phone_numbers/voice |
client.phoneNumbers.voice.retrieve() | GET /phone_numbers/{id}/voice |
client.phoneNumbers.voice.update() | PATCH /phone_numbers/{id}/voice |
client.phoneNumbers.voicemail.retrieve() | GET /phone_numbers/{phone_number_id}/voicemail |
client.phoneNumbers.voicemail.update() | PATCH /phone_numbers/{phone_number_id}/voicemail |
client.phoneNumbers.voicemail.create() | POST /phone_numbers/{phone_number_id}/voicemail |
portabilityChecks — 1 method
portabilityChecks — 1 method
| Method | Endpoint |
|---|---|
client.portabilityChecks.run() | POST /portability_checks |
porting — 15 methods
porting — 15 methods
| Method | Endpoint |
|---|---|
client.porting.listUkCarriers() | GET /porting/uk_carriers |
client.porting.events.list() | GET /porting/events |
client.porting.events.retrieve() | GET /porting/events/{id} |
client.porting.events.republish() | POST /porting/events/{id}/republish |
client.porting.reports.list() | GET /porting/reports |
client.porting.reports.create() | POST /porting/reports |
client.porting.reports.retrieve() | GET /porting/reports/{id} |
client.porting.loaConfigurations.preview0() | POST /porting/loa_configurations/preview |
client.porting.loaConfigurations.preview1() | GET /porting/loa_configurations/{id}/preview |
client.porting.loaConfigurations.list() | GET /porting/loa_configurations |
client.porting.loaConfigurations.create() | POST /porting/loa_configurations |
client.porting.loaConfigurations.delete() | DELETE /porting/loa_configurations/{id} |
client.porting.loaConfigurations.retrieve() | GET /porting/loa_configurations/{id} |
client.porting.loaConfigurations.update() | PATCH /porting/loa_configurations/{id} |
client.porting.loaConfigurations.preview() | POST /porting/loa_configurations/preview |
portingOrders — 38 methods
portingOrders — 38 methods
portingPhoneNumbers — 1 method
portingPhoneNumbers — 1 method
| Method | Endpoint |
|---|---|
client.portingPhoneNumbers.list() | GET /porting_phone_numbers |
portouts — 14 methods
portouts — 14 methods
| Method | Endpoint |
|---|---|
client.portouts.list() | GET /portouts |
client.portouts.listRejectionCodes() | GET /portouts/rejections/{portout_id} |
client.portouts.retrieve() | GET /portouts/{id} |
client.portouts.updateStatus() | PATCH /portouts/{id}/{status} |
client.portouts.events.list() | GET /portouts/events |
client.portouts.events.retrieve() | GET /portouts/events/{id} |
client.portouts.events.republish() | POST /portouts/events/{id}/republish |
client.portouts.reports.list() | GET /portouts/reports |
client.portouts.reports.create() | POST /portouts/reports |
client.portouts.reports.retrieve() | GET /portouts/reports/{id} |
client.portouts.comments.list() | GET /portouts/{id}/comments |
client.portouts.comments.create() | POST /portouts/{id}/comments |
client.portouts.supportingDocuments.list() | GET /portouts/{id}/supporting_documents |
client.portouts.supportingDocuments.create() | POST /portouts/{id}/supporting_documents |
reputation — 3 methods
reputation — 3 methods
| Method | Endpoint |
|---|---|
client.reputation.numbers.list() | GET /reputation/numbers |
client.reputation.numbers.delete() | DELETE /reputation/numbers/{phone_number} |
client.reputation.numbers.retrieve() | GET /reputation/numbers/{phone_number} |
Requirements and Regulatory — 12 methods
Requirements and Regulatory — 12 methods
| Method | Endpoint |
|---|---|
client.phoneNumbersRegulatoryRequirements.retrieve() | GET /phone_numbers_regulatory_requirements |
client.regulatoryRequirements.retrieve() | GET /regulatory_requirements |
client.requirementGroups.list() | GET /requirement_groups |
client.requirementGroups.create() | POST /requirement_groups |
client.requirementGroups.delete() | DELETE /requirement_groups/{id} |
client.requirementGroups.retrieve() | GET /requirement_groups/{id} |
client.requirementGroups.update() | PATCH /requirement_groups/{id} |
client.requirementGroups.submitForApproval() | POST /requirement_groups/{id}/submit_for_approval |
client.requirementTypes.list() | GET /requirement_types |
client.requirementTypes.retrieve() | GET /requirement_types/{id} |
client.requirements.list() | GET /requirements |
client.requirements.retrieve() | GET /requirements/{id} |
Verify — 21 methods
Verify — 21 methods
| Method | Endpoint |
|---|---|
client.verifications.triggerCall() | POST /verifications/call |
client.verifications.triggerFlashcall() | POST /verifications/flashcall |
client.verifications.triggerSMS() | POST /verifications/sms |
client.verifications.retrieve() | GET /verifications/{verification_id} |
client.verifications.triggerWhatsappVerification() | POST /verifications/whatsapp |
client.verifications.byPhoneNumber.list() | GET /verifications/by_phone_number/{phone_number} |
client.verifications.byPhoneNumber.actions.verify() | POST /verifications/by_phone_number/{phone_number}/actions/verify |
client.verifications.actions.verify() | POST /verifications/{verification_id}/actions/verify |
client.verifiedNumbers.list() | GET /verified_numbers |
client.verifiedNumbers.create() | POST /verified_numbers |
client.verifiedNumbers.delete() | DELETE /verified_numbers/{phone_number} |
client.verifiedNumbers.retrieve() | GET /verified_numbers/{phone_number} |
client.verifiedNumbers.actions.submitVerificationCode() | POST /verified_numbers/{phone_number}/actions/verify |
client.verifyProfiles.list() | GET /verify_profiles |
client.verifyProfiles.create() | POST /verify_profiles |
client.verifyProfiles.retrieveTemplates() | GET /verify_profiles/templates |
client.verifyProfiles.delete() | DELETE /verify_profiles/{verify_profile_id} |
client.verifyProfiles.retrieve() | GET /verify_profiles/{verify_profile_id} |
client.verifyProfiles.update() | PATCH /verify_profiles/{verify_profile_id} |
client.verifyProfiles.createTemplate() | POST /verify_profiles/templates |
client.verifyProfiles.updateTemplate() | PATCH /verify_profiles/templates/{template_id} |
Voice Channels — 6 methods
Voice Channels — 6 methods
| Method | Endpoint |
|---|---|
client.channelZones.list() | GET /channel_zones |
client.channelZones.update() | PUT /channel_zones/{channel_zone_id} |
client.inboundChannels.list() | GET /inbound_channels |
client.inboundChannels.update() | PATCH /inbound_channels |
client.list.retrieveAll() | GET /list |
client.list.retrieveByZone() | GET /list/{channel_zone_id} |
Wireless
Mobile Network Operators — 1 method
Mobile Network Operators — 1 method
| Method | Endpoint |
|---|---|
client.mobileNetworkOperators.list() | GET /mobile_network_operators |
mobilePhoneNumbers — 5 methods
mobilePhoneNumbers — 5 methods
| Method | Endpoint |
|---|---|
client.mobilePhoneNumbers.list() | GET /v2/mobile_phone_numbers |
client.mobilePhoneNumbers.retrieve() | GET /v2/mobile_phone_numbers/{id} |
client.mobilePhoneNumbers.update() | PATCH /v2/mobile_phone_numbers/{id} |
client.mobilePhoneNumbers.messaging.list() | GET /mobile_phone_numbers/messaging |
client.mobilePhoneNumbers.messaging.retrieve() | GET /mobile_phone_numbers/{id}/messaging |
mobileVoiceConnections — 5 methods
mobileVoiceConnections — 5 methods
| Method | Endpoint |
|---|---|
client.mobileVoiceConnections.list() | GET /v2/mobile_voice_connections |
client.mobileVoiceConnections.create() | POST /v2/mobile_voice_connections |
client.mobileVoiceConnections.delete() | DELETE /v2/mobile_voice_connections/{id} |
client.mobileVoiceConnections.retrieve() | GET /v2/mobile_voice_connections/{id} |
client.mobileVoiceConnections.update() | PATCH /v2/mobile_voice_connections/{id} |
Network Coverage — 1 method
Network Coverage — 1 method
| Method | Endpoint |
|---|---|
client.networkCoverage.list() | GET /network_coverage |
SIM Card Actions — 6 methods
SIM Card Actions — 6 methods
| Method | Endpoint |
|---|---|
client.actions.purchase.create() | POST /actions/purchase/esims |
client.actions.register.create() | POST /actions/register/sim_cards |
client.bulkSimCardActions.list() | GET /bulk_sim_card_actions |
client.bulkSimCardActions.retrieve() | GET /bulk_sim_card_actions/{id} |
client.otaUpdates.list() | GET /ota_updates |
client.otaUpdates.retrieve() | GET /ota_updates/{id} |
SIM Card Orders — 4 methods
SIM Card Orders — 4 methods
| Method | Endpoint |
|---|---|
client.simCardOrderPreview.preview() | POST /sim_card_order_preview |
client.simCardOrders.list() | GET /sim_card_orders |
client.simCardOrders.create() | POST /sim_card_orders |
client.simCardOrders.retrieve() | GET /sim_card_orders/{id} |
simCardDataUsageNotifications — 5 methods
simCardDataUsageNotifications — 5 methods
| Method | Endpoint |
|---|---|
client.simCardDataUsageNotifications.list() | GET /sim_card_data_usage_notifications |
client.simCardDataUsageNotifications.create() | POST /sim_card_data_usage_notifications |
client.simCardDataUsageNotifications.delete() | DELETE /sim_card_data_usage_notifications/{id} |
client.simCardDataUsageNotifications.retrieve() | GET /sim_card_data_usage_notifications/{id} |
client.simCardDataUsageNotifications.update() | PATCH /sim_card_data_usage_notifications/{id} |
simCardGroups — 11 methods
simCardGroups — 11 methods
| Method | Endpoint |
|---|---|
client.simCardGroups.list() | GET /sim_card_groups |
client.simCardGroups.create() | POST /sim_card_groups |
client.simCardGroups.delete() | DELETE /sim_card_groups/{id} |
client.simCardGroups.retrieve() | GET /sim_card_groups/{id} |
client.simCardGroups.update() | PATCH /sim_card_groups/{id} |
client.simCardGroups.actions.list() | GET /sim_card_group_actions |
client.simCardGroups.actions.retrieve() | GET /sim_card_group_actions/{id} |
client.simCardGroups.actions.removePrivateWirelessGateway() | POST /sim_card_groups/{id}/actions/remove_private_wireless_gateway |
client.simCardGroups.actions.removeWirelessBlocklist() | POST /sim_card_groups/{id}/actions/remove_wireless_blocklist |
client.simCardGroups.actions.setPrivateWirelessGateway() | POST /sim_card_groups/{id}/actions/set_private_wireless_gateway |
client.simCardGroups.actions.setWirelessBlocklist() | POST /sim_card_groups/{id}/actions/set_wireless_blocklist |
simCards — 19 methods
simCards — 19 methods
| Method | Endpoint |
|---|---|
client.simCards.list() | GET /sim_cards |
client.simCards.delete() | DELETE /sim_cards/{id} |
client.simCards.retrieve() | GET /sim_cards/{id} |
client.simCards.update() | PATCH /sim_cards/{id} |
client.simCards.getActivationCode() | GET /sim_cards/{id}/activation_code |
client.simCards.getDeviceDetails() | GET /sim_cards/{id}/device_details |
client.simCards.getPublicIP() | GET /sim_cards/{id}/public_ip |
client.simCards.listWirelessConnectivityLogs() | GET /sim_cards/{id}/wireless_connectivity_logs |
client.simCards.actions.list() | GET /sim_card_actions |
client.simCards.actions.retrieve() | GET /sim_card_actions/{id} |
client.simCards.actions.bulkSetPublicIPs() | POST /sim_cards/actions/bulk_set_public_ips |
client.simCards.actions.validateRegistrationCodes() | POST /sim_cards/actions/validate_registration_codes |
client.simCards.actions.disable() | POST /sim_cards/{id}/actions/disable |
client.simCards.actions.enable() | POST /sim_cards/{id}/actions/enable |
client.simCards.actions.removePublicIP() | POST /sim_cards/{id}/actions/remove_public_ip |
client.simCards.actions.setPublicIP() | POST /sim_cards/{id}/actions/set_public_ip |
client.simCards.actions.setStandby() | POST /sim_cards/{id}/actions/set_standby |
client.simCards.actions.bulkDisableVoice() | POST /sim_cards/actions/bulk_disable_voice |
client.simCards.actions.bulkEnableVoice() | POST /sim_cards/actions/bulk_enable_voice |
Wireless — 5 methods
Wireless — 5 methods
| Method | Endpoint |
|---|---|
client.wireless.retrieveRegions() | GET /wireless/regions |
client.wireless.detailRecordsReports.list() | GET /wireless/detail_records_reports |
client.wireless.detailRecordsReports.create() | POST /wireless/detail_records_reports |
client.wireless.detailRecordsReports.delete() | DELETE /wireless/detail_records_reports/{id} |
client.wireless.detailRecordsReports.retrieve() | GET /wireless/detail_records_reports/{id} |
Wireless Blocklists — 6 methods
Wireless Blocklists — 6 methods
| Method | Endpoint |
|---|---|
client.wirelessBlocklistValues.list() | GET /wireless_blocklist_values |
client.wirelessBlocklists.list() | GET /wireless_blocklists |
client.wirelessBlocklists.update() | PATCH /wireless_blocklists/{id} |
client.wirelessBlocklists.create() | POST /wireless_blocklists |
client.wirelessBlocklists.delete() | DELETE /wireless_blocklists/{id} |
client.wirelessBlocklists.retrieve() | GET /wireless_blocklists/{id} |
Legacy APIs
Legacy — 26 methods
Legacy — 26 methods
| Method | Endpoint |
|---|---|
client.legacy.reporting.batchDetailRecords.messaging.list() | GET /legacy/reporting/batch_detail_records/messaging |
client.legacy.reporting.batchDetailRecords.messaging.create() | POST /legacy/reporting/batch_detail_records/messaging |
client.legacy.reporting.batchDetailRecords.messaging.delete() | DELETE /legacy/reporting/batch_detail_records/messaging/{id} |
client.legacy.reporting.batchDetailRecords.messaging.retrieve() | GET /legacy/reporting/batch_detail_records/messaging/{id} |
client.legacy.reporting.batchDetailRecords.speechToText.list() | GET /legacy/reporting/batch_detail_records/speech_to_text |
client.legacy.reporting.batchDetailRecords.speechToText.create() | POST /legacy/reporting/batch_detail_records/speech_to_text |
client.legacy.reporting.batchDetailRecords.speechToText.delete() | DELETE /legacy/reporting/batch_detail_records/speech_to_text/{id} |
client.legacy.reporting.batchDetailRecords.speechToText.retrieve() | GET /legacy/reporting/batch_detail_records/speech_to_text/{id} |
client.legacy.reporting.batchDetailRecords.voice.list() | GET /legacy/reporting/batch_detail_records/voice |
client.legacy.reporting.batchDetailRecords.voice.create() | POST /legacy/reporting/batch_detail_records/voice |
client.legacy.reporting.batchDetailRecords.voice.retrieveFields() | GET /legacy/reporting/batch_detail_records/voice/fields |
client.legacy.reporting.batchDetailRecords.voice.delete() | DELETE /legacy/reporting/batch_detail_records/voice/{id} |
client.legacy.reporting.batchDetailRecords.voice.retrieve() | GET /legacy/reporting/batch_detail_records/voice/{id} |
client.legacy.reporting.usageReports.retrieveSpeechToText() | GET /legacy/reporting/usage_reports/speech_to_text |
client.legacy.reporting.usageReports.messaging.list() | GET /legacy/reporting/usage_reports/messaging |
client.legacy.reporting.usageReports.messaging.create() | POST /legacy/reporting/usage_reports/messaging |
client.legacy.reporting.usageReports.messaging.delete() | DELETE /legacy/reporting/usage_reports/messaging/{id} |
client.legacy.reporting.usageReports.messaging.retrieve() | GET /legacy/reporting/usage_reports/messaging/{id} |
client.legacy.reporting.usageReports.numberLookup.list() | GET /legacy/reporting/usage_reports/number_lookup |
client.legacy.reporting.usageReports.numberLookup.create() | POST /legacy/reporting/usage_reports/number_lookup |
client.legacy.reporting.usageReports.numberLookup.delete() | DELETE /legacy/reporting/usage_reports/number_lookup/{id} |
client.legacy.reporting.usageReports.numberLookup.retrieve() | GET /legacy/reporting/usage_reports/number_lookup/{id} |
client.legacy.reporting.usageReports.voice.list() | GET /legacy/reporting/usage_reports/voice |
client.legacy.reporting.usageReports.voice.create() | POST /legacy/reporting/usage_reports/voice |
client.legacy.reporting.usageReports.voice.delete() | DELETE /legacy/reporting/usage_reports/voice/{id} |
client.legacy.reporting.usageReports.voice.retrieve() | GET /legacy/reporting/usage_reports/voice/{id} |