ExTwilio v0.7.0 ExTwilio.Api View Source
Provides a basic HTTP interface to allow easy communication with the Twilio
API, by wrapping HTTPotion
.
Examples
Requests are made to the Twilio API by passing in a resource module into one
of this Api
module's functions. The correct URL to the resource is inferred
from the module name.
ExTwilio.Api.find(Resource, "sid")
%Resource{ sid: "sid", ... }
Items are returned as instances of the given module's struct. For more details, see the documentation for each function.
Link to this section Summary
Functions
Builds custom auth header for subaccounts
Builds custom auth header for subaccounts handles master account case if :"Authorization" custom header isn't present
Create a new resource in the Twilio API with a POST request
Issues a DELETE request to the given url
Issues a DELETE request to the given url, raising an exception in case of failure
Destroy an existing resource in the Twilio Api
Find a given resource in the Twilio API by its SID
Issues a GET request to the given url
Issues a GET request to the given url, raising an exception in case of failure
Issues a HEAD request to the given url
Issues a HEAD request to the given url, raising an exception in case of failure
Issues an OPTIONS request to the given url
Issues a OPTIONS request to the given url, raising an exception in case of failure
Issues a PATCH request to the given url
Issues a PATCH request to the given url, raising an exception in case of failure
Issues a POST request to the given url
Issues a POST request to the given url, raising an exception in case of failure
Automatically adds the correct headers to each API request
Issues a PUT request to the given url
Issues a PUT request to the given url, raising an exception in case of failure
Issues an HTTP request with the given method to the given url
Issues an HTTP request with the given method to the given url, raising an exception in case of failure
Starts HTTPoison and its dependencies
Requests the next message to be streamed for a given HTTPoison.AsyncResponse
Update an existing resource in the Twilio Api
Link to this section Types
body()
View Source
body() :: HTTPoison.Base.body()
body() :: HTTPoison.Base.body()
data() View Source
headers()
View Source
headers() :: HTTPoison.Base.headers()
headers() :: HTTPoison.Base.headers()
Link to this section Functions
auth_header(options \\ []) View Source
Builds custom auth header for subaccounts
Examples
iex> ExTwilio.Api.auth_header([account: 123, token: 123]) ["Authorization": "Basic MTIzOjEyMw=="]
iex> ExTwilio.Api.auth_header([], {nil, 2}) []
auth_header(headers, arg2) View Source
Builds custom auth header for subaccounts handles master account case if :"Authorization" custom header isn't present
Examples
iex> ExTwilio.Api.auth_header([], {123, 123}) ["Authorization": "Basic MTIzOjEyMw=="]
iex> ExTwilio.Api.auth_header(["Authorization": "Basic BASE64=="], {123, 123}) ["Authorization": "Basic BASE64=="]
create(module, data, options \\ [])
View Source
create(atom(), data(), list()) ::
ExTwilio.Parser.success() | ExTwilio.Parser.error()
create(atom(), data(), list()) :: ExTwilio.Parser.success() | ExTwilio.Parser.error()
Create a new resource in the Twilio API with a POST request.
Examples
ExTwilio.Api.create(ExTwilio.Call, [to: "1112223333", from: "4445556666"])
{:ok, %Call{ ... }}
ExTwilio.Api.create(ExTwilio.Call, [])
{:error, %{"message" => "No 'To' number is specified"}, 400}
delete(url, headers \\ [], options \\ [])
View Source
delete(binary(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
delete(binary(), headers(), Keyword.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
Issues a DELETE request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
delete!(url, headers \\ [], options \\ [])
View Source
delete!(binary(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
delete!(binary(), headers(), Keyword.t()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
Issues a DELETE request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
destroy(module, sid, options \\ []) View Source
Destroy an existing resource in the Twilio Api.
Examples
ExTwilio.Api.destroy(ExTwilio.Call, "<sid>")
:ok
ExTwilio.Api.destroy(ExTwilio.Call, "nonexistent")
{:error, %{"message" => The requested resource ... was not found"}, 404}
find(module, sid, options \\ [])
View Source
find(atom(), String.t() | nil, list()) ::
ExTwilio.Parser.success() | ExTwilio.Parser.error()
find(atom(), String.t() | nil, list()) :: ExTwilio.Parser.success() | ExTwilio.Parser.error()
Find a given resource in the Twilio API by its SID.
Examples
If the resource was found, find/2
will return a two-element tuple in this
format, {:ok, item}
.
ExTwilio.Api.find(ExTwilio.Call, "<sid here>")
{:ok, %Call{ ... }}
If the resource could not be loaded, find/2
will return a 3-element tuple
in this format, {:error, error_body, code}
. The code
is the HTTP status code
returned by the Twilio API, for example, 404.
ExTwilio.Api.find(ExTwilio.Call, "nonexistent sid")
{:error, %{"message" => The requested resource couldn't be found..."}, 404}
format_data(data) View Source
get(url, headers \\ [], options \\ [])
View Source
get(binary(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
get(binary(), headers(), Keyword.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
Issues a GET request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
get!(url, headers \\ [], options \\ [])
View Source
get!(binary(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
get!(binary(), headers(), Keyword.t()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
Issues a GET request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
head(url, headers \\ [], options \\ [])
View Source
head(binary(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
head(binary(), headers(), Keyword.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
Issues a HEAD request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
head!(url, headers \\ [], options \\ [])
View Source
head!(binary(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
head!(binary(), headers(), Keyword.t()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
Issues a HEAD request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
options(url, headers \\ [], options \\ [])
View Source
options(binary(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
options(binary(), headers(), Keyword.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
Issues an OPTIONS request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
options!(url, headers \\ [], options \\ [])
View Source
options!(binary(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
options!(binary(), headers(), Keyword.t()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
Issues a OPTIONS request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
patch(url, body, headers \\ [], options \\ [])
View Source
patch(binary(), any(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
patch(binary(), any(), headers(), Keyword.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
Issues a PATCH request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
patch!(url, body, headers \\ [], options \\ [])
View Source
patch!(binary(), any(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
patch!(binary(), any(), headers(), Keyword.t()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
Issues a PATCH request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
post(url, body, headers \\ [], options \\ [])
View Source
post(binary(), any(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
post(binary(), any(), headers(), Keyword.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
Issues a POST request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
post!(url, body, headers \\ [], options \\ [])
View Source
post!(binary(), any(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
post!(binary(), any(), headers(), Keyword.t()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
Issues a POST request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
process_headers(headers) View Source
process_request_body(body) View Source
process_request_headers(headers) View Source
Automatically adds the correct headers to each API request.
process_request_options(options) View Source
process_response_body(body) View Source
process_response_chunk(chunk) View Source
process_status_code(status_code) View Source
process_url(url) View Source
put(url, body \\ "", headers \\ [], options \\ [])
View Source
put(binary(), any(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
put(binary(), any(), headers(), Keyword.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
Issues a PUT request to the given url.
Returns {:ok, response}
if the request is successful, {:error, reason}
otherwise.
See request/5
for more detailed information.
put!(url, body \\ "", headers \\ [], options \\ [])
View Source
put!(binary(), any(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
put!(binary(), any(), headers(), Keyword.t()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
Issues a PUT request to the given url, raising an exception in case of failure.
If the request does not fail, the response is returned.
See request!/5
for more detailed information.
request(method, url, body \\ "", headers \\ [], options \\ [])
View Source
request(atom(), binary(), any(), headers(), Keyword.t()) ::
{:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()}
| {:error, HTTPoison.Error.t()}
request(atom(), binary(), any(), headers(), Keyword.t()) :: {:ok, HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
Issues an HTTP request with the given method to the given url.
This function is usually used indirectly by get/3
, post/4
, put/4
, etc
Args:
method
- HTTP method as an atom (:get
,:head
,:post
,:put
,:delete
, etc.)url
- target url as a binary string or char listbody
- request body. See more belowheaders
- HTTP headers as an orddict (e.g.,[{"Accept", "application/json"}]
)options
- Keyword list of options
Body:
- binary, char list or an iolist
{:form, [{K, V}, ...]}
- send a form url encoded{:file, "/path/to/file"}
- send a file{:stream, enumerable}
- lazily send a stream of binaries/charlists
Options:
:timeout
- timeout to establish a connection, in milliseconds. Default is 8000:recv_timeout
- timeout used when receiving a connection. Default is 5000:stream_to
- a PID to stream the response to:async
- if given:once
, will only stream one message at a time, requires call tostream_next
:proxy
- a proxy to be used for the request; it can be a regular url or a{Host, Port}
tuple:proxy_auth
- proxy authentication{User, Password}
tuple:ssl
- SSL options supported by thessl
erlang module:follow_redirect
- a boolean that causes redirects to be followed:max_redirect
- an integer denoting the maximum number of redirects to follow:params
- an enumerable consisting of two-item tuples that will be appended to the url as query string parameters
Timeouts can be an integer or :infinity
This function returns {:ok, response}
or {:ok, async_response}
if the
request is successful, {:error, reason}
otherwise.
Examples
request(:post, "https://my.website.com", "{\"foo\": 3}", [{"Accept", "application/json"}])
request!(method, url, body \\ "", headers \\ [], options \\ [])
View Source
request!(atom(), binary(), any(), headers(), Keyword.t()) ::
HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
request!(atom(), binary(), any(), headers(), Keyword.t()) :: HTTPoison.Response.t() | HTTPoison.AsyncResponse.t()
Issues an HTTP request with the given method to the given url, raising an exception in case of failure.
request!/5
works exactly like request/5
but it returns just the
response in case of a successful request, raising an exception in case the
request fails.
start() View Source
Starts HTTPoison and its dependencies.
stream_next(resp)
View Source
stream_next(HTTPoison.AsyncResponse.t()) ::
{:ok, HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
stream_next(HTTPoison.AsyncResponse.t()) :: {:ok, HTTPoison.AsyncResponse.t()} | {:error, HTTPoison.Error.t()}
Requests the next message to be streamed for a given HTTPoison.AsyncResponse
.
See request!/5
for more detailed information.
update(module, sid, data, options \\ [])
View Source
update(atom(), String.t(), data(), list()) ::
ExTwilio.Parser.success() | ExTwilio.Parser.error()
update(atom(), String.t(), data(), list()) :: ExTwilio.Parser.success() | ExTwilio.Parser.error()
Update an existing resource in the Twilio Api.
Examples
ExTwilio.Api.update(ExTwilio.Call, "<sid>", [status: "canceled"])
{:ok, %Call{ status: "canceled" ... }}
ExTwilio.Api.update(ExTwilio.Call, "nonexistent", [status: "complete"])
{:error, %{"message" => "The requested resource ... was not found"}, 404}