Shared space

Documentation

Understand each product and integrate it step by step: getting started, guides, best practices.

• SMS API — Aureus DeskAvailable

  • Aureus Desk SMS API

    Send transactional SMS by API to open countries (Cameroon today) — what you can do and where to start.

  • Create an account and get an API key

    Sign in with your Aureus Prime account, have your identity or business verified, top up and create an API key.

  • Quick start

    Send your first SMS in three steps: verified account, API key, API call.

  • Send an SMS

    POST /sms/messages — fields, number formats, text conversion, 2-SMS messages, sender, sensitive messages and idempotency.

  • Schedule an SMS

    scheduledAt — sending on a chosen date up to 30 days ahead, reserved credits, cancellation with DELETE.

  • Track an SMS

    GET /sms/messages/:id — QUEUED, SENDING, SENT, DELIVERED, FAILED, CANCELLED statuses, 2-SMS messages and credits given back.

  • Balance and top-ups

    GET /sms/balance, GET /sms/price-tiers and GET /sms/coverage — credits, free credits, price per country, top-up bonus and payment methods.

  • Senders

    GET and POST /sms/senders — shared sender, an organisation's own name, approval before use, a single name per account.

  • Best practices

    Idempotency, sensitive codes, retries, key security and permitted SMS.

• Aureus GateOther site

  Mobile Money collection has its own documentation, at aureusgate.com.