API Reference twilio_elixir v#0.1.1

Copy Markdown View Source

Modules

Elixir SDK for the Twilio API.

Service for BulkConsents API operations.

Service for BulkContacts API operations.

Manage Geo Permissions for each country.

Service for Number API operations.

Twilio accounts (aka Project) or subaccounts

Phone numbers dependent on an Address resource

Authorized Twilio Connect apps

Available machine-to-machine phone numbers

Available toll free phone numbers

Country codes with available phone numbers

API and webhook requests and responses. Contains parameters and TwiML for application control.

Error notifications for calls

Twilio enabled secure payments solution for accepting credit and ACH payments over the phone.

A Recording resource represents the recording associated with a voice call, conference, or SIP Trunk.

Start and stop forked media streaming using the SIPREC protocol.

The Stream resource allows you to create and stop uni-directional Media Streams

Service for Transcription API operations.

Allows your server-side application to send messages to the Voice SDK end user during an active Call.

Subscription for server-side application access to messages sent from the Voice SDK for an active Call.

A Call is an object that represents a connection between a telephone and Twilio.

Voice call conferences

Service for AssignedAddOn API operations.

Incoming local phone numbers on a Twilio account/project

Incoming mobile phone numbers on a Twilio account/project

Incoming toll free phone numbers on a Twilio account/project

Incoming phone numbers on a Twilio account/project

A Message resource represents an inbound or outbound message.

[DEPRECATED] Log entries

Calls in a call queue

The Payload Data subresource hosts the actual data returned by the Add-on

The results of an Add-on API call

References to text transcriptions of call recordings

Recordings of phone calls

Username and password information for SIP Domains

Credential lists associated with a SIP Domain

Access control lists associated with a SIP Domain

Custom DNS hostnames that can accept SIP traffic

IP addresses that have access to a SIP Domain

Access control lists of IP address resources

Create a new signing key

Credentials for ICE servers

Text transcriptions of call recordings

Usage records summarized by day

Usage records for last month

Usage records summarized by month

Usage records for this month

Usage records summarized by year

Twilio account usage records

Webhooks that notify you of usage thresholds

Service for Feedback API operations.

Service for Knowledge API operations.

Service for Message API operations.

Service for Tool API operations.

Service for Assistant API operations.

Service for Chunk API operations.

Service for Status API operations.

Service for Message API operations.

Service for Configuration API operations.

Service for Day API operations.

Service for Job API operations.

Service for Export API operations.

Credentials for push notifications channels

Pending invitations to users to become channel members

Users joined to specific channels

Channels represent chat rooms

Roles determining user or member permissions

Service for Channel API operations.

Unique chat users within a chat service

Top level scope for all chat resources

Credentials for push notifications channels

Push notification subscription for users

Pending invitations to users to become channel members

Users joined to specific channels

Webhooks for specific channels

Channels represent chat rooms

Roles determining user or member permissions

List of bindings for a given user

List of channels for a given user

Unique chat users within a chat service

Top level scope for all chat resources

A Channel resource represents a chat/conversation channel with an ordered list of messages and a participant roster.

Twilio API client. Holds credentials and executes requests.

Configuration management for the Twilio SDK.

Service for Whatsapp API operations.

An Approval Fetch resource represents the approval status of a Content resource.

A Content resource represents rich messaging content and its respective approval request status.

A Content resource represents rich messaging content.

A Legacy Content resource represents legacy rich messaging content.

A Content resource represents rich messaging content and its respective approval request status.

A Content resource represents rich messaging content.

Address Configuration resource manages the configurations related to a unique address within Conversations

The Configuration resource manages a set of account-level settings applicable to the Conversations API.

A Message Receipt resource represents a delivery/read receipt of a message in a conversation.

A Message resource represents a message in a conversation.

A Participant resource represents a member of the conversation.

A Credential resource represents a push notification credential.

A Role resource represents a set of permissions granted to a user within a service or a conversation.

A Service Notification resource manages a set of settings to determine push notification behavior at service level.

A Service Configuration resource manages service-level settings applicable to the Conversation API.

A Service Message Receipt resource represents a delivery/read receipt of a message in a conversation.

A Service Message resource represents a message in a conversation within a specific service.

A Service Participant resource represents a member of the conversation within a specific service.

A Service Role resource represents a set of permissions granted to a user within a service or a conversation.

A Service User resource represents a conversation user belonging to a specific conversation service.

A Service resource is a top-level conversation resource container that serves as a data silo.

A User Conversation resource represents a conversation of the user belonging to a default conversation service.

A User resource represents a conversation user belonging to a default conversation service.

Twilio API error.

Versioned Schema definitions for Event Types

Sink destination to send events to

Event subscribed to in the parent Subscription

Subscription to send Event Types to a Sink

Event Types available

Status for email provisioning

Flex chat channels

Configuration for a Flex instance

Service for InsightsConversations API operations.

Service for InsightsSegments API operations.

Service for InsightsUserRoles API operations.

Service for Assessments API operations.

Service for Category API operations.

Service for InsightsQuestionnaires API operations.

Service for Question API operations.

Service for InsightsSettingsAnswerSets API operations.

Service for Session API operations.

Service for InteractionChannelInvite API operations.

Service for InteractionChannelParticipant API operations.

Service for InteractionTransfer API operations.

Service for InteractionChannel API operations.

Service for Interaction API operations.

Service for Archive API operations.

Service for ConfiguredPlugin API operations.

Service for Configuration API operations.

Service for Archive API operations.

Service for PluginVersions API operations.

Service for Plugin API operations.

Service for Release API operations.

Service for WebChannel API operations.

Service for User API operations.

Service for WebChannels API operations.

A User resource represents a frontline user.

Service for Authorize API operations.

Service for Token API operations.

Service for Token API operations.

Service for Participant API operations.

Service for Conference API operations.

Service for Participant API operations.

Service for Room API operations.

Service for Annotation API operations.

Service for CallSummaries API operations.

Service for CallSummary API operations.

Service for Event API operations.

Service for Metric API operations.

Service for Setting API operations.

Service for Voice API operations.

Service for Custom API operations.

Service for PreBuilt API operations.

Service for Operator API operations.

Service for OperatorType API operations.

Service for OperatorAttachments API operations.

Service for Operator API operations.

Service for Service API operations.

Service for Media API operations.

Service for OperatorResult API operations.

Service for Sentence API operations.

Service for Transcript API operations.

Service for Credential API operations.

Service for Invite API operations.

Service for Member API operations.

Service for Message API operations.

Service for Channel API operations.

Service for Role API operations.

Service for Channel API operations.

Service for User API operations.

Service for Service API operations.

Service for Credential API operations.

Service for Binding API operations.

Service for Invite API operations.

Service for Member API operations.

Service for Message API operations.

Service for Webhook API operations.

Service for Channel API operations.

Service for Role API operations.

Service for Binding API operations.

Service for Channel API operations.

Service for User API operations.

Service for Service API operations.

Service for Chunk API operations.

Service for Status API operations.

Detailed information on phone numbers

Query information on a phone number so that you can make a trusted interaction with your user

Service for AvailableAddOnExtension API operations.

Service for AvailableAddOn API operations.

Service for InstalledAddOnExtension API operations.

Service for InstalledAddOnUsage API operations.

Service for InstalledAddOn API operations.

Service for Listing API operations.

Service for ReferralConversion API operations.

A Messaging Service resource to retry OTP verification for Sole Proprietor Brand Registrations.

A Messaging Service resource to add and get Brand Vettings.

A Messaging Service resource to add and fetch Brand Registrations.

Service for Config API operations.

Service for DomainCerts API operations.

Service for MessagingService API operations.

Service for RequestManagedCert API operations.

Service for ValidateDn API operations.

A Messaging Service resource to add, fetch or remove an Alpha Sender ID from a Messaging Service.

A Messaging Service resource to read, fetch all Channel Senders associated with a Messaging Service.

A service for (fetch/create/delete) A2P Campaign for a Messaging Service

A Messaging Service resource to add, fetch or remove phone numbers from a Messaging Service.

Resource to associate preregistered campaign with Messaging Service.

A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service.

Use Case resource. Fetch possible use cases for a Messaging Service.

A Messaging Service resource to create, fetch, update, delete or add/remove senders from Messaging Services.

A Messaging resource to create and retrieve Tollfree Verifications.

The Senders resource represents a messaging channel sender (WhatsApp, RCS).

Send a typing indicator event between OTT senders (e.g., WhatsApp, RCS).

Service for DomainCerts API operations.

Service for Credential API operations.

Service for Binding API operations.

Service for Notification API operations.

Service for Service API operations.

Service for Eligibility API operations.

Service for Webhook API operations.

Service for PhoneNumber API operations.

Service for PortInRequest API operations.

Service for PortIn API operations.

Service for PhoneNumber API operations.

Service for Configuration API operations.

Service for AuthorizationDocument API operations.

Service for Bulk API operations.

Service for Order API operations.

Service for ItemAssignment API operations.

Service for Bundle API operations.

Service for EndUser API operations.

Service for EndUserType API operations.

Service for Regulation API operations.

Service for SupportingDocument API operations.

Service for SupportingDocumentType API operations.

Service for Authorize API operations.

Service for Token API operations.

Service for Authorize API operations.

Service for Token API operations.

Paginated result from a Twilio list endpoint.

Service for DependentHostedNumberOrder API operations.

Service for AuthorizationDocument API operations.

Service for HostedNumberOrder API operations.

Service for AvailableAddOnExtension API operations.

Service for AvailableAddOn API operations.

Service for InstalledAddOnExtension API operations.

Service for InstalledAddOn API operations.

Service for Command API operations.

Service for RatePlan API operations.

Service for Usage API operations.

Service for Sim API operations.

Messaging pricing by country

Phone number pricing by country

Voice pricing by country

Voice pricing for a specific phone number

Trunking pricing by country

Trunking pricing for a specific phone number

Voice pricing by country

Voice pricing for a specific phone number

Service for PhoneNumber API operations.

Service for Interaction API operations.

Service for MessageInteraction API operations.

Service for Participant API operations.

Service for Session API operations.

Service for Service API operations.

Manage Geo Permissions for each country.

Twilio accounts (aka Project) or subaccounts

Phone numbers dependent on an Address resource

Authorized Twilio Connect apps

Available machine-to-machine phone numbers

Country codes with available phone numbers

A Call is an object that represents a connection between a telephone and Twilio.

API and webhook requests and responses. Contains parameters and TwiML for application control.

Error notifications for calls

Twilio enabled secure payments solution for accepting credit and ACH payments over the phone.

A Recording resource represents the recording associated with a voice call, conference, or SIP Trunk.

Start and stop forked media streaming using the SIPREC protocol.

The Stream resource allows you to create and stop uni-directional Media Streams

Allows your server-side application to send messages to the Voice SDK end user during an active Call.

Subscription for server-side application access to messages sent from the Voice SDK for an active Call.

Voice call conferences

Incoming phone numbers on a Twilio account/project

Incoming local phone numbers on a Twilio account/project

Incoming mobile phone numbers on a Twilio account/project

Incoming toll free phone numbers on a Twilio account/project

A Message resource represents an inbound or outbound message.

[DEPRECATED] Log entries

Recordings of phone calls

The results of an Add-on API call

References to text transcriptions of call recordings

Username and password information for SIP Domains

Custom DNS hostnames that can accept SIP traffic

Credential lists associated with a SIP Domain

Access control lists associated with a SIP Domain

Access control lists of IP address resources

IP addresses that have access to a SIP Domain

Create a new signing key

Credentials for ICE servers

Text transcriptions of call recordings

Twilio account usage records

Usage records summarized by day

Usage records summarized by month

Usage records summarized by year

Webhooks that notify you of usage thresholds

Credentials for push notifications channels

Top level scope for all chat resources

Channels represent chat rooms

Pending invitations to users to become channel members

Users joined to specific channels

Roles determining user or member permissions

Unique chat users within a chat service

Credentials for push notifications channels

Top level scope for all chat resources

Push notification subscription for users

Channels represent chat rooms

Pending invitations to users to become channel members

Users joined to specific channels

Webhooks for specific channels

Roles determining user or member permissions

Unique chat users within a chat service

List of bindings for a given user

List of channels for a given user

A Channel resource represents a chat/conversation channel with an ordered list of messages and a participant roster.

A Content resource represents rich messaging content.

An Approval Fetch resource represents the approval status of a Content resource.

A Content resource represents rich messaging content and its respective approval request status.

A Legacy Content resource represents legacy rich messaging content.

A Content resource represents rich messaging content.

A Content resource represents rich messaging content and its respective approval request status.

The Configuration resource manages a set of account-level settings applicable to the Conversations API.

Address Configuration resource manages the configurations related to a unique address within Conversations

A Message resource represents a message in a conversation.

A Message Receipt resource represents a delivery/read receipt of a message in a conversation.

A Participant resource represents a member of the conversation.

A Credential resource represents a push notification credential.

A Role resource represents a set of permissions granted to a user within a service or a conversation.

A Service resource is a top-level conversation resource container that serves as a data silo.

A Service Configuration resource manages service-level settings applicable to the Conversation API.

A Service Notification resource manages a set of settings to determine push notification behavior at service level.

A Service Message resource represents a message in a conversation within a specific service.

A Service Message Receipt resource represents a delivery/read receipt of a message in a conversation.

A Service Participant resource represents a member of the conversation within a specific service.

A Service Role resource represents a set of permissions granted to a user within a service or a conversation.

A Service User resource represents a conversation user belonging to a specific conversation service.

A User resource represents a conversation user belonging to a default conversation service.

A User Conversation resource represents a conversation of the user belonging to a default conversation service.

Versioned Schema definitions for Event Types

Sink destination to send events to

Subscription to send Event Types to a Sink

Event subscribed to in the parent Subscription

Event Types available

Configuration for a Flex instance

Interaction resource.

WebChannels resource.

A User resource represents a frontline user.

Detailed information on phone numbers

Query information on a phone number so that you can make a trusted interaction with your user

A Messaging Service resource to add and fetch Brand Registrations.

A Messaging Service resource to retry OTP verification for Sole Proprietor Brand Registrations.

A Messaging Service resource to add and get Brand Vettings.

A Messaging Service resource to create, fetch, update, delete or add/remove senders from Messaging Services.

A Messaging Service resource to add, fetch or remove an Alpha Sender ID from a Messaging Service.

A Messaging Service resource to read, fetch all Channel Senders associated with a Messaging Service.

A service for (fetch/create/delete) A2P Campaign for a Messaging Service

A Messaging Service resource to add, fetch or remove phone numbers from a Messaging Service.

Resource to associate preregistered campaign with Messaging Service.

A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service.

Use Case resource. Fetch possible use cases for a Messaging Service.

A Messaging resource to create and retrieve Tollfree Verifications.

The Senders resource represents a messaging channel sender (WhatsApp, RCS).

Messaging pricing by country

Phone number pricing by country

Voice pricing for a specific phone number

Trunking pricing by country

Trunking pricing for a specific phone number

Voice pricing for a specific phone number

The top-level resource for a Serverless application, which serves as a container for the application environments.

A wrapper that represents a static file and groups the different Versions of the static file.

A collection of Function Versions, Asset Versions, Dependencies, and a Runtime that form a deployable unit.

The status of a Build resource.

Represents a deployed build of a given set of Functions and/or Assets at a specific URL.

An association of a Build with an Environment so that the Build is published in the Environment.

A record of an event that occurred related to a function invocation.

A key and value pair that is specific to an Environment.

[DEPRECATED] Excecutions of Studio flows

[DEPRECATED] JSON context for engagements

Executions of Studio flows

Individual steps within an execution

JSON context for an individual step within an execution

Executions of Studio flows

Individual steps within an execution

JSON context for an individual step within an execution

Flow definition validator

eSIM Profiles that can be loaded onto consumer eUICC SIMs

Configure shared settings inherited by all Super SIMs assigned to the Fleet

Machine-to-machine IP Commands sent to/from Super SIMs

Mobile operator networks to which Super SIMs can connect

NetworkAccessProfile resource.

Mobile operator networks which Network Access Profiles allow access to

Individual IoT Super SIMs

Billing Period for an IoT Super SIM

IP Addresses for a Super SIM configured to use a VPN connection

Machine-to-machine SMS Commands sent to/from SIMs

Usage information for Sim resources

Containers for sync objects

Permissions for Sync list items

Current and past reservations for a worker

Represents a SIP trunk

List of credentials for accessing a trunk

List of IP addresses for accessing a trunk

Network element entry points into your communications infrastructure

Phone numbers associated with trunks

Recording settings for a trunk

SupportingDocumentType resource.

Recording compositions

Recording composition hooks

Single-track, single-media recordings

Video rooms with one or more participants

Participants in video rooms

Single-track, single-media room recordings

transcriptions in video rooms

Connection Policy for sending traffic to your communications infrastructure.

Network element entry points into your communications infrastructure

Machine-to-machine commands sent to/from devices

Capabilities and restrictions for SIMs

A resource representing a Programmable Wireless SIM

Data session information for SIMs

Aggregated Usage information for all SIMs on an Account

Service for PhoneNumber API operations.

Service for SipDomain API operations.

Service for Trunk API operations.

A wrapper that represents a static file and groups the different Versions of the static file.

The status of a Build resource.

A collection of Function Versions, Asset Versions, Dependencies, and a Runtime that form a deployable unit.

An association of a Build with an Environment so that the Build is published in the Environment.

A record of an event that occurred related to a function invocation.

A key and value pair that is specific to an Environment.

Represents a deployed build of a given set of Functions and/or Assets at a specific URL.

The top-level resource for a Serverless application, which serves as a container for the application environments.

[DEPRECATED] JSON context for engagements

JSON context for individual steps

[DEPRECATED] Excecutions of Studio flows

Individual steps within an execution

JSON context for an individual step within an execution

Executions of Studio flows

Individual steps within an execution

JSON context for an individual step within an execution

Executions of Studio flows

Flow definition validator

eSIM Profiles that can be loaded onto consumer eUICC SIMs

Configure shared settings inherited by all Super SIMs assigned to the Fleet

Machine-to-machine IP Commands sent to/from Super SIMs

Mobile operator networks which Network Access Profiles allow access to

Service for NetworkAccessProfile API operations.

Mobile operator networks to which Super SIMs can connect

Service for SettingsUpdate API operations.

Billing Period for an IoT Super SIM

IP Addresses for a Super SIM configured to use a VPN connection

Individual IoT Super SIMs

Machine-to-machine SMS Commands sent to/from SIMs

Usage information for Sim resources

Permissions for Sync list items

Service for Permission API operations.

Service for Message API operations.

Service for Stream API operations.

Containers for sync objects

Service for Activity API operations.

Service for Event API operations.

Service for TaskQueueBulkRealTimeStatistics API operations.

Service for TaskQueueCumulativeStatistics API operations.

Service for TaskQueueRealTimeStatistics API operations.

Service for TaskQueueStatistics API operations.

Service for TaskQueuesStatistics API operations.

Service for TaskQueue API operations.

Service for Task API operations.

Service for Channel API operations.

Current and past reservations for a worker

Service for WorkerStatistics API operations.

Service for Worker API operations.

Service for WorkflowCumulativeStatistics API operations.

Service for WorkflowRealTimeStatistics API operations.

Service for WorkflowStatistics API operations.

Service for Workflow API operations.

Service for WorkspaceCumulativeStatistics API operations.

Service for WorkspaceRealTimeStatistics API operations.

Service for WorkspaceStatistics API operations.

Service for Workspace API operations.

Telemetry event definitions for the Twilio SDK.

Test helpers for stubbing Twilio HTTP requests.

List of credentials for accessing a trunk

List of IP addresses for accessing a trunk

Network element entry points into your communications infrastructure

Phone numbers associated with trunks

Recording settings for a trunk

Represents a SIP trunk

Service for ComplianceInquiries API operations.

Service for ComplianceTollfreeInquiries API operations.

Service for ChannelEndpointAssignment API operations.

Service for CustomerProfilesEntityAssignments API operations.

Service for CustomerProfilesEvaluations API operations.

Service for CustomerProfiles API operations.

Service for EndUser API operations.

Service for EndUserType API operations.

Service for Policies API operations.

Service for SupportingDocument API operations.

Service for SupportingDocumentType API operations.

Service for ChannelEndpointAssignment API operations.

Service for TrustProductsEntityAssignments API operations.

Service for TrustProductsEvaluations API operations.

Service for TrustProducts API operations.

Base module for TwiML XML generation.

TwiML for messaging webhooks.

TwiML for voice calls.

Service for Attempt API operations.

Service for Form API operations.

Service for Number API operations.

Service for AccessToken API operations.

Service for Notification API operations.

Service for Challenge API operations.

Service for Factor API operations.

Service for Entity API operations.

Service for MessagingConfiguration API operations.

Service for ApproveChallenge API operations.

Service for Challenge API operations.

Service for Factor API operations.

Service for VerifyFactor API operations.

Service for Bucket API operations.

Service for RateLimit API operations.

Service for VerificationCheck API operations.

Service for Verification API operations.

Service for Webhook API operations.

Service for Service API operations.

Service for Template API operations.

Recording composition hooks

Recording compositions

Single-track, single-media recordings

Service for Anonymize API operations.

Service for PublishedTrack API operations.

Service for SubscribeRules API operations.

Service for SubscribedTrack API operations.

Participants in video rooms

Service for RecordingRules API operations.

Single-track, single-media room recordings

transcriptions in video rooms

Video rooms with one or more participants

Service for Call API operations.

Network element entry points into your communications infrastructure

Connection Policy for sending traffic to your communications infrastructure.

Service for BulkCountryUpdate API operations.

Service for HighRiskSpecialPrefixe API operations.

Service for Country API operations.

Service for Settings API operations.

Webhook request validation.

Machine-to-machine commands sent to/from devices

Capabilities and restrictions for SIMs

Data session information for SIMs

Usage information for SIMs

A resource representing a Programmable Wireless SIM

Aggregated Usage information for all SIMs on an Account

Mix Tasks

Generate Twilio SDK modules from OpenAPI specs.