# `Twilio.Applications` API calls: `create`, `delete`, `list`, `retrieve`, `update`. # `create` ```elixir @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-01` or `2008-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: `true` or `false`. * `sms_fallback_method` - The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`. * `sms_fallback_url` - The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`. * `sms_method` - The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`. * `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 the `status_callback_method` to send status information to your application. * `status_callback_method` - The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`. * `voice_caller_id_lookup` - Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`. * `voice_fallback_method` - The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`. * `voice_fallback_url` - The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. * `voice_method` - The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`. * `voice_url` - The URL we should call when the phone number assigned to this application receives a call. # `create!` ```elixir @spec create!(map() | keyword(), keyword()) :: Twilio.Schemas.Application.t() ``` Like `create/2`, but returns the result or raises `Infusion.Runtime.Error`. # `delete` ```elixir @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. # `delete!` ```elixir @spec delete!(String.t(), keyword()) :: nil ``` Like `delete/2`, but returns the result or raises `Infusion.Runtime.Error`. # `list` ```elixir @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`. # `list!` ```elixir @spec list!(map() | keyword(), keyword()) :: Twilio.Schemas.ApplicationsListResponse.t() ``` Like `list/2`, but returns the result or raises `Infusion.Runtime.Error`. # `list_all` ```elixir @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. # `list_all!` ```elixir @spec list_all!(map() | keyword(), keyword()) :: Enumerable.t() ``` Like `list_all/2`, but returns the stream or raises `Infusion.Runtime.Error`. # `retrieve` ```elixir @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. # `retrieve!` ```elixir @spec retrieve!(String.t(), keyword()) :: Twilio.Schemas.Application.t() ``` Like `retrieve/2`, but returns the result or raises `Infusion.Runtime.Error`. # `update` ```elixir @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-01` or `2008-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: `true` or `false`. * `sms_fallback_method` - The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`. * `sms_fallback_url` - The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`. * `sms_method` - The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`. * `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 the `status_callback_method` to send status information to your application. * `status_callback_method` - The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`. * `voice_caller_id_lookup` - Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`. * `voice_fallback_method` - The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`. * `voice_fallback_url` - The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. * `voice_method` - The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`. * `voice_url` - The URL we should call when the phone number assigned to this application receives a call. # `update!` ```elixir @spec update!(String.t(), map() | keyword(), keyword()) :: Twilio.Schemas.Application.t() ``` Like `update/3`, but returns the result or raises `Infusion.Runtime.Error`. --- *Consult [api-reference.md](api-reference.md) for complete listing*