PindoDocs
Web AppWeb

API Reference

Every Messaging endpoint, with request bodies and responses. Code samples are available in nine languages: pick yours once and it sticks across the docs.

Send an SMS

POST/v1/sms/
# Send a single sms
curl -X POST \
https://api.pindo.io/v1/sms/ \
-H 'Accept: */*' \
-H 'Authorization: Bearer your-token' \
-H 'Content-Type: application/json' \
-d '{
"to" : "+250781234567",
"text" : "Hello from Pindo",
"sender" : "PindoTest"
}'

# Send bulk sms
curl -X POST \
https://api.pindo.io/v1/sms/bulk \
-H 'Accept: */*' \
-H 'Authorization: Bearer your-token' \
-H 'Content-Type: application/json' \
-d '{
"recipients" : [{"phonenumber": "+250781234567", "name": "Remy Muhire"}],
"text" : "Hello @contact.name, Welcome to Pindo",
"sender" : "PindoTest"
}'
{
  "item_count": 1,
  "item_price": 0.006,
  "remaining_balance": 100.0,
  "report_id": "fa6bbae0-89bd-11f1-9725-3a2980e72df8",
  "self_url": "http://api.pindo.io/v1/sms/out_sms_01H7DJEJ1YZKTNT8EDXY2C7YG9",
  "sms_id": "out_sms_01H7DJEJ1YZKTNT8EDXY2C7YG9",
  "status": "sent",
  "to": "+250789385878",
  "total_cost": 0.006
}

Send bulk SMS

POST/v1/sms/bulk
curl -X POST \
  https://api.pindo.io/v1/sms/bulk \
  -H 'Accept: */*' \
  -H 'Authorization: Bearer your-token' \
  -H 'Content-Type: application/json' \
  -d '{
    "recipients" : [{"phonenumber": "+250781234567", "name": "Remy Muhire"}],
    "text" : "Hello @contact.name, Welcome to Pindo",
    "sender" : "PindoTest"
  }'

List inbound

GET/v1/sms/inbounds
{
  "inbound_sms": [
    {
      "account_id": "123",
      "active": true,
      "created_at": "2021-07-12T16:07:52.559125",
      "id": "in_sms_01KYJ5ALF49ZKT765FV2E407XQ",
      "id_smsc": null,
      "inbound_sms_number": "+250781113333",
      "language_id": null,
      "org_id": "0",
      "self_url": "http://api.pindo.io/v1/sms/in_sms_01KYJ9AAF02ZKT765FV2E417XQ",
      "sms_item_count": 1,
      "telco_id": null,
      "text": "Hello world !"
      "to": "+25078123456",
      "wallet_charge_id": "trn_01KYJ5IAF9HGLK6DWQDMHRPHBK"
    }
  ],
  "pages": {
    "first_url": "http://api.pindo.io/v1/sms/inbounds?page=1&per_page=1",
    "last_url": "http://api.pindo.io/v1/sms/inbounds?page=2&per_page=1",
    "next_url": "http://api.pindo.io/v1/sms/inbounds?page=2&per_page=1",
    "page": 1,
    "pages": 2,
    "per_page": 1,
    "prev_url": null,
    "total": 2
  }
}

Verify

POST/v1/sms/verify
POST/v1/sms/verify/check
curl -X POST \
  https://api.pindo.io/v1/sms/verify \
  -H 'Authorization: Bearer your-token' \
  -H 'Content-Type: application/json' \
  -d '{
    "brand": "PindoTest",
    "number": "+250781234567"
  }'

Full walkthroughs live in the guides: Send an SMS, Bulk SMS, Inbound, and Verify.