Skip to content
Aureus PrimeDocs

API reference

Changelog

Changes to the SMS API, from the newest to the oldest. A breaking change (field removed, behaviour modified) is always flagged as such here, before it goes live.

2 November 2026

New:

  • 2-SMS message with "allowTwoParts": true: up to about 310 characters, split between two words, "1/2" and "2/2" prefixes, billed per part; part 2 is only sent once part 1 has been delivered (errorCode PART1_NOT_DELIVERED if it is not delivered within 15 minutes);
  • groupId and part fields in the message object; normalized, smsCount, totalCredits and parts in the send response;
  • GET /sms/balance returns free credits (promoBalance, promoExpiresAt);
  • GET /sms/coverage documented: open countries and price of one SMS in credits.

Behaviour changes:

  • the text is always converted to the SMS alphabet (ê becomes e, the curly apostrophe becomes straight, emoji and non-Latin scripts removed). The Unicode mode limited to 70 characters no longer exists: 160 characters per SMS in every case;
  • a text longer than 160 characters now returns 422 TEXT_TWO_PARTS_REQUIRED (instead of TEXT_TOO_LONG), and 422 TEXT_TWO_PARTS_MAX beyond 2 SMS;
  • balance in credits: 1 credit = 1 FCFA, 25 credits per SMS in Cameroon, bonus credits on large top-ups;
  • a single custom sender name per account: 409 SENDER_LIMIT_REACHED and 409 SENDER_NAME_REFUSED replace 409 CONFLICT.

1 November 2026 — first public version

The Aureus Desk SMS API is open, as version v1.

Available:

  • sending SMS to MTN and Orange mobiles in Cameroon (POST /sms/messages), with idempotency key and sensitive messages;
  • scheduled sending up to 30 days ahead (scheduledAt) and cancellation of a scheduled SMS (DELETE /sms/messages/:id);
  • delivery tracking (GET /sms/messages/:id);
  • balance, price grid and senders (GET /sms/balance, GET /sms/price-tiers, GET and POST /sms/senders);
  • SMS length depending on the encoding: 160 characters in the GSM alphabet, 70 in Unicode;
  • rate limiting per key, with the 429 RATE_LIMITED code;
  • 2 active API keys at most per account.

Not available yet: test environment, delivery notifications by webhook.