AtEx v0.20.21 AtEx View Source

AtEx is an Elixir Wrapper for the Africas Talking Api Use this library to handle interaction with the Africas Talking API end points, It is most useful for

  • Consuming incoming events that have been parsed
  • Building valid responses

Almost all of the endpoints have been implemented,these includes the following sections of the API:

  • SMS
  • USSD
  • Airtime
  • Application
  • Voice
  • Payment
  • IoT

Link to this section Summary

Functions

Collects application data from Africas Talking endpoint, Use this function to collect Data about your application

Sends airtime

Link to this section Functions

Collects application data from Africas Talking endpoint, Use this function to collect Data about your application

Parameters

  • none

Examples

iex> AtEx.get_application_data()
{:ok, %{"UserData" => %{"balance" => "ZAR -1.4572"}}}
Link to this function

send_airtime(map)

View Source
send_airtime(%{recipients: [map()]}) :: {:error, any()} | {:ok, any()}

Sends airtime

## Parameters

- map: a map that represents the details of the party you are sending airtime to

## Examples

iex> AtEx.send_airtime(%{recipients: [%{phone_number: "+254721978097", amount: "KES 50"}]})
  {:ok,
    %{
      "errorMessage" => "None",
      "numSent" => 1,
      "responses" => [
        %{
          "amount" => "KES 50.0000",
          "discount" => "KES 2.0000",
          "errorMessage" => "None",
          "phoneNumber" => "+254721978097",
          "requestId" => "ATQid_630557e624c70f2b0d2c5e90ebc282bb",
          "status" => "Sent"
        }
      ],
      "totalAmount" => "ZAR 7.0277",
      "totalDiscount" => "ZAR 0.2811"
  }}