Get the SMS overview

What the SMS page shows: whether SMS is switched on, the sender ID texts to the signup country go out as, the team's sender ID requests and the paperwork…

GEThttps://app.usenotix.dev/api/v1/sms/overview

Full access and read only keys can call this. Sending access keys cannot. Key permissions lists the extra rules some calls have.

What the SMS page shows: whether SMS is switched on, the sender ID texts to the signup country go out as, the team's sender ID requests and the paperwork each still needs, the price per text in each country with a route, the extra per SMS code, the sender ID fee, whether a custom code template is set and can be, how many texts the team has sent, and the wallet. wallet (the balance) is only given to a key made by a team admin, as the page's strip shows it to admins only; it is null otherwise, and for a team with no wallet yet. Nothing is paid or requested through the API: topUpUrl is where a person tops up, and sender IDs are requested on the SMS page.

Who can call it

Full access and read only keys. Send-only and live AI keys answer 403 SCOPE_DENIED; a key limited to one domain answers 403 DOMAIN_PINNED, as on every SMS and one-time code route.

The team can make 60 of these reads a minute; when Notix cannot count them the answer is 503 SERVICE_UNAVAILABLE (try again shortly), never a 429. Each read holds the database at most 10 seconds and answers 422 past that.

Headers

Authorizationstringrequired

Bearer followed by your API key.

Errors

403

`SCOPE_DENIED`: a send-only or live AI key (or a read only key on the change). `DOMAIN_PINNED`: a key limited to one domain.

422

The read took longer than 10 seconds.

429

The team made 60 SMS and code reads in the last minute.

503

The rate counters or the database cannot be used just now; try again shortly.

Every error has the same shape. See all error codes.

curl -X GET "https://app.usenotix.dev/api/v1/sms/overview" \
  -H "Authorization: Bearer $NOTIX_API_KEY"
Response200
{
  "smsEnabled": true,
  "canRequestSenderId": true,
  "currency": "NGN",
  "wallet": {
    "currency": "NGN",
    "amountMinor": 1,
    "formatted": "₦5,950"
  },
  "topUpUrl": "string",
  "prices": [
    {
      "countryCode": "NG",
      "countryName": "Nigeria",
      "pricePerMessage": "5.95"
    }
  ],
  "verificationPremium": "15",
  "senderIdFee": {
    "currency": "NGN",
    "amountMinor": 1,
    "formatted": "₦5,950"
  },
  "senderId": {
    "value": "ACMEBANK",
    "owned": true,
    "status": "REQUESTED",
    "countryCode": "string"
  },
  "senderIdRequests": [
    {
      "id": "cm1x8f3k20001qz7v5b9d2e4a",
      "value": "string",
      "countryCode": "string",
      "type": "CORPORATE",
      "status": "REQUESTED",
      "notes": "string",
      "organisationName": "Acme",
      "sampleMessage": "string",
      "documents": [
        null
      ],
      "missingDocuments": [
        null
      ]
    }
  ],
  "otpTemplate": {
    "custom": true,
    "canEdit": true
  },
  "messagesSent": 1
}
Open in ClaudeOpen in ChatGPT