Twilio.Api.V2010.ApplicationService (twilio_elixir v0.1.1)

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

An Application instance resource represents an application that you have created with Twilio. An application inside of Twilio is just a set of URLs and other configuration data that tells Twilio how to behave when one of your Twilio numbers receives a call or SMS message.

Operations: list, create, fetch, update, delete

Summary

Functions

create(client, params \\ %{}, opts \\ [])

Create a new application within your account

delete(client, sid, opts \\ [])

Delete the application by the specified application sid

fetch(client, sid, opts \\ [])

Fetch the application specified by the provided sid

list(client, params \\ %{}, opts \\ [])

Retrieve a list of applications representing an application within the requesting account

stream(client, params \\ %{}, opts \\ [])

Stream: Retrieve a list of applications representing an application within the requesting account (lazy auto-pagination).

update(client, sid, params \\ %{}, opts \\ [])

Updates the application's properties

Functions

create(client, params \\ %{}, opts \\ [])

@spec create(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Api.V2010.Application.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Create a new application within your account

Operation: CreateApplication | Tags: Api20100401Application

Optional Parameters

Parameter	Type	Description

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| ApiVersion | string | 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. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| FriendlyName | string | A descriptive string that you create to describe the new application. It can be up to 64 characters long. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| MessageStatusCallback | string (uri) | The URL we should call using a POST method to send message status information to your application. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| PublicApplicationConnectEnabled | boolean | Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: true or false. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| SmsFallbackMethod | string (http-method) | The HTTP method we should use to call sms_fallback_url. Can be: GET or POST. Values: GET, POST |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| SmsFallbackUrl | string (uri) | The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| SmsMethod | string (http-method) | The HTTP method we should use to call sms_url. Can be: GET or POST. Values: GET, POST |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

`SmsStatusCallback`	string (uri)	The URL we should call using a POST method to send status information about SMS messages sent by the application.
`SmsUrl`	string (uri)	The URL we should call when the phone number receives an incoming SMS message.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| StatusCallback | string (uri) | The URL we should call using the status_callback_method to send status information to your application. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| StatusCallbackMethod | string (http-method) | The HTTP method we should use to call status_callback. Can be: GET or POST. Values: GET, POST |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| VoiceCallerIdLookup | boolean | Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true or false. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| VoiceFallbackMethod | string (http-method) | The HTTP method we should use to call voice_fallback_url. Can be: GET or POST. Values: GET, POST |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| VoiceFallbackUrl | string (uri) | The URL that we should call when an error occurs retrieving or executing the TwiML requested by url. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| VoiceMethod | string (http-method) | The HTTP method we should use to call voice_url. Can be: GET or POST. Values: GET, POST |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| VoiceUrl | string (uri) | The URL we should call when the phone number assigned to this application receives a call. |

delete(client, sid, opts \\ [])

@spec delete(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:ok, map(), map()} | :ok | {:error, Twilio.Error.t()}

Delete the application by the specified application sid

Operation: DeleteApplication | Tags: Api20100401Application

fetch(client, sid, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Api.V2010.Application.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Fetch the application specified by the provided sid

Operation: FetchApplication | Tags: Api20100401Application

list(client, params \\ %{}, opts \\ [])

@spec list(Twilio.Client.t(), map(), keyword()) ::
  {:ok, Twilio.Page.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Retrieve a list of applications representing an application within the requesting account

Operation: ListApplication | Tags: Api20100401Application

Query Parameters

Parameter	Type	Description
`FriendlyName`	string	The string that identifies the Application resources to read.

stream(client, params \\ %{}, opts \\ [])

@spec stream(Twilio.Client.t(), map(), keyword()) :: Enumerable.t()

Stream: Retrieve a list of applications representing an application within the requesting account (lazy auto-pagination).

update(client, sid, params \\ %{}, opts \\ [])

@spec update(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Api.V2010.Application.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Updates the application's properties

Operation: UpdateApplication | Tags: Api20100401Application

Optional Parameters

Parameter	Type	Description

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| ApiVersion | string | 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. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| FriendlyName | string | A descriptive string that you create to describe the resource. It can be up to 64 characters long. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| MessageStatusCallback | string (uri) | The URL we should call using a POST method to send message status information to your application. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| PublicApplicationConnectEnabled | boolean | Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: true or false. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| SmsFallbackMethod | string (http-method) | The HTTP method we should use to call sms_fallback_url. Can be: GET or POST. Values: GET, POST |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| SmsFallbackUrl | string (uri) | The URL that we should call when an error occurs while retrieving or executing the TwiML from sms_url. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| SmsMethod | string (http-method) | The HTTP method we should use to call sms_url. Can be: GET or POST. Values: GET, POST |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

`SmsStatusCallback`	string (uri)	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.
`SmsUrl`	string (uri)	The URL we should call when the phone number receives an incoming SMS message.

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| StatusCallback | string (uri) | The URL we should call using the status_callback_method to send status information to your application. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| StatusCallbackMethod | string (http-method) | The HTTP method we should use to call status_callback. Can be: GET or POST. Values: GET, POST |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| VoiceCallerIdLookup | boolean | Whether we should look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: true or false. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| VoiceFallbackMethod | string (http-method) | The HTTP method we should use to call voice_fallback_url. Can be: GET or POST. Values: GET, POST |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| VoiceFallbackUrl | string (uri) | The URL that we should call when an error occurs retrieving or executing the TwiML requested by url. |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| VoiceMethod | string (http-method) | The HTTP method we should use to call voice_url. Can be: GET or POST. Values: GET, POST |

credo:disable-for-next-line Credo.Check.Readability.MaxLineLength

| VoiceUrl | string (uri) | The URL we should call when the phone number assigned to this application receives a call. |