Generate TwiML for your Twilio integration, right inside Elixir! Built to be used with Telephonist, but it can be used entirely on its own.
ExTwiml can be installed through mix as a hex package. First, update your
dependencies in mix.exs.
defp deps do
[{:ex_twiml, "~> 2.1.3"}]
endIf you prefer, you can depend on the latest version from Github:
defp deps do
[{:ex_twiml, github: "danielberkompas/ex_twiml"}]
endAdd it to your application list in mix.exs:
def application do
[mod: {YourApp, []},
+ applications: [:ex_twiml]]
endThen run mix deps.get, and ExTwiml will be installed.
Import the ExTwiml module into your module, and then use the twiml macro to
generate your TwiML, like so:
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
endYou can then render the TwiML by calling YourModule.render/0. The output will
be a binary in this format:
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Play>/assets/welcome.mp3</Play>
<Gather digits="4" finishOnKey="#">
<Say voice="woman">
Please enter the last four digits of your credit card number, followed by
the pound sign.
</Say>
</Gather>
</Response>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.
You can configure default options for verbs. For example, suppose you wanted all
<Say> verbs to use the "Alice" voice, and all <Gather> verbs to have the
method "GET".
Simply add this code to your config/config.exs:
config :ex_twiml, :defaults,
say: [voice: "alice"],
gather: [method: "GET"]Then this code:
twiml do
gather do
say "Hello"
end
endWill result in this TwiML:
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Gather method="GET">
<Say voice="alice">Hello</Say>
</Gather>
</Response>Defaults can be overridden:
gather method: "POST"
say "Hello", voice: "woman"See the Twilio Documentation for a complete list of verbs supported by Twilio. ExTwiml has built in macros for the following verbs and nouns:
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.
If the Twilio API adds a verb and I haven't yet added support for it, you can do two things:
- Submit a PR to add it
- Use the
tagmacro in the meantime while the PR is reviewed
The tag macro can be used to create arbitrary XML tags in the output, like this:
tag :custom, option_1: "value" do
tag :speak, do: "Whatever you say, boss!"
end
# => "<Custom option1="value"><Speak>Whatever you say, boss!</Speak></Custom>"Contributions are welcome!
- Fork the repository
- Code up your changes
- Submit a PR back here with your fix.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent