Twilio. Applications
(twilio v0.2.0)
Copy Markdown
API calls: create, delete, list, retrieve, update.
Summary
Functions
Create a new application within your account
Like create/2, but returns the result or raises Infusion.Runtime.Error.
Delete the application by the specified application sid
Like delete/2, but returns the result or raises Infusion.Runtime.Error.
Retrieve a list of applications representing an application within the requesting account
Like list/2, but returns the result or raises Infusion.Runtime.Error.
Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.Application.t() that fetches pages as it is read.
Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.
Fetch the application specified by the provided sid
Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.
Updates the application's properties
Like update/3, but returns the result or raises Infusion.Runtime.Error.
Functions
@spec create(map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.Application.t()} | {:error, Infusion.Runtime.Error.t()}
Create a new application within your account
POST /2010-04-01/Accounts/{AccountSid}/Applications.json
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
api_version- The API version to use to start a new TwiML session. Can be:2010-04-01or2008-08-01. The default value is the account's default API version.friendly_name- A descriptive string that you create to describe the new application. It can be up to 64 characters long.message_status_callback- The URL we should call using a POST method to send message status information to your application.public_application_connect_enabled- Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be:trueorfalse.sms_fallback_method- The HTTP method we should use to callsms_fallback_url. Can be:GETorPOST.sms_fallback_url- The URL that we should call when an error occurs while retrieving or executing the TwiML fromsms_url.sms_method- The HTTP method we should use to callsms_url. Can be:GETorPOST.sms_status_callback- The URL we should call using a POST method to send status information about SMS messages sent by the application.sms_url- The URL we should call when the phone number receives an incoming SMS message.status_callback- The URL we should call using thestatus_callback_methodto send status information to your application.status_callback_method- The HTTP method we should use to callstatus_callback. Can be:GETorPOST.voice_caller_id_lookup- Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be:trueorfalse.voice_fallback_method- The HTTP method we should use to callvoice_fallback_url. Can be:GETorPOST.voice_fallback_url- The URL that we should call when an error occurs retrieving or executing the TwiML requested byurl.voice_method- The HTTP method we should use to callvoice_url. Can be:GETorPOST.voice_url- The URL we should call when the phone number assigned to this application receives a call.
@spec create!(map() | keyword(), keyword()) :: Twilio.Schemas.Application.t()
Like create/2, but returns the result or raises Infusion.Runtime.Error.
@spec delete(String.t(), keyword()) :: {:ok, nil} | {:error, Infusion.Runtime.Error.t()}
Delete the application by the specified application sid
DELETE /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the Application resource to delete.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Like delete/2, but returns the result or raises Infusion.Runtime.Error.
@spec list(map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.ApplicationsListResponse.t()} | {:error, Infusion.Runtime.Error.t()}
Retrieve a list of applications representing an application within the requesting account
GET /2010-04-01/Accounts/{AccountSid}/Applications.json
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
friendly_name- The string that identifies the Application resources to read.page_size- How many resources to return in each list page. The default is 50, and the maximum is 1000.page- The page index. This value is simply for client state.page_token- The page token. This is provided by the API.
To read every item across all pages, use list_all.
@spec list!(map() | keyword(), keyword()) :: Twilio.Schemas.ApplicationsListResponse.t()
Like list/2, but returns the result or raises Infusion.Runtime.Error.
@spec list_all(map() | keyword(), keyword()) :: {:ok, Enumerable.t()} | {:error, Infusion.Runtime.Error.t()}
Like list/2, but returns every item, from every page: a lazy stream of Twilio.Schemas.Application.t() that fetches pages as it is read.
The first page is fetched right away, so its errors are returned; a later page that fails raises Infusion.Runtime.Error. Stopping early (Enum.take/2) fetches no more pages.
@spec list_all!(map() | keyword(), keyword()) :: Enumerable.t()
Like list_all/2, but returns the stream or raises Infusion.Runtime.Error.
@spec retrieve(String.t(), keyword()) :: {:ok, Twilio.Schemas.Application.t()} | {:error, Infusion.Runtime.Error.t()}
Fetch the application specified by the provided sid
GET /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the Application resource to fetch.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
@spec retrieve!(String.t(), keyword()) :: Twilio.Schemas.Application.t()
Like retrieve/2, but returns the result or raises Infusion.Runtime.Error.
@spec update(String.t(), map() | keyword(), keyword()) :: {:ok, Twilio.Schemas.Application.t()} | {:error, Infusion.Runtime.Error.t()}
Updates the application's properties
POST /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json
Path parameters
sid(required) - The Twilio-provided string that uniquely identifies the Application resource to update.
{AccountSid} in the path is the :account_sid setting; pass account_sid: "..." as an option to use another.
Parameters
api_version- The API version to use to start a new TwiML session. Can be:2010-04-01or2008-08-01. The default value is your account's default API version.friendly_name- A descriptive string that you create to describe the resource. It can be up to 64 characters long.message_status_callback- The URL we should call using a POST method to send message status information to your application.public_application_connect_enabled- Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be:trueorfalse.sms_fallback_method- The HTTP method we should use to callsms_fallback_url. Can be:GETorPOST.sms_fallback_url- The URL that we should call when an error occurs while retrieving or executing the TwiML fromsms_url.sms_method- The HTTP method we should use to callsms_url. Can be:GETorPOST.sms_status_callback- Same as message_status_callback: The URL we should call using a POST method to send status information about SMS messages sent by the application. Deprecated, included for backwards compatibility.sms_url- The URL we should call when the phone number receives an incoming SMS message.status_callback- The URL we should call using thestatus_callback_methodto send status information to your application.status_callback_method- The HTTP method we should use to callstatus_callback. Can be:GETorPOST.voice_caller_id_lookup- Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be:trueorfalse.voice_fallback_method- The HTTP method we should use to callvoice_fallback_url. Can be:GETorPOST.voice_fallback_url- The URL that we should call when an error occurs retrieving or executing the TwiML requested byurl.voice_method- The HTTP method we should use to callvoice_url. Can be:GETorPOST.voice_url- The URL we should call when the phone number assigned to this application receives a call.
@spec update!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.Application.t()
Like update/3, but returns the result or raises Infusion.Runtime.Error.