Public
Documentation Settings

avlytext.com

AvlyText is a Restful API that allows you to send SMS in every country. Visit https://avlytext.com to create your account. Every request may return http errors:

  • 401 Unauthorized if Authentication failed
  • 402 Payment Required if your balance is insufficient for the requested action
  • 403 Forbidden if you are not allowed to access the requested resource
  • 404 Not Found if the requested resource doesn't exists
  • 422 Unprocessable Entity if the data submitted in body or query string are not properly defined

contacts

POSTSend one SMS using POST

https://api.avlytext.com/v1/sms?api_key={api_key}
HEADERS
Content-Type

application/json

PARAMS
api_key

{api_key}

Bodyraw (json)
json
{
    "sender": "MyApp",
    "recipient": "+237699224477",
    "text": "This is a test message."
}
Example Request
curl
curl --location 'https://api.avlytext.com/v1/sms?api_key=dMoSJgddqOQyB1tir3cnk5jm2eDNr0u0jsbgpvZ8Knwd58ZDU1FlSTClJgaZupwr4K00' \
--header 'Content-Type: application/json' \
--data '{
    "sender": "MyApp",
    "recipient": "+237699224477",
    "text": "This is a test message."
}'
200 OK
Example Response
json
{
  "id": "b268b2cc-4807-4506-874e-595a660f3518",
  "cost": 0.025,
  "parts": 1
}
Date

Tue, 18 May 2021 08:10:39 GMT

Server

Apache

Cache-Control

no-cache, private

Access-Control-Allow-Origin

*

Content-Length

68

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json

GETSend one SMS using GET

https://api.avlytext.com/v1/sms?api_key={api_key}&sender=MyApp&recipient=237699224477&text=This%20is%20test%20message.
PARAMS
api_key

{api_key}

sender

MyApp

recipient

237699224477

text

This%20is%20test%20message.

Example Request
curl
curl --location 'https://api.avlytext.com/v1/sms?api_key=dMoSJgddqOQyB1tir3cnk5jm2eDNr0u0jsbgpvZ8Knwd58ZDU1FlSTClJgaZupwr4K00&sender=MyApp&recipient=237699224477&text=This%20is%20a%20test%20message.'
200 OK
Example Response
json
{
  "id": "6ee30c02-f53d-4b12-b597-892875d03150",
  "cost": 0.025,
  "parts": 1
}
Date

Tue, 18 May 2021 08:11:55 GMT

Server

Apache

Cache-Control

no-cache, private

Access-Control-Allow-Origin

*

Content-Length

68

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json

POSTSend multiple SMS

https://api.avlytext.com/v1/sms/bulk?api_key={api_key}
PARAMS
api_key

{api_key}

Bodyraw (json)
json
{
    "sender": "MyApp",
    "messages": [
        {
            "recipient": "+237699224477",
            "text": "This is a test message 1."
        },
        {
            "recipient": "+237677332211",
            "text": "This is a test message 2."
        }
    ]
}
Example Request
curl
curl --location 'https://api.avlytext.com/v1/sms/bulk?api_key=dMoSJgddqOQyB1tir3cnk5jm2eDNr0u0jsbgpvZ8Knwd58ZDU1FlSTClJgaZupwr4K00' \
--data '{
    "sender": "MyApp",
    "messages": [
        {
            "recipient": "+237699224477",
            "text": "This is a test message 1."
        },
        {
            "recipient": "+237677332211",
            "text": "This is a test message 2."
        }
    ]
}'
200 OK
Example Response
json
[
  {
    "id": "258e784b-1cd3-4b71-bccf-f8ebf21cd207",
    "from": "MyApp",
    "to": "+237699224477",
    "cost": 0.022,
    "parts": 1,
    "status": "pending"
  },
  {
    "id": "e6908689-6f69-4fce-a23c-fb9692f17b44",
    "from": "MyApp",
    "to": "+237677332211",
    "cost": 0.022,
    "parts": 1,
    "status": "pending"
  }
]
Date

Sun, 04 Sep 2021 12:46:32 GMT

Server

Apache

Cache-Control

no-cache, private

Access-Control-Allow-Origin

*

Content-Length

249

Keep-Alive

timeout=5, max=100

Connection

Keep-Alive

Content-Type

application/json