Fundamentals
Access IPs — 7 methods
Access IPs — 7 methods
| Method | Endpoint |
|---|---|
client.accessIpAddress().create() | POST /access_ip_address |
client.accessIpAddress().retrieve() | GET /access_ip_address/{access_ip_address_id} |
client.accessIpAddress().list() | GET /access_ip_address |
client.accessIpAddress().delete() | DELETE /access_ip_address/{access_ip_address_id} |
client.accessIpRanges().create() | POST /access_ip_ranges |
client.accessIpRanges().list() | GET /access_ip_ranges |
client.accessIpRanges().delete() | DELETE /access_ip_ranges/{access_ip_range_id} |
Addresses — 9 methods
Addresses — 9 methods
| Method | Endpoint |
|---|---|
client.addresses().create() | POST /addresses |
client.addresses().retrieve() | GET /addresses/{id} |
client.addresses().list() | GET /addresses |
client.addresses().delete() | DELETE /addresses/{id} |
client.addresses().actions().acceptSuggestions() | POST /addresses/{id}/actions/accept_suggestions |
client.addresses().actions().validate() | POST /addresses/actions/validate |
client.userAddresses().create() | POST /user_addresses |
client.userAddresses().retrieve() | GET /user_addresses/{id} |
client.userAddresses().list() | GET /user_addresses |
auditEvents — 1 method
auditEvents — 1 method
| Method | Endpoint |
|---|---|
client.auditEvents().list() | GET /audit_events |
authenticationProviders — 5 methods
authenticationProviders — 5 methods
| Method | Endpoint |
|---|---|
client.authenticationProviders().create() | POST /authentication_providers |
client.authenticationProviders().retrieve() | GET /authentication_providers/{id} |
client.authenticationProviders().update() | PATCH /authentication_providers/{id} |
client.authenticationProviders().list() | GET /authentication_providers |
client.authenticationProviders().delete() | DELETE /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().create() | POST /billing_groups |
client.billingGroups().retrieve() | GET /billing_groups/{id} |
client.billingGroups().update() | PATCH /billing_groups/{id} |
client.billingGroups().list() | GET /billing_groups |
client.billingGroups().delete() | DELETE /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().create() | POST /fax_applications |
client.faxApplications().retrieve() | GET /fax_applications/{id} |
client.faxApplications().update() | PATCH /fax_applications/{id} |
client.faxApplications().list() | GET /fax_applications |
client.faxApplications().delete() | DELETE /fax_applications/{id} |
client.faxes().create() | POST /faxes |
client.faxes().retrieve() | GET /faxes/{id} |
client.faxes().list() | GET /faxes |
client.faxes().delete() | DELETE /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().create() | POST /integration_secrets |
client.integrationSecrets().list() | GET /integration_secrets |
client.integrationSecrets().delete() | DELETE /integration_secrets/{id} |
invoices — 2 methods
invoices — 2 methods
| Method | Endpoint |
|---|---|
client.invoices().retrieve() | GET /invoices/{id} |
client.invoices().list() | GET /invoices |
managedAccounts — 8 methods
managedAccounts — 8 methods
| Method | Endpoint |
|---|---|
client.managedAccounts().create() | POST /managed_accounts |
client.managedAccounts().retrieve() | GET /managed_accounts/{id} |
client.managedAccounts().update() | PATCH /managed_accounts/{id} |
client.managedAccounts().list() | GET /managed_accounts |
client.managedAccounts().getAllocatableGlobalOutboundChannels() | GET /managed_accounts/allocatable_global_outbound_channels |
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().create() | POST /notification_channels |
client.notificationChannels().retrieve() | GET /notification_channels/{id} |
client.notificationChannels().update() | PATCH /notification_channels/{id} |
client.notificationChannels().list() | GET /notification_channels |
client.notificationChannels().delete() | DELETE /notification_channels/{id} |
client.notificationEventConditions().list() | GET /notification_event_conditions |
client.notificationEvents().list() | GET /notification_events |
client.notificationProfiles().create() | POST /notification_profiles |
client.notificationProfiles().retrieve() | GET /notification_profiles/{id} |
client.notificationProfiles().update() | PATCH /notification_profiles/{id} |
client.notificationProfiles().list() | GET /notification_profiles |
client.notificationProfiles().delete() | DELETE /notification_profiles/{id} |
client.notificationSettings().create() | POST /notification_settings |
client.notificationSettings().retrieve() | GET /notification_settings/{id} |
client.notificationSettings().list() | GET /notification_settings |
client.notificationSettings().delete() | DELETE /notification_settings/{id} |
OAuth — 15 methods
OAuth — 15 methods
| Method | Endpoint |
|---|---|
client.oauth().retrieve() | GET /oauth/consent/{consent_token} |
client.oauth().grants() | POST /oauth/grants |
client.oauth().introspect() | POST /oauth/introspect |
client.oauth().register() | POST /oauth/register |
client.oauth().retrieveAuthorize() | GET /oauth/authorize |
client.oauth().retrieveJwks() | GET /oauth/jwks |
client.oauth().token() | POST /oauth/token |
client.oauthClients().create() | POST /oauth_clients |
client.oauthClients().retrieve() | GET /oauth_clients/{id} |
client.oauthClients().update() | PUT /oauth_clients/{id} |
client.oauthClients().list() | GET /oauth_clients |
client.oauthClients().delete() | DELETE /oauth_clients/{id} |
client.oauthGrants().retrieve() | GET /oauth_grants/{id} |
client.oauthGrants().list() | GET /oauth_grants |
client.oauthGrants().delete() | DELETE /oauth_grants/{id} |
organizations — 4 methods
organizations — 4 methods
| Method | Endpoint |
|---|---|
client.organizations().users().retrieve() | GET /organizations/users/{id} |
client.organizations().users().list() | GET /organizations/users |
client.organizations().users().getGroupsReport() | GET /organizations/users/users_groups_report |
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().update() | PATCH /payment/auto_recharge_prefs |
client.payment().autoRechargePrefs().list() | GET /payment/auto_recharge_prefs |
pricing — 2 methods
pricing — 2 methods
| Method | Endpoint |
|---|---|
client.pricing().products().retrieve() | GET /pricing/products/{slug} |
client.pricing().products().list() | GET /pricing/products |
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().create() | POST /reports/mdr_usage_reports |
client.reports().mdrUsageReports().retrieve() | GET /reports/mdr_usage_reports/{id} |
client.reports().mdrUsageReports().list() | GET /reports/mdr_usage_reports |
client.reports().mdrUsageReports().delete() | DELETE /reports/mdr_usage_reports/{id} |
client.reports().mdrUsageReports().fetchSync() | GET /reports/mdr_usage_reports/sync |
client.usageReports().list() | GET /usage_reports |
client.usageReports().getOptions() | GET /usage_reports/options |
roomCompositions — 4 methods
roomCompositions — 4 methods
| Method | Endpoint |
|---|---|
client.roomCompositions().create() | POST /room_compositions |
client.roomCompositions().retrieve() | GET /room_compositions/{room_composition_id} |
client.roomCompositions().list() | GET /room_compositions |
client.roomCompositions().delete() | DELETE /room_compositions/{room_composition_id} |
roomParticipants — 2 methods
roomParticipants — 2 methods
| Method | Endpoint |
|---|---|
client.roomParticipants().retrieve() | GET /room_participants/{room_participant_id} |
client.roomParticipants().list() | GET /room_participants |
roomRecordings — 4 methods
roomRecordings — 4 methods
| Method | Endpoint |
|---|---|
client.roomRecordings().retrieve() | GET /room_recordings/{room_recording_id} |
client.roomRecordings().list() | GET /room_recordings |
client.roomRecordings().delete() | DELETE /room_recordings/{room_recording_id} |
client.roomRecordings().deleteBulk() | DELETE /room_recordings |
rooms — 15 methods
rooms — 15 methods
| Method | Endpoint |
|---|---|
client.rooms().create() | POST /rooms |
client.rooms().retrieve() | GET /rooms/{room_id} |
client.rooms().update() | PATCH /rooms/{room_id} |
client.rooms().list() | GET /rooms |
client.rooms().delete() | DELETE /rooms/{room_id} |
client.rooms().actions().generateJoinClientToken() | POST /rooms/{room_id}/actions/generate_join_client_token |
client.rooms().actions().refreshClientToken() | POST /rooms/{room_id}/actions/refresh_client_token |
client.rooms().sessions().retrieve() | GET /room_sessions/{room_session_id} |
client.rooms().sessions().list0() | GET /room_sessions |
client.rooms().sessions().list1() | GET /rooms/{room_id}/sessions |
client.rooms().sessions().retrieveParticipants() | GET /room_sessions/{room_session_id}/participants |
client.rooms().sessions().actions().end() | POST /room_sessions/{room_session_id}/actions/end |
client.rooms().sessions().actions().kick() | POST /room_sessions/{room_session_id}/actions/kick |
client.rooms().sessions().actions().mute() | POST /room_sessions/{room_session_id}/actions/mute |
client.rooms().sessions().actions().unmute() | POST /room_sessions/{room_session_id}/actions/unmute |
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().retrieve() | GET /webhook_deliveries/{id} |
client.webhookDeliveries().list() | GET /webhook_deliveries |
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().createQuote() | POST /v2/x402/credit_account/quote |
client.x402().creditAccount().settle() | POST /v2/x402/credit_account |
Agent Tools
webSearch — 4 methods
webSearch — 4 methods
| Method | Endpoint |
|---|---|
client.webSearch().create() | POST /web_search |
client.webSearch().contents() | POST /web_search/contents |
client.webSearch().research().create() | POST /web_search/research |
client.webSearch().research().retrieve() | GET /web_search/research/{task_id} |
AI
ai — 158 methods
ai — 158 methods
| Method | Endpoint |
|---|---|
client.ai().retrieveConversationHistories() | GET /ai/conversation_histories |
client.ai().summarize() | POST /ai/summarize |
client.ai().assistants().create() | POST /ai/assistants |
client.ai().assistants().retrieve() | GET /ai/assistants/{assistant_id} |
client.ai().assistants().update() | POST /ai/assistants/{assistant_id} |
client.ai().assistants().list() | GET /ai/assistants |
client.ai().assistants().delete() | DELETE /ai/assistants/{assistant_id} |
client.ai().assistants().chat() | POST /ai/assistants/{assistant_id}/chat |
client.ai().assistants().clone() | POST /ai/assistants/{assistant_id}/clone |
client.ai().assistants().getTexml() | GET /ai/assistants/{assistant_id}/texml |
client.ai().assistants().imports() | POST /ai/assistants/import |
client.ai().assistants().sendSms() | POST /ai/assistants/{assistant_id}/chat/sms |
client.ai().assistants().tests().create() | POST /ai/assistants/tests |
client.ai().assistants().tests().retrieve() | GET /ai/assistants/tests/{test_id} |
client.ai().assistants().tests().update() | PUT /ai/assistants/tests/{test_id} |
client.ai().assistants().tests().list() | GET /ai/assistants/tests |
client.ai().assistants().tests().delete() | DELETE /ai/assistants/tests/{test_id} |
client.ai().assistants().tests().testSuites().list() | GET /ai/assistants/tests/test-suites |
client.ai().assistants().tests().testSuites().runs().list() | GET /ai/assistants/tests/test-suites/{suite_name}/runs |
client.ai().assistants().tests().testSuites().runs().trigger() | POST /ai/assistants/tests/test-suites/{suite_name}/runs |
client.ai().assistants().tests().runs().retrieve() | GET /ai/assistants/tests/{test_id}/runs/{run_id} |
client.ai().assistants().tests().runs().list() | GET /ai/assistants/tests/{test_id}/runs |
client.ai().assistants().tests().runs().trigger() | POST /ai/assistants/tests/{test_id}/runs |
client.ai().assistants().canaryDeploys().create() | POST /ai/assistants/{assistant_id}/canary-deploys |
client.ai().assistants().canaryDeploys().retrieve() | GET /ai/assistants/{assistant_id}/canary-deploys |
client.ai().assistants().canaryDeploys().update() | PUT /ai/assistants/{assistant_id}/canary-deploys |
client.ai().assistants().canaryDeploys().delete() | DELETE /ai/assistants/{assistant_id}/canary-deploys |
client.ai().assistants().scheduledEvents().create() | POST /ai/assistants/{assistant_id}/scheduled_events |
client.ai().assistants().scheduledEvents().retrieve() | GET /ai/assistants/{assistant_id}/scheduled_events/{event_id} |
client.ai().assistants().scheduledEvents().list() | GET /ai/assistants/{assistant_id}/scheduled_events |
client.ai().assistants().scheduledEvents().delete() | DELETE /ai/assistants/{assistant_id}/scheduled_events/{event_id} |
client.ai().assistants().tools().add() | PUT /ai/assistants/{assistant_id}/tools/{tool_id} |
client.ai().assistants().tools().remove() | DELETE /ai/assistants/{assistant_id}/tools/{tool_id} |
client.ai().assistants().tools().test() | POST /ai/assistants/{assistant_id}/tools/{tool_id}/test |
client.ai().assistants().versions().retrieve() | GET /ai/assistants/{assistant_id}/versions/{version_id} |
client.ai().assistants().versions().update() | POST /ai/assistants/{assistant_id}/versions/{version_id} |
client.ai().assistants().versions().list() | GET /ai/assistants/{assistant_id}/versions |
client.ai().assistants().versions().delete() | DELETE /ai/assistants/{assistant_id}/versions/{version_id} |
client.ai().assistants().versions().promote() | POST /ai/assistants/{assistant_id}/versions/{version_id}/promote |
client.ai().assistants().tags().list() | GET /ai/assistants/tags |
client.ai().assistants().tags().add() | POST /ai/assistants/{assistant_id}/tags |
client.ai().assistants().tags().remove() | DELETE /ai/assistants/{assistant_id}/tags/{tag} |
client.ai().assistants().instructions().enhance() | POST /ai/assistants/{assistant_id}/instructions/enhance |
client.ai().audio().transcribe() | POST /ai/audio/transcriptions |
client.ai().clusters().retrieve() | GET /ai/clusters/{task_id} |
client.ai().clusters().list() | GET /ai/clusters |
client.ai().clusters().delete() | DELETE /ai/clusters/{task_id} |
client.ai().clusters().compute() | POST /ai/clusters |
client.ai().clusters().fetchGraph() | GET /ai/clusters/{task_id}/graph |
client.ai().collections().create() | POST /ai/collections |
client.ai().collections().retrieve() | GET /ai/collections/slug/{slug} |
client.ai().collections().update() | PATCH /ai/collections/{uuid} |
client.ai().collections().list() | GET /ai/collections |
client.ai().collections().delete() | DELETE /ai/collections/{uuid} |
client.ai().collections().retrieveById() | GET /ai/collections/{uuid} |
client.ai().collections().retrieveDocuments() | GET /ai/collections/{slug}/documents |
client.ai().collections().settings().create() | PUT /ai/collections/{uuid}/settings |
client.ai().collections().settings().list() | GET /ai/collections/{uuid}/settings |
client.ai().collections().settings().patchAll() | PATCH /ai/collections/{uuid}/settings |
client.ai().collections().sources().create() | POST /ai/collections/{uuid}/sources |
client.ai().collections().sources().list() | GET /ai/collections/{uuid}/sources |
client.ai().collections().sources().delete() | DELETE /ai/collections/{uuid}/sources/{sourceId} |
client.ai().collections().sources().replace() | PUT /ai/collections/{uuid}/sources |
client.ai().conversations().create() | POST /ai/conversations |
client.ai().conversations().retrieve() | GET /ai/conversations/{conversation_id} |
client.ai().conversations().update() | PUT /ai/conversations/{conversation_id} |
client.ai().conversations().list() | GET /ai/conversations |
client.ai().conversations().delete() | DELETE /ai/conversations/{conversation_id} |
client.ai().conversations().addMessage() | POST /ai/conversations/{conversation_id}/message |
client.ai().conversations().retrieveConversationsInsights() | GET /ai/conversations/{conversation_id}/conversations-insights |
client.ai().conversations().insightGroups().retrieve() | GET /ai/conversations/insight-groups/{group_id} |
client.ai().conversations().insightGroups().update() | PUT /ai/conversations/insight-groups/{group_id} |
client.ai().conversations().insightGroups().delete() | DELETE /ai/conversations/insight-groups/{group_id} |
client.ai().conversations().insightGroups().insightGroups() | POST /ai/conversations/insight-groups |
client.ai().conversations().insightGroups().retrieveInsightGroups() | GET /ai/conversations/insight-groups |
client.ai().conversations().insightGroups().insights().assign() | POST /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign |
client.ai().conversations().insightGroups().insights().deleteUnassign() | DELETE /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign |
client.ai().conversations().insights().create() | POST /ai/conversations/insights |
client.ai().conversations().insights().retrieve() | GET /ai/conversations/insights/{insight_id} |
client.ai().conversations().insights().update() | PUT /ai/conversations/insights/{insight_id} |
client.ai().conversations().insights().list() | GET /ai/conversations/insights |
client.ai().conversations().insights().delete() | DELETE /ai/conversations/insights/{insight_id} |
client.ai().conversations().messages().list() | GET /ai/conversations/{conversation_id}/messages |
client.ai().conversations().conversationInsights().retrieveAggregates() | GET /ai/conversations/conversation-insights/aggregates |
client.ai().embeddings().create() | POST /ai/embeddings |
client.ai().embeddings().retrieve() | GET /ai/embeddings/{task_id} |
client.ai().embeddings().list() | GET /ai/embeddings |
client.ai().embeddings().similaritySearch() | POST /ai/embeddings/similarity-search |
client.ai().embeddings().url() | POST /ai/embeddings/url |
client.ai().embeddings().buckets().retrieve() | GET /ai/embeddings/buckets/{bucket_name} |
client.ai().embeddings().buckets().list() | GET /ai/embeddings/buckets |
client.ai().embeddings().buckets().delete() | DELETE /ai/embeddings/buckets/{bucket_name} |
client.ai().fineTuning().jobs().create() | POST /ai/fine_tuning/jobs |
client.ai().fineTuning().jobs().retrieve() | GET /ai/fine_tuning/jobs/{job_id} |
client.ai().fineTuning().jobs().list() | GET /ai/fine_tuning/jobs |
client.ai().fineTuning().jobs().cancel() | POST /ai/fine_tuning/jobs/{job_id}/cancel |
client.ai().integrations().retrieve() | GET /ai/integrations/{integration_id} |
client.ai().integrations().list() | GET /ai/integrations |
client.ai().integrations().connections().retrieve() | GET /ai/integrations/connections/{user_connection_id} |
client.ai().integrations().connections().list() | GET /ai/integrations/connections |
client.ai().integrations().connections().delete() | DELETE /ai/integrations/connections/{user_connection_id} |
client.ai().mcpServers().create() | POST /ai/mcp_servers |
client.ai().mcpServers().retrieve() | GET /ai/mcp_servers/{mcp_server_id} |
client.ai().mcpServers().update() | PUT /ai/mcp_servers/{mcp_server_id} |
client.ai().mcpServers().list() | GET /ai/mcp_servers |
client.ai().mcpServers().delete() | DELETE /ai/mcp_servers/{mcp_server_id} |
client.ai().missions().create() | POST /ai/missions |
client.ai().missions().retrieve() | GET /ai/missions/{mission_id} |
client.ai().missions().list() | GET /ai/missions |
client.ai().missions().cloneMission() | POST /ai/missions/{mission_id}/clone |
client.ai().missions().deleteMission() | DELETE /ai/missions/{mission_id} |
client.ai().missions().listEvents() | GET /ai/missions/events |
client.ai().missions().updateMission() | PUT /ai/missions/{mission_id} |
client.ai().missions().runs().create() | POST /ai/missions/{mission_id}/runs |
client.ai().missions().runs().retrieve() | GET /ai/missions/{mission_id}/runs/{run_id} |
client.ai().missions().runs().update() | PATCH /ai/missions/{mission_id}/runs/{run_id} |
client.ai().missions().runs().list() | GET /ai/missions/{mission_id}/runs |
client.ai().missions().runs().cancelRun() | POST /ai/missions/{mission_id}/runs/{run_id}/cancel |
client.ai().missions().runs().listRuns() | GET /ai/missions/runs |
client.ai().missions().runs().pauseRun() | POST /ai/missions/{mission_id}/runs/{run_id}/pause |
client.ai().missions().runs().resumeRun() | POST /ai/missions/{mission_id}/runs/{run_id}/resume |
client.ai().missions().runs().events().list() | GET /ai/missions/{mission_id}/runs/{run_id}/events |
client.ai().missions().runs().events().getEventDetails() | GET /ai/missions/{mission_id}/runs/{run_id}/events/{event_id} |
client.ai().missions().runs().events().log() | POST /ai/missions/{mission_id}/runs/{run_id}/events |
client.ai().missions().runs().plan().create() | POST /ai/missions/{mission_id}/runs/{run_id}/plan |
client.ai().missions().runs().plan().retrieve() | GET /ai/missions/{mission_id}/runs/{run_id}/plan |
client.ai().missions().runs().plan().addStepsToPlan() | POST /ai/missions/{mission_id}/runs/{run_id}/plan/steps |
client.ai().missions().runs().plan().getStepDetails() | GET /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id} |
client.ai().missions().runs().plan().updateStep() | PATCH /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id} |
client.ai().missions().runs().telnyxAgents().list() | GET /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents |
client.ai().missions().runs().telnyxAgents().link() | POST /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents |
client.ai().missions().runs().telnyxAgents().unlink() | DELETE /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents/{telnyx_agent_id} |
client.ai().missions().knowledgeBases().createKnowledgeBase() | POST /ai/missions/{mission_id}/knowledge-bases |
client.ai().missions().knowledgeBases().deleteKnowledgeBase() | DELETE /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id} |
client.ai().missions().knowledgeBases().getKnowledgeBase() | GET /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id} |
client.ai().missions().knowledgeBases().listKnowledgeBases() | GET /ai/missions/{mission_id}/knowledge-bases |
client.ai().missions().knowledgeBases().updateKnowledgeBase() | PUT /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id} |
client.ai().missions().mcpServers().createMcpServer() | POST /ai/missions/{mission_id}/mcp-servers |
client.ai().missions().mcpServers().deleteMcpServer() | DELETE /ai/missions/{mission_id}/mcp-servers/{mcp_server_id} |
client.ai().missions().mcpServers().getMcpServer() | GET /ai/missions/{mission_id}/mcp-servers/{mcp_server_id} |
client.ai().missions().mcpServers().listMcpServers() | GET /ai/missions/{mission_id}/mcp-servers |
client.ai().missions().mcpServers().updateMcpServer() | PUT /ai/missions/{mission_id}/mcp-servers/{mcp_server_id} |
client.ai().missions().tools().createTool() | POST /ai/missions/{mission_id}/tools |
client.ai().missions().tools().deleteTool() | DELETE /ai/missions/{mission_id}/tools/{tool_id} |
client.ai().missions().tools().getTool() | GET /ai/missions/{mission_id}/tools/{tool_id} |
client.ai().missions().tools().listTools() | GET /ai/missions/{mission_id}/tools |
client.ai().missions().tools().updateTool() | PUT /ai/missions/{mission_id}/tools/{tool_id} |
client.ai().openai().createResponse() | POST /ai/openai/responses |
client.ai().openai().listModels() | GET /ai/openai/models |
client.ai().openai().embeddings().createEmbeddings() | POST /ai/openai/embeddings |
client.ai().openai().embeddings().listEmbeddingModels() | GET /ai/openai/embeddings/models |
client.ai().openai().chat().createCompletion() | POST /ai/openai/chat/completions |
client.ai().tools().create() | POST /ai/tools |
client.ai().tools().retrieve() | GET /ai/tools/{tool_id} |
client.ai().tools().update() | PATCH /ai/tools/{tool_id} |
client.ai().tools().list() | GET /ai/tools |
client.ai().tools().delete() | DELETE /ai/tools/{tool_id} |
client.ai().anthropic().v1().messages() | POST /ai/anthropic/v1/messages |
Voice
pronunciationDicts — 5 methods
pronunciationDicts — 5 methods
| Method | Endpoint |
|---|---|
client.pronunciationDicts().create() | POST /pronunciation_dicts |
client.pronunciationDicts().retrieve() | GET /pronunciation_dicts/{id} |
client.pronunciationDicts().update() | PATCH /pronunciation_dicts/{id} |
client.pronunciationDicts().list() | GET /pronunciation_dicts |
client.pronunciationDicts().delete() | DELETE /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().generateSpeech() | POST /text-to-speech/speech |
client.textToSpeech().listVoices() | GET /text-to-speech/voices |
client.textToSpeech().retrieveSpeech() | GET /text-to-speech/speech |
voiceClones — 6 methods
voiceClones — 6 methods
| Method | Endpoint |
|---|---|
client.voiceClones().create() | POST /voice_clones |
client.voiceClones().update() | PATCH /voice_clones/{id} |
client.voiceClones().list() | GET /voice_clones |
client.voiceClones().delete() | DELETE /voice_clones/{id} |
client.voiceClones().createFromUpload() | POST /voice_clones/from_upload |
client.voiceClones().downloadSample() | GET /voice_clones/{id}/sample |
voiceDesigns — 7 methods
voiceDesigns — 7 methods
| Method | Endpoint |
|---|---|
client.voiceDesigns().create() | POST /voice_designs |
client.voiceDesigns().retrieve() | GET /voice_designs/{id} |
client.voiceDesigns().list() | GET /voice_designs |
client.voiceDesigns().delete() | DELETE /voice_designs/{id} |
client.voiceDesigns().deleteVersion() | DELETE /voice_designs/{id}/versions/{version} |
client.voiceDesigns().downloadSample() | GET /voice_designs/{id}/sample |
client.voiceDesigns().rename() | PATCH /voice_designs/{id} |
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().create() | POST /global_ip_assignments |
client.globalIpAssignments().retrieve() | GET /global_ip_assignments/{id} |
client.globalIpAssignments().update() | PATCH /global_ip_assignments/{id} |
client.globalIpAssignments().list() | GET /global_ip_assignments |
client.globalIpAssignments().delete() | DELETE /global_ip_assignments/{id} |
client.globalIpAssignmentsUsage().retrieve() | GET /global_ip_assignments_usage |
client.globalIpHealthCheckTypes().list() | GET /global_ip_health_check_types |
client.globalIpHealthChecks().create() | POST /global_ip_health_checks |
client.globalIpHealthChecks().retrieve() | GET /global_ip_health_checks/{id} |
client.globalIpHealthChecks().list() | GET /global_ip_health_checks |
client.globalIpHealthChecks().delete() | DELETE /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().create() | POST /global_ips |
client.globalIps().retrieve() | GET /global_ips/{id} |
client.globalIps().list() | GET /global_ips |
client.globalIps().delete() | DELETE /global_ips/{id} |
networks — 9 methods
networks — 9 methods
| Method | Endpoint |
|---|---|
client.networks().create() | POST /networks |
client.networks().retrieve() | GET /networks/{id} |
client.networks().update() | PATCH /networks/{id} |
client.networks().list() | GET /networks |
client.networks().delete() | DELETE /networks/{id} |
client.networks().listInterfaces() | GET /networks/{id}/network_interfaces |
client.networks().defaultGateway().create() | POST /networks/{id}/default_gateway |
client.networks().defaultGateway().retrieve() | GET /networks/{id}/default_gateway |
client.networks().defaultGateway().delete() | DELETE /networks/{id}/default_gateway |
privateWirelessGateways — 4 methods
privateWirelessGateways — 4 methods
| Method | Endpoint |
|---|---|
client.privateWirelessGateways().create() | POST /private_wireless_gateways |
client.privateWirelessGateways().retrieve() | GET /private_wireless_gateways/{id} |
client.privateWirelessGateways().list() | GET /private_wireless_gateways |
client.privateWirelessGateways().delete() | DELETE /private_wireless_gateways/{id} |
publicInternetGateways — 4 methods
publicInternetGateways — 4 methods
| Method | Endpoint |
|---|---|
client.publicInternetGateways().create() | POST /public_internet_gateways |
client.publicInternetGateways().retrieve() | GET /public_internet_gateways/{id} |
client.publicInternetGateways().list() | GET /public_internet_gateways |
client.publicInternetGateways().delete() | DELETE /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().create() | POST /virtual_cross_connects |
client.virtualCrossConnects().retrieve() | GET /virtual_cross_connects/{id} |
client.virtualCrossConnects().update() | PATCH /virtual_cross_connects/{id} |
client.virtualCrossConnects().list() | GET /virtual_cross_connects |
client.virtualCrossConnects().delete() | DELETE /virtual_cross_connects/{id} |
client.virtualCrossConnectsCoverage().list() | GET /virtual_cross_connects_coverage |
WireGuard — 10 methods
WireGuard — 10 methods
| Method | Endpoint |
|---|---|
client.wireguardInterfaces().create() | POST /wireguard_interfaces |
client.wireguardInterfaces().retrieve() | GET /wireguard_interfaces/{id} |
client.wireguardInterfaces().list() | GET /wireguard_interfaces |
client.wireguardInterfaces().delete() | DELETE /wireguard_interfaces/{id} |
client.wireguardPeers().create() | POST /wireguard_peers |
client.wireguardPeers().retrieve() | GET /wireguard_peers/{id} |
client.wireguardPeers().update() | PATCH /wireguard_peers/{id} |
client.wireguardPeers().list() | GET /wireguard_peers |
client.wireguardPeers().delete() | DELETE /wireguard_peers/{id} |
client.wireguardPeers().retrieveConfig() | GET /wireguard_peers/{id}/config |
Storage
Storage — 34 methods
Storage — 34 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().create() | PUT /storage/buckets/{bucketName}/ssl_certificate |
client.storage().buckets().sslCertificate().retrieve() | GET /storage/buckets/{bucketName}/ssl_certificate |
client.storage().buckets().sslCertificate().delete() | DELETE /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().create() | POST /storage/migration_sources |
client.storage().migrationSources().retrieve() | GET /storage/migration_sources/{id} |
client.storage().migrationSources().list() | GET /storage/migration_sources |
client.storage().migrationSources().delete() | DELETE /storage/migration_sources/{id} |
client.storage().migrations().create() | POST /storage/migrations |
client.storage().migrations().retrieve() | GET /storage/migrations/{id} |
client.storage().migrations().list() | GET /storage/migrations |
client.storage().migrations().actions().stop() | POST /storage/migrations/{id}/actions/stop |
client.storage().kvs().create() | POST /storage/kvs |
client.storage().kvs().retrieve() | GET /storage/kvs/{id} |
client.storage().kvs().list() | GET /storage/kvs |
client.storage().kvs().delete() | DELETE /storage/kvs/{id} |
client.storage().kvs().keys().retrieve() | GET /storage/kvs/{id}/keys/{key} |
client.storage().kvs().keys().update() | PUT /storage/kvs/{id}/keys/{key} |
client.storage().kvs().keys().list() | GET /storage/kvs/{id}/keys |
client.storage().kvs().keys().delete() | DELETE /storage/kvs/{id}/keys/{key} |
client.storage().cloudfs().create() | POST /storage/cloudfs |
client.storage().cloudfs().retrieve() | GET /storage/cloudfs/{id} |
client.storage().cloudfs().update() | PATCH /storage/cloudfs/{id} |
client.storage().cloudfs().list() | GET /storage/cloudfs |
client.storage().cloudfs().delete() | DELETE /storage/cloudfs/{id} |
client.storage().cloudfs().actions().rotateMetaToken() | POST /storage/cloudfs/{id}/actions/rotate-meta-token |
client.storage().sqldbs().create() | POST /storage/sqldbs |
client.storage().sqldbs().retrieve() | GET /storage/sqldbs/{id} |
client.storage().sqldbs().list() | GET /storage/sqldbs |
client.storage().sqldbs().delete() | DELETE /storage/sqldbs/{id} |
client.storage().sqldbs().actions().query() | POST /storage/sqldbs/{id}/actions/query |
Calling
callControlApplications — 5 methods
callControlApplications — 5 methods
| Method | Endpoint |
|---|---|
client.callControlApplications().create() | POST /call_control_applications |
client.callControlApplications().retrieve() | GET /call_control_applications/{id} |
client.callControlApplications().update() | PATCH /call_control_applications/{id} |
client.callControlApplications().list() | GET /call_control_applications |
client.callControlApplications().delete() | DELETE /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
| Method | Endpoint |
|---|---|
client.conferences().create() | POST /conferences |
client.conferences().retrieve() | GET /conferences/{id} |
client.conferences().list() | GET /conferences |
client.conferences().listParticipants() | GET /conferences/{conference_id}/participants |
client.conferences().retrieveParticipant() | GET /conferences/{id}/participants/{participant_id} |
client.conferences().updateParticipant() | PATCH /conferences/{id}/participants/{participant_id} |
client.conferences().actions().update() | POST /conferences/{id}/actions/update |
client.conferences().actions().endConference() | POST /conferences/{id}/actions/end |
client.conferences().actions().gatherDtmfAudio() | POST /conferences/{id}/actions/gather_using_audio |
client.conferences().actions().hold() | POST /conferences/{id}/actions/hold |
client.conferences().actions().join() | POST /conferences/{id}/actions/join |
client.conferences().actions().leave() | POST /conferences/{id}/actions/leave |
client.conferences().actions().mute() | POST /conferences/{id}/actions/mute |
client.conferences().actions().play() | POST /conferences/{id}/actions/play |
client.conferences().actions().recordPause() | POST /conferences/{id}/actions/record_pause |
client.conferences().actions().recordResume() | POST /conferences/{id}/actions/record_resume |
client.conferences().actions().recordStart() | POST /conferences/{id}/actions/record_start |
client.conferences().actions().recordStop() | POST /conferences/{id}/actions/record_stop |
client.conferences().actions().sendDtmf() | POST /conferences/{id}/actions/send_dtmf |
client.conferences().actions().speak() | POST /conferences/{id}/actions/speak |
client.conferences().actions().stop() | POST /conferences/{id}/actions/stop |
client.conferences().actions().unhold() | POST /conferences/{id}/actions/unhold |
client.conferences().actions().unmute() | POST /conferences/{id}/actions/unmute |
connections — 3 methods
connections — 3 methods
| Method | Endpoint |
|---|---|
client.connections().retrieve() | GET /connections/{id} |
client.connections().list() | GET /connections |
client.connections().listActiveCalls() | GET /connections/{connection_id}/active_calls |
credentialConnections — 6 methods
credentialConnections — 6 methods
| Method | Endpoint |
|---|---|
client.credentialConnections().create() | POST /credential_connections |
client.credentialConnections().retrieve() | GET /credential_connections/{id} |
client.credentialConnections().update() | PATCH /credential_connections/{id} |
client.credentialConnections().list() | GET /credential_connections |
client.credentialConnections().delete() | DELETE /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().create() | POST /dialogflow_connections/{connection_id} |
client.dialogflowConnections().retrieve() | GET /dialogflow_connections/{connection_id} |
client.dialogflowConnections().update() | PUT /dialogflow_connections/{connection_id} |
client.dialogflowConnections().delete() | DELETE /dialogflow_connections/{connection_id} |
dir — 22 methods
dir — 22 methods
| Method | Endpoint |
|---|---|
client.dir().retrieve() | GET /dir/{dir_id} |
client.dir().update() | PATCH /dir/{dir_id} |
client.dir().list() | GET /dir |
client.dir().delete() | DELETE /dir/{dir_id} |
client.dir().listDocumentTypes() | GET /dir/document_types |
client.dir().listInfringementClaims() | GET /dir/{dir_id}/infringement_claims |
client.dir().newLoa() | POST /dir/{dir_id}/loa |
client.dir().submit() | POST /dir/{dir_id}/submit |
client.dir().updateInfringement() | PUT /dir/{dir_id}/infringement_update |
client.dir().comments().create() | POST /dir/{dir_id}/comments |
client.dir().comments().list() | GET /dir/{dir_id}/comments |
client.dir().phoneNumberBatches().retrieve() | GET /dir/{dir_id}/phone_number_batches/{batch_id} |
client.dir().phoneNumberBatches().list() | GET /dir/{dir_id}/phone_number_batches |
client.dir().phoneNumbers().list() | GET /dir/{dir_id}/phone_numbers |
client.dir().phoneNumbers().add() | POST /dir/{dir_id}/phone_numbers |
client.dir().phoneNumbers().remove() | DELETE /dir/{dir_id}/phone_numbers |
client.dir().references().create() | POST /dir/{dir_id}/references |
client.dir().references().update() | PATCH /dir/{dir_id}/references/{ref_type}/{slot} |
client.dir().references().list() | GET /dir/{dir_id}/references |
client.dir().verifyEmail().create() | POST /dir/{dir_id}/verify_email |
client.dir().verifyEmail().list() | GET /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().create() | POST /external_connections |
client.externalConnections().retrieve() | GET /external_connections/{id} |
client.externalConnections().update() | PATCH /external_connections/{id} |
client.externalConnections().list() | GET /external_connections |
client.externalConnections().delete() | DELETE /external_connections/{id} |
client.externalConnections().updateLocation() | PATCH /external_connections/{id}/locations/{location_id} |
client.externalConnections().logMessages().retrieve() | GET /external_connections/log_messages/{id} |
client.externalConnections().logMessages().list() | GET /external_connections/log_messages |
client.externalConnections().logMessages().dismiss() | DELETE /external_connections/log_messages/{id} |
client.externalConnections().civicAddresses().retrieve() | GET /external_connections/{id}/civic_addresses/{address_id} |
client.externalConnections().civicAddresses().list() | GET /external_connections/{id}/civic_addresses |
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().phoneNumbers().list() | GET /external_connections/{id}/phone_numbers |
client.externalConnections().releases().retrieve() | GET /external_connections/{id}/releases/{release_id} |
client.externalConnections().releases().list() | GET /external_connections/{id}/releases |
client.externalConnections().uploads().create() | POST /external_connections/{id}/uploads |
client.externalConnections().uploads().retrieve() | GET /external_connections/{id}/uploads/{ticket_id} |
client.externalConnections().uploads().list() | GET /external_connections/{id}/uploads |
client.externalConnections().uploads().pendingCount() | GET /external_connections/{id}/uploads/status |
client.externalConnections().uploads().refreshStatus() | POST /external_connections/{id}/uploads/refresh |
client.externalConnections().uploads().retry() | POST /external_connections/{id}/uploads/{ticket_id}/retry |
fqdnConnections — 7 methods
fqdnConnections — 7 methods
| Method | Endpoint |
|---|---|
client.fqdnConnections().create() | POST /fqdn_connections |
client.fqdnConnections().retrieve() | GET /fqdn_connections/{id} |
client.fqdnConnections().update() | PATCH /fqdn_connections/{id} |
client.fqdnConnections().list() | GET /fqdn_connections |
client.fqdnConnections().delete() | DELETE /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().create() | POST /fqdns |
client.fqdns().retrieve() | GET /fqdns/{id} |
client.fqdns().update() | PATCH /fqdns/{id} |
client.fqdns().list() | GET /fqdns |
client.fqdns().delete() | DELETE /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().create() | POST /ip_connections |
client.ipConnections().retrieve() | GET /ip_connections/{id} |
client.ipConnections().update() | PATCH /ip_connections/{id} |
client.ipConnections().list() | GET /ip_connections |
client.ipConnections().delete() | DELETE /ip_connections/{id} |
ips — 5 methods
ips — 5 methods
| Method | Endpoint |
|---|---|
client.ips().create() | POST /ips |
client.ips().retrieve() | GET /ips/{id} |
client.ips().update() | PATCH /ips/{id} |
client.ips().list() | GET /ips |
client.ips().delete() | DELETE /ips/{id} |
media — 6 methods
media — 6 methods
| Method | Endpoint |
|---|---|
client.media().retrieve() | GET /media/{media_name} |
client.media().update() | PUT /media/{media_name} |
client.media().list() | GET /media |
client.media().delete() | DELETE /media/{media_name} |
client.media().download() | GET /media/{media_name}/download |
client.media().upload() | POST /media |
mobilePushCredentials — 4 methods
mobilePushCredentials — 4 methods
| Method | Endpoint |
|---|---|
client.mobilePushCredentials().create() | POST /mobile_push_credentials |
client.mobilePushCredentials().retrieve() | GET /mobile_push_credentials/{push_credential_id} |
client.mobilePushCredentials().list() | GET /mobile_push_credentials |
client.mobilePushCredentials().delete() | DELETE /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().create() | POST /outbound_voice_profiles |
client.outboundVoiceProfiles().retrieve() | GET /outbound_voice_profiles/{id} |
client.outboundVoiceProfiles().update() | PATCH /outbound_voice_profiles/{id} |
client.outboundVoiceProfiles().list() | GET /outbound_voice_profiles |
client.outboundVoiceProfiles().delete() | DELETE /outbound_voice_profiles/{id} |
Queues — 9 methods
Queues — 9 methods
| Method | Endpoint |
|---|---|
client.queues().create() | POST /queues |
client.queues().retrieve() | GET /queues/{queue_name} |
client.queues().update() | POST /queues/{queue_name} |
client.queues().list() | GET /queues |
client.queues().delete() | DELETE /queues/{queue_name} |
client.queues().calls().retrieve() | GET /queues/{queue_name}/calls/{call_control_id} |
client.queues().calls().update() | PATCH /queues/{queue_name}/calls/{call_control_id} |
client.queues().calls().list() | GET /queues/{queue_name}/calls |
client.queues().calls().remove() | DELETE /queues/{queue_name}/calls/{call_control_id} |
Recordings — 11 methods
Recordings — 11 methods
| Method | Endpoint |
|---|---|
client.customStorageCredentials().create() | POST /custom_storage_credentials/{connection_id} |
client.customStorageCredentials().retrieve() | GET /custom_storage_credentials/{connection_id} |
client.customStorageCredentials().update() | PUT /custom_storage_credentials/{connection_id} |
client.customStorageCredentials().delete() | DELETE /custom_storage_credentials/{connection_id} |
client.recordingTranscriptions().retrieve() | GET /recording_transcriptions/{recording_transcription_id} |
client.recordingTranscriptions().list() | GET /recording_transcriptions |
client.recordingTranscriptions().delete() | DELETE /recording_transcriptions/{recording_transcription_id} |
client.recordings().retrieve() | GET /recordings/{recording_id} |
client.recordings().list() | GET /recordings |
client.recordings().delete() | DELETE /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().retrieve() | GET /siprec_connectors/{connector_name} |
client.siprecConnectors().update() | PUT /siprec_connectors/{connector_name} |
client.siprecConnectors().delete() | DELETE /siprec_connectors/{connector_name} |
telephonyCredentials — 6 methods
telephonyCredentials — 6 methods
| Method | Endpoint |
|---|---|
client.telephonyCredentials().create() | POST /telephony_credentials |
client.telephonyCredentials().retrieve() | GET /telephony_credentials/{id} |
client.telephonyCredentials().update() | PATCH /telephony_credentials/{id} |
client.telephonyCredentials().list() | GET /telephony_credentials |
client.telephonyCredentials().delete() | DELETE /telephony_credentials/{id} |
client.telephonyCredentials().createToken() | POST /telephony_credentials/{id}/token |
termsOfService — 6 methods
termsOfService — 6 methods
| Method | Endpoint |
|---|---|
client.termsOfService().retrieveInfo() | GET /terms_of_service/info |
client.termsOfService().retrieveStatus() | GET /terms_of_service/status |
client.termsOfService().numberReputation().agree() | POST /terms_of_service/number_reputation/agree |
client.termsOfService().agreements().retrieve() | GET /terms_of_service/agreements/{agreement_id} |
client.termsOfService().agreements().list() | GET /terms_of_service/agreements |
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().create() | POST /texml_applications |
client.texmlApplications().retrieve() | GET /texml_applications/{id} |
client.texmlApplications().update() | PATCH /texml_applications/{id} |
client.texmlApplications().list() | GET /texml_applications |
client.texmlApplications().delete() | DELETE /texml_applications/{id} |
Traffic Policy Profiles — 6 methods
Traffic Policy Profiles — 6 methods
| Method | Endpoint |
|---|---|
client.trafficPolicyProfiles().create() | POST /traffic_policy_profiles |
client.trafficPolicyProfiles().retrieve() | GET /traffic_policy_profiles/{id} |
client.trafficPolicyProfiles().update() | PATCH /traffic_policy_profiles/{id} |
client.trafficPolicyProfiles().list() | GET /traffic_policy_profiles |
client.trafficPolicyProfiles().delete() | DELETE /traffic_policy_profiles/{id} |
client.trafficPolicyProfiles().listServices() | GET /traffic_policy_profiles/services |
UAC Connections — 7 methods
UAC Connections — 7 methods
| Method | Endpoint |
|---|---|
client.uacConnections().create() | POST /uac_connections |
client.uacConnections().retrieve() | GET /uac_connections/{id} |
client.uacConnections().update() | PATCH /uac_connections/{id} |
client.uacConnections().list() | GET /uac_connections |
client.uacConnections().delete() | DELETE /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().retrieve() | GET /voice_sdk_call_reports/{call_id} |
client.voiceSdkCallReports().list() | GET /voice_sdk_call_reports |
Messaging
10DLC — 43 methods
10DLC — 43 methods
| Method | Endpoint |
|---|---|
client.messaging10dlc().getEnum() | GET /10dlc/enum/{endpoint} |
client.messaging10dlc().brand().create() | POST /10dlc/brand |
client.messaging10dlc().brand().retrieve() | GET /10dlc/brand/{brandId} |
client.messaging10dlc().brand().update() | PUT /10dlc/brand/{brandId} |
client.messaging10dlc().brand().list() | GET /10dlc/brand |
client.messaging10dlc().brand().delete() | DELETE /10dlc/brand/{brandId} |
client.messaging10dlc().brand().getFeedback() | GET /10dlc/brand/feedback/{brandId} |
client.messaging10dlc().brand().getSmsOtpByReference() | GET /10dlc/brand/smsOtp/{referenceId} |
client.messaging10dlc().brand().resend2faEmail() | POST /10dlc/brand/{brandId}/2faEmail |
client.messaging10dlc().brand().retrieveSmsOtpStatus() | GET /10dlc/brand/{brandId}/smsOtp |
client.messaging10dlc().brand().revet() | PUT /10dlc/brand/{brandId}/revet |
client.messaging10dlc().brand().triggerSmsOtp() | POST /10dlc/brand/{brandId}/smsOtp |
client.messaging10dlc().brand().verifySmsOtp() | PUT /10dlc/brand/{brandId}/smsOtp |
client.messaging10dlc().brand().externalVetting().list() | GET /10dlc/brand/{brandId}/externalVetting |
client.messaging10dlc().brand().externalVetting().imports() | PUT /10dlc/brand/{brandId}/externalVetting |
client.messaging10dlc().brand().externalVetting().order() | POST /10dlc/brand/{brandId}/externalVetting |
client.messaging10dlc().campaign().retrieve() | GET /10dlc/campaign/{campaignId} |
client.messaging10dlc().campaign().update() | PUT /10dlc/campaign/{campaignId} |
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().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().submitAppeal() | POST /10dlc/campaign/{campaignId}/appeal |
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().retrieve() | GET /10dlc/partner_campaigns/{campaignId} |
client.messaging10dlc().partnerCampaigns().update() | PATCH /10dlc/partner_campaigns/{campaignId} |
client.messaging10dlc().partnerCampaigns().list() | GET /10dlc/partner_campaigns |
client.messaging10dlc().partnerCampaigns().listSharedByMe() | GET /10dlc/partnerCampaign/sharedByMe |
client.messaging10dlc().partnerCampaigns().retrieveSharingStatus() | GET /10dlc/partnerCampaign/{campaignId}/sharing |
client.messaging10dlc().phoneNumberCampaigns().create() | POST /10dlc/phone_number_campaigns |
client.messaging10dlc().phoneNumberCampaigns().retrieve() | GET /10dlc/phone_number_campaigns/{phoneNumber} |
client.messaging10dlc().phoneNumberCampaigns().update() | PUT /10dlc/phone_number_campaigns/{phoneNumber} |
client.messaging10dlc().phoneNumberCampaigns().list() | GET /10dlc/phone_number_campaigns |
client.messaging10dlc().phoneNumberCampaigns().delete() | DELETE /10dlc/phone_number_campaigns/{phoneNumber} |
client.messaging10dlc().phoneNumberAssignmentByProfile().assign() | POST /10dlc/phoneNumberAssignmentByProfile |
client.messaging10dlc().phoneNumberAssignmentByProfile().listPhoneNumberStatus() | GET /10dlc/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers |
client.messaging10dlc().phoneNumberAssignmentByProfile().retrievePhoneNumberStatus() | GET /10dlc/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers |
client.messaging10dlc().phoneNumberAssignmentByProfile().retrieveStatus() | GET /10dlc/phoneNumberAssignmentByProfile/{taskId} |
Alphanumeric Sender IDs — 4 methods
Alphanumeric Sender IDs — 4 methods
| Method | Endpoint |
|---|---|
client.alphanumericSenderIds().create() | POST /alphanumeric_sender_ids |
client.alphanumericSenderIds().retrieve() | GET /alphanumeric_sender_ids/{id} |
client.alphanumericSenderIds().list() | GET /alphanumeric_sender_ids |
client.alphanumericSenderIds().delete() | DELETE /alphanumeric_sender_ids/{id} |
emailBlocks — 8 methods
emailBlocks — 8 methods
| Method | Endpoint |
|---|---|
client.emailBlocks().create() | POST /email_blocks |
client.emailBlocks().retrieve() | GET /email_blocks/{id} |
client.emailBlocks().list() | GET /email_blocks |
client.emailBlocks().delete() | DELETE /email_blocks/{id} |
client.emailBlocks().retrieveEvents() | GET /email_blocks/{id}/events |
client.emailBlocks().retrieveExport() | GET /email_blocks/export |
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().create() | POST /email_domains |
client.emailDomains().retrieve() | GET /email_domains/{id} |
client.emailDomains().update() | PATCH /email_domains/{id} |
client.emailDomains().list() | GET /email_domains |
client.emailDomains().delete() | DELETE /email_domains/{id} |
client.emailDomains().retrieveDnsRecords() | GET /email_domains/{domain_id}/dns_records |
client.emailDomains().retrieveHealth() | GET /email_domains/{id}/health |
client.emailDomains().verify() | POST /email_domains/{domain_id}/verify |
client.emailDomains().webhooks().create() | POST /email_domains/{domain_id}/webhooks |
client.emailDomains().webhooks().retrieve() | GET /email_domains/{domain_id}/webhooks/{id} |
client.emailDomains().webhooks().update() | PATCH /email_domains/{domain_id}/webhooks/{id} |
client.emailDomains().webhooks().list() | GET /email_domains/{domain_id}/webhooks |
client.emailDomains().webhooks().delete() | DELETE /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().create() | POST /email_messages |
client.emailMessages().retrieve() | GET /email_messages/{id} |
client.emailMessages().list() | GET /email_messages |
client.emailMessages().delete() | DELETE /email_messages/{id} |
client.emailMessages().batch() | POST /email_messages/batch |
client.emailMessages().deleteAll() | DELETE /email_messages |
client.emailMessages().deleteSchedule() | DELETE /email_messages/{email_id}/schedule |
client.emailMessages().retrieveEvents() | GET /email_messages/{email_id}/events |
client.emailMessages().recipients().retrieve() | GET /email_messages/{email_id}/recipients/{recipient_id} |
client.emailMessages().recipients().list() | GET /email_messages/{email_id}/recipients |
emailTemplates — 7 methods
emailTemplates — 7 methods
| Method | Endpoint |
|---|---|
client.emailTemplates().create() | POST /email_templates |
client.emailTemplates().retrieve() | GET /email_templates/{id} |
client.emailTemplates().update() | PATCH /email_templates/{id} |
client.emailTemplates().list() | GET /email_templates |
client.emailTemplates().delete() | DELETE /email_templates/{id} |
client.emailTemplates().render() | POST /email_templates/{id}/render |
client.emailTemplates().replace() | PUT /email_templates/{id} |
emailThreads — 2 methods
emailThreads — 2 methods
| Method | Endpoint |
|---|---|
client.emailThreads().retrieve() | GET /email_threads/{thread_id} |
client.emailThreads().list() | GET /email_threads |
emailUnsubscribeGroups — 8 methods
emailUnsubscribeGroups — 8 methods
| Method | Endpoint |
|---|---|
client.emailUnsubscribeGroups().create() | POST /email_unsubscribe_groups |
client.emailUnsubscribeGroups().retrieve() | GET /email_unsubscribe_groups/{id} |
client.emailUnsubscribeGroups().update() | PATCH /email_unsubscribe_groups/{id} |
client.emailUnsubscribeGroups().list() | GET /email_unsubscribe_groups |
client.emailUnsubscribeGroups().delete() | DELETE /email_unsubscribe_groups/{id} |
client.emailUnsubscribeGroups().suppressions().create() | POST /email_unsubscribe_groups/{id}/suppressions |
client.emailUnsubscribeGroups().suppressions().list() | GET /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().create() | POST /messaging_hosted_number_orders |
client.messagingHostedNumberOrders().retrieve() | GET /messaging_hosted_number_orders/{id} |
client.messagingHostedNumberOrders().list() | GET /messaging_hosted_number_orders |
client.messagingHostedNumberOrders().delete() | DELETE /messaging_hosted_number_orders/{id} |
client.messagingHostedNumberOrders().checkEligibility() | POST /messaging_hosted_number_orders/eligibility_numbers_check |
client.messagingHostedNumberOrders().createVerificationCodes() | POST /messaging_hosted_number_orders/{id}/verification_codes |
client.messagingHostedNumberOrders().validateCodes() | POST /messaging_hosted_number_orders/{id}/validation_codes |
client.messagingHostedNumberOrders().actions().uploadFile() | POST /messaging_hosted_number_orders/{id}/actions/file_upload |
client.messagingHostedNumbers().retrieve() | GET /messaging_hosted_numbers/{id} |
client.messagingHostedNumbers().update() | PATCH /messaging_hosted_numbers/{id} |
client.messagingHostedNumbers().list() | GET /messaging_hosted_numbers |
client.messagingHostedNumbers().delete() | DELETE /messaging_hosted_numbers/{id} |
Messages — 13 methods
Messages — 13 methods
| Method | Endpoint |
|---|---|
client.messages().retrieve() | GET /messages/{id} |
client.messages().cancelScheduled() | DELETE /messages/{id} |
client.messages().retrieveGroupMessages() | GET /messages/group/{message_id} |
client.messages().schedule() | POST /messages/schedule |
client.messages().send() | POST /messages |
client.messages().sendGroupMms() | POST /messages/group_mms |
client.messages().sendLongCode() | POST /messages/long_code |
client.messages().sendNumberPool() | POST /messages/number_pool |
client.messages().sendShortCode() | POST /messages/short_code |
client.messages().sendWithAlphanumericSender() | POST /messages/alphanumeric_sender_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().create() | POST /messaging_profiles |
client.messagingProfiles().retrieve() | GET /messaging_profiles/{id} |
client.messagingProfiles().update() | PATCH /messaging_profiles/{id} |
client.messagingProfiles().list() | GET /messaging_profiles |
client.messagingProfiles().delete() | DELETE /messaging_profiles/{id} |
client.messagingProfiles().listAlphanumericSenderIds() | GET /messaging_profiles/{id}/alphanumeric_sender_ids |
client.messagingProfiles().listPhoneNumbers() | GET /messaging_profiles/{id}/phone_numbers |
client.messagingProfiles().listShortCodes() | GET /messaging_profiles/{id}/short_codes |
client.messagingProfiles().retrieveMetrics() | GET /messaging_profiles/{id}/metrics |
client.messagingProfiles().autorespConfigs().create() | POST /messaging_profiles/{profile_id}/autoresp_configs |
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().autorespConfigs().list() | GET /messaging_profiles/{profile_id}/autoresp_configs |
client.messagingProfiles().autorespConfigs().delete() | DELETE /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().create() | POST /messaging_tollfree/verification/requests |
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().list() | GET /messaging_tollfree/verification/requests |
client.messagingTollfree().verification().requests().delete() | DELETE /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().inviteTestNumber() | PUT /messaging/rcs/test_number_invite/{id}/{phone_number} |
client.messaging().rcs().listBulkCapabilities() | POST /messaging/rcs/bulk_capabilities |
client.messaging().rcs().retrieveCapabilities() | GET /messaging/rcs/capabilities/{agent_id}/{phone_number} |
client.messaging().rcs().agents().retrieve() | GET /messaging/rcs/agents/{id} |
client.messaging().rcs().agents().update() | PATCH /messaging/rcs/agents/{id} |
client.messaging().rcs().agents().list() | GET /messaging/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().list() | GET /rcs/agents |
client.rcs().agents().launch() | POST /rcs/agents/{id}/launch |
client.rcs().agents().retrieveCarrierApprovals() | GET /rcs/agents/{id}/carrier_approvals |
client.rcs().agents().submit() | POST /rcs/agents/{id}/submit |
client.rcs().agents().testDevices().create() | POST /rcs/agents/{id}/test_devices |
client.rcs().agents().testDevices().list() | GET /rcs/agents/{id}/test_devices |
client.rcs().agents().testDevices().delete() | DELETE /rcs/agents/{id}/test_devices/{test_device_id} |
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().list() | GET /rcs/brands |
client.rcs().brands().submit() | POST /rcs/brands/{id}/submit |
shortCodes — 3 methods
shortCodes — 3 methods
| Method | Endpoint |
|---|---|
client.shortCodes().retrieve() | GET /short_codes/{id} |
client.shortCodes().update() | PATCH /short_codes/{id} |
client.shortCodes().list() | GET /short_codes |
WhatsApp — 29 methods
WhatsApp — 29 methods
| Method | Endpoint |
|---|---|
client.whatsapp().businessAccounts().retrieve() | GET /v2/whatsapp/business_accounts/{id} |
client.whatsapp().businessAccounts().list() | GET /v2/whatsapp/business_accounts |
client.whatsapp().businessAccounts().delete() | DELETE /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().create() | POST /v2/whatsapp/message_templates |
client.whatsapp().templates().list() | GET /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().get() | GET /whatsapp/phone_numbers |
client.whatsapp().phoneNumbers().resendVerification() | POST /v2/whatsapp/phone_numbers/{phone_number}/resend_verification |
client.whatsapp().phoneNumbers().retrieveConversationWindow() | GET /v2/whatsapp/phone_numbers/{phone_number}/conversation_window |
client.whatsapp().phoneNumbers().verify() | POST /v2/whatsapp/phone_numbers/{phone_number}/verify |
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().retrieve() | GET /v2/whatsapp/phone_numbers/{phone_number}/profile/photo |
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().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().retrieve() | GET /v2/whatsapp_message_templates/{id} |
client.whatsappMessageTemplates().update() | PATCH /v2/whatsapp_message_templates/{id} |
client.whatsappMessageTemplates().delete() | DELETE /v2/whatsapp_message_templates/{id} |
Numbers
advancedOrders — 4 methods
advancedOrders — 4 methods
| Method | Endpoint |
|---|---|
client.advancedOrders().create() | POST /advanced_orders |
client.advancedOrders().retrieve() | GET /advanced_orders/{order_id} |
client.advancedOrders().list() | GET /advanced_orders |
client.advancedOrders().updateRequirementGroup() | PATCH /advanced_orders/{advanced-order-id}/requirement_group |
bundlePricing — 8 methods
bundlePricing — 8 methods
| Method | Endpoint |
|---|---|
client.bundlePricing().billingBundles().retrieve() | GET /bundle_pricing/billing_bundles/{bundle_id} |
client.bundlePricing().billingBundles().list() | GET /bundle_pricing/billing_bundles |
client.bundlePricing().userBundles().create() | POST /bundle_pricing/user_bundles/bulk |
client.bundlePricing().userBundles().retrieve() | GET /bundle_pricing/user_bundles/{user_bundle_id} |
client.bundlePricing().userBundles().list() | GET /bundle_pricing/user_bundles |
client.bundlePricing().userBundles().deactivate() | DELETE /bundle_pricing/user_bundles/{user_bundle_id} |
client.bundlePricing().userBundles().listResources() | GET /bundle_pricing/user_bundles/{user_bundle_id}/resources |
client.bundlePricing().userBundles().listUnused() | GET /bundle_pricing/user_bundles/unused |
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().create() | POST /customer_service_records |
client.customerServiceRecords().retrieve() | GET /customer_service_records/{customer_service_record_id} |
client.customerServiceRecords().list() | GET /customer_service_records |
client.customerServiceRecords().verifyPhoneNumberCoverage() | POST /customer_service_records/phone_number_coverages |
Documents — 9 methods
Documents — 9 methods
| Method | Endpoint |
|---|---|
client.documentLinks().list() | GET /document_links |
client.documents().retrieve() | GET /documents/{id} |
client.documents().update() | PATCH /documents/{id} |
client.documents().list() | GET /documents |
client.documents().delete() | DELETE /documents/{id} |
client.documents().download() | GET /documents/{id}/download |
client.documents().generateDownloadLink() | GET /documents/{id}/download_link |
client.documents().upload() | POST /documents?content-type=multipart |
client.documents().uploadJson() | POST /documents |
Dynamic Emergency — 8 methods
Dynamic Emergency — 8 methods
| Method | Endpoint |
|---|---|
client.dynamicEmergencyAddresses().create() | POST /dynamic_emergency_addresses |
client.dynamicEmergencyAddresses().retrieve() | GET /dynamic_emergency_addresses/{id} |
client.dynamicEmergencyAddresses().list() | GET /dynamic_emergency_addresses |
client.dynamicEmergencyAddresses().delete() | DELETE /dynamic_emergency_addresses/{id} |
client.dynamicEmergencyEndpoints().create() | POST /dynamic_emergency_endpoints |
client.dynamicEmergencyEndpoints().retrieve() | GET /dynamic_emergency_endpoints/{id} |
client.dynamicEmergencyEndpoints().list() | GET /dynamic_emergency_endpoints |
client.dynamicEmergencyEndpoints().delete() | DELETE /dynamic_emergency_endpoints/{id} |
enterprises — 22 methods
enterprises — 22 methods
| Method | Endpoint |
|---|---|
client.enterprises().create() | POST /enterprises |
client.enterprises().retrieve() | GET /enterprises/{enterprise_id} |
client.enterprises().update() | PUT /enterprises/{enterprise_id} |
client.enterprises().list() | GET /enterprises |
client.enterprises().delete() | DELETE /enterprises/{enterprise_id} |
client.enterprises().brandedCalling() | POST /enterprises/{enterprise_id}/branded_calling |
client.enterprises().reputation().retrieve() | GET /enterprises/{enterprise_id}/reputation |
client.enterprises().reputation().disable() | DELETE /enterprises/{enterprise_id}/reputation |
client.enterprises().reputation().enable() | POST /enterprises/{enterprise_id}/reputation |
client.enterprises().reputation().updateFrequency() | PATCH /enterprises/{enterprise_id}/reputation/frequency |
client.enterprises().reputation().numbers().retrieve() | GET /enterprises/{enterprise_id}/reputation/numbers/{phone_number} |
client.enterprises().reputation().numbers().list() | GET /enterprises/{enterprise_id}/reputation/numbers |
client.enterprises().reputation().numbers().associate() | POST /enterprises/{enterprise_id}/reputation/numbers |
client.enterprises().reputation().numbers().disassociate() | DELETE /enterprises/{enterprise_id}/reputation/numbers/{phone_number} |
client.enterprises().reputation().numbers().refresh() | POST /enterprises/{enterprise_id}/reputation/numbers/refresh |
client.enterprises().reputation().loa().update() | PATCH /enterprises/{enterprise_id}/reputation/loa |
client.enterprises().reputation().loa().render() | POST /enterprises/{enterprise_id}/reputation/loa |
client.enterprises().reputation().remediation().create() | POST /enterprises/{enterprise_id}/reputation/remediation |
client.enterprises().reputation().remediation().retrieve() | GET /enterprises/{enterprise_id}/reputation/remediation/{remediation_id} |
client.enterprises().reputation().remediation().list() | GET /enterprises/{enterprise_id}/reputation/remediation |
client.enterprises().dir().create() | POST /enterprises/{enterprise_id}/dir |
client.enterprises().dir().list() | GET /enterprises/{enterprise_id}/dir |
inexplicitNumberOrders — 3 methods
inexplicitNumberOrders — 3 methods
| Method | Endpoint |
|---|---|
client.inexplicitNumberOrders().create() | POST /inexplicit_number_orders |
client.inexplicitNumberOrders().retrieve() | GET /inexplicit_number_orders/{id} |
client.inexplicitNumberOrders().list() | GET /inexplicit_number_orders |
inventoryCoverage — 1 method
inventoryCoverage — 1 method
| Method | Endpoint |
|---|---|
client.inventoryCoverage().list() | GET /inventory_coverage |
numberBlockOrders — 3 methods
numberBlockOrders — 3 methods
| Method | Endpoint |
|---|---|
client.numberBlockOrders().create() | POST /number_block_orders |
client.numberBlockOrders().retrieve() | GET /number_block_orders/{number_block_order_id} |
client.numberBlockOrders().list() | GET /number_block_orders |
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().create() | POST /number_reservations |
client.numberReservations().retrieve() | GET /number_reservations/{number_reservation_id} |
client.numberReservations().list() | GET /number_reservations |
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().create() | POST /comments |
client.comments().retrieve() | GET /comments/{id} |
client.comments().list() | GET /comments |
client.comments().markAsRead() | PATCH /comments/{id}/read |
client.numberOrderPhoneNumbers().retrieve() | GET /number_order_phone_numbers/{number_order_phone_number_id} |
client.numberOrderPhoneNumbers().list() | GET /number_order_phone_numbers |
client.numberOrderPhoneNumbers().updateRequirementGroup() | POST /number_order_phone_numbers/{id}/requirement_group |
client.numberOrderPhoneNumbers().updateRequirements() | PATCH /number_order_phone_numbers/{number_order_phone_number_id} |
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.numberOrders().list() | GET /number_orders |
client.subNumberOrders().retrieve() | GET /sub_number_orders/{sub_number_order_id} |
client.subNumberOrders().update() | PATCH /sub_number_orders/{sub_number_order_id} |
client.subNumberOrders().list() | GET /sub_number_orders |
client.subNumberOrders().cancel() | PATCH /sub_number_orders/{sub_number_order_id}/cancel |
client.subNumberOrders().updateRequirementGroup() | POST /sub_number_orders/{id}/requirement_group |
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().retrieve() | GET /phone_number_blocks/jobs/{id} |
client.phoneNumberBlocks().jobs().list() | GET /phone_number_blocks/jobs |
client.phoneNumberBlocks().jobs().deletePhoneNumberBlock() | POST /phone_number_blocks/jobs/delete_phone_number_block |
phoneNumbers — 25 methods
phoneNumbers — 25 methods
| Method | Endpoint |
|---|---|
client.phoneNumbers().retrieve() | GET /phone_numbers/{id} |
client.phoneNumbers().update() | PATCH /phone_numbers/{id} |
client.phoneNumbers().list() | GET /phone_numbers |
client.phoneNumbers().delete() | DELETE /phone_numbers/{id} |
client.phoneNumbers().slimList() | GET /phone_numbers/slim |
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().actions().verifyOwnership() | POST /phone_numbers/actions/verify_ownership |
client.phoneNumbers().csvDownloads().create() | POST /phone_numbers/csv_downloads |
client.phoneNumbers().csvDownloads().retrieve() | GET /phone_numbers/csv_downloads/{id} |
client.phoneNumbers().csvDownloads().list() | GET /phone_numbers/csv_downloads |
client.phoneNumbers().jobs().retrieve() | GET /phone_numbers/jobs/{id} |
client.phoneNumbers().jobs().list() | GET /phone_numbers/jobs |
client.phoneNumbers().jobs().deleteBatch() | POST /phone_numbers/jobs/delete_phone_numbers |
client.phoneNumbers().jobs().updateBatch() | POST /phone_numbers/jobs/update_phone_numbers |
client.phoneNumbers().jobs().updateEmergencySettingsBatch() | POST /phone_numbers/jobs/update_emergency_settings |
client.phoneNumbers().messaging().retrieve() | GET /phone_numbers/{id}/messaging |
client.phoneNumbers().messaging().update() | PATCH /phone_numbers/{id}/messaging |
client.phoneNumbers().messaging().list() | GET /phone_numbers/messaging |
client.phoneNumbers().voice().retrieve() | GET /phone_numbers/{id}/voice |
client.phoneNumbers().voice().update() | PATCH /phone_numbers/{id}/voice |
client.phoneNumbers().voice().list() | GET /phone_numbers/voice |
client.phoneNumbers().voicemail().create() | POST /phone_numbers/{phone_number_id}/voicemail |
client.phoneNumbers().voicemail().retrieve() | GET /phone_numbers/{phone_number_id}/voicemail |
client.phoneNumbers().voicemail().update() | PATCH /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().retrieve() | GET /porting/events/{id} |
client.porting().events().list() | GET /porting/events |
client.porting().events().republish() | POST /porting/events/{id}/republish |
client.porting().reports().create() | POST /porting/reports |
client.porting().reports().retrieve() | GET /porting/reports/{id} |
client.porting().reports().list() | GET /porting/reports |
client.porting().loaConfigurations().create() | POST /porting/loa_configurations |
client.porting().loaConfigurations().retrieve() | GET /porting/loa_configurations/{id} |
client.porting().loaConfigurations().update() | PATCH /porting/loa_configurations/{id} |
client.porting().loaConfigurations().list() | GET /porting/loa_configurations |
client.porting().loaConfigurations().delete() | DELETE /porting/loa_configurations/{id} |
client.porting().loaConfigurations().preview() | POST /porting/loa_configurations/preview |
client.porting().loaConfigurations().preview0() | POST /porting/loa_configurations/preview |
client.porting().loaConfigurations().preview1() | GET /porting/loa_configurations/{id}/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().retrieve() | GET /portouts/{id} |
client.portouts().list() | GET /portouts |
client.portouts().listRejectionCodes() | GET /portouts/rejections/{portout_id} |
client.portouts().updateStatus() | PATCH /portouts/{id}/{status} |
client.portouts().events().retrieve() | GET /portouts/events/{id} |
client.portouts().events().list() | GET /portouts/events |
client.portouts().events().republish() | POST /portouts/events/{id}/republish |
client.portouts().reports().create() | POST /portouts/reports |
client.portouts().reports().retrieve() | GET /portouts/reports/{id} |
client.portouts().reports().list() | GET /portouts/reports |
client.portouts().comments().create() | POST /portouts/{id}/comments |
client.portouts().comments().list() | GET /portouts/{id}/comments |
client.portouts().supportingDocuments().create() | POST /portouts/{id}/supporting_documents |
client.portouts().supportingDocuments().list() | GET /portouts/{id}/supporting_documents |
reputation — 3 methods
reputation — 3 methods
| Method | Endpoint |
|---|---|
client.reputation().numbers().retrieve() | GET /reputation/numbers/{phone_number} |
client.reputation().numbers().list() | GET /reputation/numbers |
client.reputation().numbers().delete() | DELETE /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().create() | POST /requirement_groups |
client.requirementGroups().retrieve() | GET /requirement_groups/{id} |
client.requirementGroups().update() | PATCH /requirement_groups/{id} |
client.requirementGroups().list() | GET /requirement_groups |
client.requirementGroups().delete() | DELETE /requirement_groups/{id} |
client.requirementGroups().submitForApproval() | POST /requirement_groups/{id}/submit_for_approval |
client.requirementTypes().retrieve() | GET /requirement_types/{id} |
client.requirementTypes().list() | GET /requirement_types |
client.requirements().retrieve() | GET /requirements/{id} |
client.requirements().list() | GET /requirements |
Verify — 21 methods
Verify — 21 methods
| Method | Endpoint |
|---|---|
client.verifications().retrieve() | GET /verifications/{verification_id} |
client.verifications().triggerCall() | POST /verifications/call |
client.verifications().triggerFlashcall() | POST /verifications/flashcall |
client.verifications().triggerSms() | POST /verifications/sms |
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().create() | POST /verified_numbers |
client.verifiedNumbers().retrieve() | GET /verified_numbers/{phone_number} |
client.verifiedNumbers().list() | GET /verified_numbers |
client.verifiedNumbers().delete() | DELETE /verified_numbers/{phone_number} |
client.verifiedNumbers().actions().submitVerificationCode() | POST /verified_numbers/{phone_number}/actions/verify |
client.verifyProfiles().create() | POST /verify_profiles |
client.verifyProfiles().retrieve() | GET /verify_profiles/{verify_profile_id} |
client.verifyProfiles().update() | PATCH /verify_profiles/{verify_profile_id} |
client.verifyProfiles().list() | GET /verify_profiles |
client.verifyProfiles().delete() | DELETE /verify_profiles/{verify_profile_id} |
client.verifyProfiles().createTemplate() | POST /verify_profiles/templates |
client.verifyProfiles().retrieveTemplates() | GET /verify_profiles/templates |
client.verifyProfiles().updateTemplate() | PATCH /verify_profiles/templates/{template_id} |
Voice Channels — 6 methods
Voice Channels — 6 methods
| Method | Endpoint |
|---|---|
client.channelZones().update() | PUT /channel_zones/{channel_zone_id} |
client.channelZones().list() | GET /channel_zones |
client.inboundChannels().update() | PATCH /inbound_channels |
client.inboundChannels().list() | GET /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().retrieve() | GET /v2/mobile_phone_numbers/{id} |
client.mobilePhoneNumbers().update() | PATCH /v2/mobile_phone_numbers/{id} |
client.mobilePhoneNumbers().list() | GET /v2/mobile_phone_numbers |
client.mobilePhoneNumbers().messaging().retrieve() | GET /mobile_phone_numbers/{id}/messaging |
client.mobilePhoneNumbers().messaging().list() | GET /mobile_phone_numbers/messaging |
mobileVoiceConnections — 5 methods
mobileVoiceConnections — 5 methods
| Method | Endpoint |
|---|---|
client.mobileVoiceConnections().create() | POST /v2/mobile_voice_connections |
client.mobileVoiceConnections().retrieve() | GET /v2/mobile_voice_connections/{id} |
client.mobileVoiceConnections().update() | PATCH /v2/mobile_voice_connections/{id} |
client.mobileVoiceConnections().list() | GET /v2/mobile_voice_connections |
client.mobileVoiceConnections().delete() | DELETE /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().retrieve() | GET /bulk_sim_card_actions/{id} |
client.bulkSimCardActions().list() | GET /bulk_sim_card_actions |
client.otaUpdates().retrieve() | GET /ota_updates/{id} |
client.otaUpdates().list() | GET /ota_updates |
SIM Card Orders — 4 methods
SIM Card Orders — 4 methods
| Method | Endpoint |
|---|---|
client.simCardOrderPreview().preview() | POST /sim_card_order_preview |
client.simCardOrders().create() | POST /sim_card_orders |
client.simCardOrders().retrieve() | GET /sim_card_orders/{id} |
client.simCardOrders().list() | GET /sim_card_orders |
simCardDataUsageNotifications — 5 methods
simCardDataUsageNotifications — 5 methods
| Method | Endpoint |
|---|---|
client.simCardDataUsageNotifications().create() | POST /sim_card_data_usage_notifications |
client.simCardDataUsageNotifications().retrieve() | GET /sim_card_data_usage_notifications/{id} |
client.simCardDataUsageNotifications().update() | PATCH /sim_card_data_usage_notifications/{id} |
client.simCardDataUsageNotifications().list() | GET /sim_card_data_usage_notifications |
client.simCardDataUsageNotifications().delete() | DELETE /sim_card_data_usage_notifications/{id} |
simCardGroups — 11 methods
simCardGroups — 11 methods
| Method | Endpoint |
|---|---|
client.simCardGroups().create() | POST /sim_card_groups |
client.simCardGroups().retrieve() | GET /sim_card_groups/{id} |
client.simCardGroups().update() | PATCH /sim_card_groups/{id} |
client.simCardGroups().list() | GET /sim_card_groups |
client.simCardGroups().delete() | DELETE /sim_card_groups/{id} |
client.simCardGroups().actions().retrieve() | GET /sim_card_group_actions/{id} |
client.simCardGroups().actions().list() | GET /sim_card_group_actions |
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 — 21 methods
simCards — 21 methods
| Method | Endpoint |
|---|---|
client.simCards().retrieve() | GET /sim_cards/{id} |
client.simCards().update() | PATCH /sim_cards/{id} |
client.simCards().list() | GET /sim_cards |
client.simCards().delete() | DELETE /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().retrieve() | GET /sim_card_actions/{id} |
client.simCards().actions().list() | GET /sim_card_actions |
client.simCards().actions().bulkDisableVoice() | POST /sim_cards/actions/bulk_disable_voice |
client.simCards().actions().bulkEnableVoice() | POST /sim_cards/actions/bulk_enable_voice |
client.simCards().actions().bulkSetPublicIps() | POST /sim_cards/actions/bulk_set_public_ips |
client.simCards().actions().disable() | POST /sim_cards/{id}/actions/disable |
client.simCards().actions().disableVoice() | POST /sim_cards/{id}/actions/disable_voice |
client.simCards().actions().enable() | POST /sim_cards/{id}/actions/enable |
client.simCards().actions().enableVoice() | POST /sim_cards/{id}/actions/enable_voice |
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().validateRegistrationCodes() | POST /sim_cards/actions/validate_registration_codes |
Wireless — 5 methods
Wireless — 5 methods
| Method | Endpoint |
|---|---|
client.wireless().retrieveRegions() | GET /wireless/regions |
client.wireless().detailRecordsReports().create() | POST /wireless/detail_records_reports |
client.wireless().detailRecordsReports().retrieve() | GET /wireless/detail_records_reports/{id} |
client.wireless().detailRecordsReports().list() | GET /wireless/detail_records_reports |
client.wireless().detailRecordsReports().delete() | DELETE /wireless/detail_records_reports/{id} |
Wireless Blocklists — 6 methods
Wireless Blocklists — 6 methods
| Method | Endpoint |
|---|---|
client.wirelessBlocklistValues().list() | GET /wireless_blocklist_values |
client.wirelessBlocklists().create() | POST /wireless_blocklists |
client.wirelessBlocklists().retrieve() | GET /wireless_blocklists/{id} |
client.wirelessBlocklists().update() | PATCH /wireless_blocklists/{id} |
client.wirelessBlocklists().list() | GET /wireless_blocklists |
client.wirelessBlocklists().delete() | DELETE /wireless_blocklists/{id} |
Legacy APIs
Legacy — 26 methods
Legacy — 26 methods
| Method | Endpoint |
|---|---|
client.legacy().reporting().batchDetailRecords().messaging().create() | POST /legacy/reporting/batch_detail_records/messaging |
client.legacy().reporting().batchDetailRecords().messaging().retrieve() | GET /legacy/reporting/batch_detail_records/messaging/{id} |
client.legacy().reporting().batchDetailRecords().messaging().list() | GET /legacy/reporting/batch_detail_records/messaging |
client.legacy().reporting().batchDetailRecords().messaging().delete() | DELETE /legacy/reporting/batch_detail_records/messaging/{id} |
client.legacy().reporting().batchDetailRecords().speechToText().create() | POST /legacy/reporting/batch_detail_records/speech_to_text |
client.legacy().reporting().batchDetailRecords().speechToText().retrieve() | GET /legacy/reporting/batch_detail_records/speech_to_text/{id} |
client.legacy().reporting().batchDetailRecords().speechToText().list() | GET /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().voice().create() | POST /legacy/reporting/batch_detail_records/voice |
client.legacy().reporting().batchDetailRecords().voice().retrieve() | GET /legacy/reporting/batch_detail_records/voice/{id} |
client.legacy().reporting().batchDetailRecords().voice().list() | GET /legacy/reporting/batch_detail_records/voice |
client.legacy().reporting().batchDetailRecords().voice().delete() | DELETE /legacy/reporting/batch_detail_records/voice/{id} |
client.legacy().reporting().batchDetailRecords().voice().retrieveFields() | GET /legacy/reporting/batch_detail_records/voice/fields |
client.legacy().reporting().usageReports().retrieveSpeechToText() | GET /legacy/reporting/usage_reports/speech_to_text |
client.legacy().reporting().usageReports().messaging().create() | POST /legacy/reporting/usage_reports/messaging |
client.legacy().reporting().usageReports().messaging().retrieve() | GET /legacy/reporting/usage_reports/messaging/{id} |
client.legacy().reporting().usageReports().messaging().list() | GET /legacy/reporting/usage_reports/messaging |
client.legacy().reporting().usageReports().messaging().delete() | DELETE /legacy/reporting/usage_reports/messaging/{id} |
client.legacy().reporting().usageReports().numberLookup().create() | POST /legacy/reporting/usage_reports/number_lookup |
client.legacy().reporting().usageReports().numberLookup().retrieve() | GET /legacy/reporting/usage_reports/number_lookup/{id} |
client.legacy().reporting().usageReports().numberLookup().list() | GET /legacy/reporting/usage_reports/number_lookup |
client.legacy().reporting().usageReports().numberLookup().delete() | DELETE /legacy/reporting/usage_reports/number_lookup/{id} |
client.legacy().reporting().usageReports().voice().create() | POST /legacy/reporting/usage_reports/voice |
client.legacy().reporting().usageReports().voice().retrieve() | GET /legacy/reporting/usage_reports/voice/{id} |
client.legacy().reporting().usageReports().voice().list() | GET /legacy/reporting/usage_reports/voice |
client.legacy().reporting().usageReports().voice().delete() | DELETE /legacy/reporting/usage_reports/voice/{id} |