API Reference

Every endpoint of the AppStract SMS API.

The AppStract SMS API is a REST API. It accepts and returns JSON, and uses standard HTTP status codes.

Base URL

https://api.appstractone.com/v1

Authentication

Send your API key as a bearer token. See Authentication.

-H "Authorization: Bearer sk_live_..."

Pagination

List endpoints accept page (from 1) and limit (1 to 100, default 10), and return:

{
  "docs": [],
  "totalDocs": 42,
  "limit": 10,
  "totalPages": 5,
  "page": 1,
  "pagingCounter": 1,
  "hasPrevPage": false,
  "hasNextPage": true,
  "prevPage": null,
  "nextPage": 2
}

Money

Amounts are strings with a currency, such as { "amount": "0.04", "currency": "GHS" }, so no precision is lost.

Errors

See Errors for the error format and codes.

On this page