API Reference twilio v#0.2.0

Copy Markdown

Modules

Elixir SDK for Twilio - Api (API version 1.0.0).

Access tokens for Twilio's client SDKs: the Voice SDK in a browser or app, Video, Conversations (Chat), Sync.

API calls: create, list, retrieve, update.

API calls: create, delete, list, retrieve, update.

API calls: create, delete, list, retrieve, update.

API calls: list, retrieve.

API calls: list, retrieve.

API calls: retrieve.

API calls: create, delete, list, retrieve, update.

API calls: list.

API calls: list, retrieve.

API calls: create, update.

API calls: create, delete, list, retrieve, update.

API calls: create, update.

API calls: create, update.

API calls: create, update.

API calls: list, retrieve, update.

API calls: create, delete, list, retrieve, update.

API calls: delete, list, retrieve, update.

API calls: delete, list, retrieve, update.

API calls: create, delete, list, retrieve, update.

API calls: create, delete, list, retrieve.

API calls: create, list.

API calls: create, list.

API calls: create, list.

API calls: create, delete, list, retrieve, update.

API calls: create, delete, feedback, list, retrieve, update.

API calls: delete, list, retrieve.

API calls: list, retrieve.

API calls: create, delete, list, retrieve, update.

API calls: create, delete, list, retrieve, update.

API calls: list, retrieve, update.

API calls: delete, list, retrieve.

API calls: delete, list, retrieve.

API calls: delete, list, retrieve.

API calls: delete, list, retrieve.

The status of this account. Usually active, but can be suspended or closed.

The type of this account. Either Trial or Full if it's been upgraded

The set of permissions that you authorized for the Connect App. Can be: get-all or post-all.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: Voice, SMS, and MMS and each capability can be: true or false.

The status of this call. Can be: queued, ringing, in-progress, canceled, completed, failed, busy or no-answer. See Call Status Values below for more information.

How the recording was created. Can be: DialVerb, Conference, OutboundAPI, Trunking, RecordVerb, StartCallRecordingAPI, and StartConferenceRecordingAPI.

The status of the recording. Can be: processing, completed and absent. For more detailed statuses on in-progress recordings, check out how to Update a Recording Resource.

The reason why a conference ended. When a conference is in progress, will be null. When conference is completed, can be: conference-ended-via-api, participant-with-end-conference-on-exit-left, participant-with-end-conference-on-exit-kicked, last-participant-kicked, or last-participant-left.

The status of this conference. Can be: init, in-progress, or completed.

How the recording was created. Can be: DialVerb, Conference, OutboundAPI, Trunking, RecordVerb, StartCallRecordingAPI, StartConferenceRecordingAPI.

The status of the recording. Can be: processing, completed and absent. For more detailed statuses on in-progress recordings, check out how to Update a Recording Resource.

The set of permissions that your ConnectApp requests.

Whether the phone number requires an Address registered with Twilio. Can be: none, any, local, or foreign.

Whether the phone number is enabled for emergency calling.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are Voice, SMS, and MMS and each capability can be: true or false.

Whether the phone number requires an Address registered with Twilio. Can be: none, any, local, or foreign.

The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number.

The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are Voice, SMS, and MMS and each capability can be: true or false.

Whether the phone number requires an Address registered with Twilio. Can be: none, any, local, or foreign.

The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number.

The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are Voice, SMS, and MMS and each capability can be: true or false.

Whether the phone number requires an Address registered with Twilio. Can be: none, any, local, or foreign.

The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number.

The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are Voice, SMS, and MMS and each capability can be: true or false.

Whether the phone number requires an Address registered with Twilio. Can be: none, any, local, or foreign.

The status of address registration with emergency services. A registered emergency address will be used during handling of emergency calls from this number.

The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country.

Determines if the address can be stored or obfuscated based on privacy settings

Determines if the message content can be stored or redacted based on privacy settings

The direction of the message. Can be: inbound for incoming messages, outbound-api for messages created by the REST API, outbound-call for messages created during a call, or outbound-reply for messages created in response to an incoming message.

Include this parameter with a value of disable to skip any kind of risk check on the respective message request.

For Messaging Services only: Include this parameter with a value of fixed in conjuction with the send_time parameter in order to schedule a Message.

The status of the Message. Possible values: accepted, scheduled, canceled, queued, sending, sent, failed, delivered, undelivered, receiving, received, or read (WhatsApp only). For more information, See detailed descriptions.

Reported outcome indicating whether there is confirmation that the Message recipient performed a tracked user action. Can be: unconfirmed or confirmed. For more details see How to Optimize Message Deliverability with Message Feedback.

The status of the participant's call in a session. Can be: queued, connecting, ringing, connected, complete, or failed.

Type of bank account if payment source is ACH. One of consumer-checking, consumer-savings, or commercial-checking. The default value is consumer-checking.

The piece of payment information that you wish the caller to enter. Must be one of payment-card-number, expiration-date, security-code, postal-code, bank-routing-number, bank-account-number, or their -matcher variants for input confirmation when RequireMatchingInputs is enabled.

Type of payment being captured. One of credit-card or ach-debit. The default value is credit-card.

Indicates whether the current payment session should be cancelled or completed. When cancel the payment session is cancelled. When complete, Twilio sends the payment information to the selected Pay Connector for processing.

Indicates whether the payment method should be tokenized as a one-time, reusable, or payment-method token. The default value is reusable. Do not enter a charge amount when tokenizing. If a charge amount is entered, the payment method will be charged and not tokenized.

The status - one of stopped, in-flight

One of inbound_track, outbound_track, both_tracks.

The status of the result. Can be: canceled, completed, deleted, failed, in-progress, init, processing, queued.

How the recording was created. Can be: DialVerb, Conference, OutboundAPI, Trunking, RecordVerb, StartCallRecordingAPI, and StartConferenceRecordingAPI.

The status of the recording. Can be: processing, completed, absent or deleted. For information about more detailed statuses on in-progress recordings, check out how to Update a Recording Resource.

The status of the transcription. Can be: in-progress, completed, failed.

The status - one of stopped, in-progress

One of inbound_track, outbound_track, both_tracks.

The status of the Stream. Possible values are stopped and in-progress.

The tracks to be included in the Stream. Possible values are inbound_track, outbound_track, both_tracks. Default value is inbound_track.

The status of the transcription. Can be: in-progress, completed, failed.

The frequency of a recurring UsageTrigger. Can be: daily, monthly, or yearly for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT.

The field in the UsageRecord resource that fires the trigger. Can be: count, usage, or price, as described in the UsageRecords documentation.

API calls: create, delete, list, retrieve, update.

API calls: create, delete, list, retrieve, update.

API calls: create, delete, list, retrieve, update.

API calls: create, delete, list, retrieve, update.

API calls: create, delete, list, retrieve.

API calls: create, delete, list, retrieve.

API calls: create, delete, list, retrieve.

API calls: create, delete, list, retrieve.

API calls: create, delete, list, retrieve.

API calls: create, delete, list, retrieve, update.

API calls: create, delete, list, retrieve, update.

API calls: list, retrieve, update.

API calls: create.

API calls: delete, list, retrieve.

API calls: list.

API calls: list.

API calls: list.

API calls: list.

API calls: list.

API calls: list.

API calls: create, delete, list, retrieve, update.

Checks that a webhook request really comes from Twilio.