Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/danielberkompas/ex_twiml
Generate TwiML with Elixir
https://github.com/danielberkompas/ex_twiml
Last synced: 12 days ago
JSON representation
Generate TwiML with Elixir
- Host: GitHub
- URL: https://github.com/danielberkompas/ex_twiml
- Owner: danielberkompas
- License: mit
- Created: 2015-03-10T04:19:06.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T01:49:47.000Z (7 months ago)
- Last Synced: 2024-04-14T00:38:49.441Z (7 months ago)
- Language: Elixir
- Size: 91.8 KB
- Stars: 36
- Watchers: 2
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- freaking_awesome_elixir - Elixir - Generate TwiML for your Twilio integration, right inside Elixir. (Third Party APIs)
- fucking-awesome-elixir - ex_twiml - Generate TwiML for your Twilio integration, right inside Elixir. (Third Party APIs)
- awesome-elixir - ex_twiml - Generate TwiML for your Twilio integration, right inside Elixir. (Third Party APIs)
README
ExTwiml
===================
[](https://danielberkompas.semaphoreci.com/projects/ex_twiml)
[](https://hex.pm/packages/ex_twiml)
[](http://inch-ci.org/github/danielberkompas/extwiml)
Generate TwiML for your [Twilio](http://twilio.com) integration, right inside
Elixir! Built to be used with [Telephonist](https://github.com/danielberkompas/telephonist),
but it can be used entirely on its own.
## Installation
ExTwiml can be installed through mix as a hex package. First, update your
dependencies in `mix.exs`.
```elixir
defp deps do
[{:ex_twiml, "~> 2.1.3"}]
end
```
If you prefer, you can depend on the latest version from Github:
```elixir
defp deps do
[{:ex_twiml, github: "danielberkompas/ex_twiml"}]
end
```
Add it to your application list in `mix.exs`:
```diff
def application do
[mod: {YourApp, []},
+ applications: [:ex_twiml]]
end
```
Then run `mix deps.get`, and ExTwiml will be installed.
## Usage
Import the `ExTwiml` module into your module, and then use the `twiml` macro to
generate your TwiML, like so:
```elixir
defmodule YourModule do
import ExTwiml
def render do
twiml do
play "/assets/welcome.mp3"
gather digits: 4, finish_on_key: "#" do
say """
Please enter the last four digits of your credit card number, followed
by the pound sign.
""", voice: "woman"
end
end
end
end
```
You can then render the TwiML by calling `YourModule.render/0`. The output will
be a binary in this format:
```xml
/assets/welcome.mp3
Please enter the last four digits of your credit card number, followed by
the pound sign.
```
The `twiml` macro simply returns a binary (or string), so you're not limited to
the pattern above. Just use `twiml` wherever you need a TwiML string.
## Configuration
You can configure default options for verbs. For example, suppose you wanted all
`` verbs to use the "Alice" voice, and all `` verbs to have the
method "GET".
Simply add this code to your `config/config.exs`:
```elixir
config :ex_twiml, :defaults,
say: [voice: "alice"],
gather: [method: "GET"]
```
Then this code:
```elixir
twiml do
gather do
say "Hello"
end
end
```
Will result in this TwiML:
```xml
Hello
```
Defaults can be overridden:
```elixir
gather method: "POST"
say "Hello", voice: "woman"
```
## Supported Verbs and Nouns
See the [Twilio Documentation](https://www.twilio.com/docs/api/twiml) for a
complete list of verbs supported by Twilio. ExTwiml has built in macros for the
following verbs and nouns:
- [Say](https://www.twilio.com/docs/api/2010-04-01/twiml/say)
- [Play](https://www.twilio.com/docs/api/2010-04-01/twiml/play)
- [Gather](https://www.twilio.com/docs/api/2010-04-01/twiml/gather)
- [Record](https://www.twilio.com/docs/api/2010-04-01/twiml/record)
- [Sms](https://www.twilio.com/docs/api/2010-04-01/twiml/sms)
- [Dial](https://www.twilio.com/docs/api/2010-04-01/twiml/dial)
- [Number](https://www.twilio.com/docs/api/2010-04-01/twiml/number)
- [Sip](https://www.twilio.com/docs/api/2010-04-01/twiml/sip)
- [Client](https://www.twilio.com/docs/api/2010-04-01/twiml/client)
- [Conference](https://www.twilio.com/docs/api/2010-04-01/twiml/conference)
- [Queue](https://www.twilio.com/docs/api/2010-04-01/twiml/queue)
- [Enqueue](https://www.twilio.com/docs/api/2010-04-01/twiml/enqueue)
- [Leave](https://www.twilio.com/docs/api/2010-04-01/twiml/leave)
- [Hangup](https://www.twilio.com/docs/api/2010-04-01/twiml/hangup)
- [Redirect](https://www.twilio.com/docs/api/2010-04-01/twiml/redirect)
- [Reject](https://www.twilio.com/docs/api/2010-04-01/twiml/reject)
- [Pause](https://www.twilio.com/docs/api/2010-04-01/twiml/pause)
- [Message](https://www.twilio.com/docs/api/2010-04-01/twiml/message)
- [Body](https://www.twilio.com/docs/api/2010-04-01/twiml/body)
- [Media](https://www.twilio.com/docs/api/2010-04-01/twiml/media)
- [Redirect](https://www.twilio.com/docs/api/2010-04-01/twiml/redirect)
To maximize compatibility with future versions of the TwiML spec, ExTwiml
**does not** validate the attributes passed to the various verbs to ensure that
they are supported by Twilio. You'll need to do this yourself.
### Unsupported Verbs?
If the Twilio API adds a verb and I haven't yet added support for it, you can do
two things:
1. Submit a PR to add it
2. Use the `tag` macro in the meantime while the PR is reviewed
The tag macro can be used to create arbitrary XML tags in the output, like this:
```elixir
tag :custom, option_1: "value" do
tag :speak, do: "Whatever you say, boss!"
end
# => "Whatever you say, boss!"
```
## Contributing
Contributions are welcome!
1. Fork the repository
2. Code up your changes
3. Submit a PR back here with your fix.