Brazeno.com

Authorization

All requests require an API key for authorization. The API key must be included in the x-api-key header for each request.

API Key: The x-api-key header must be included with every request to authenticate the client. Requests without this header will return a 401 Unauthorized error.

Example:

x-api-key: YOUR_API_KEY

1. Send SMS

POST /sms

Sends an SMS message. The message can be directly specified or templated.

Headers

• x-api-key (required): API key for authorization.

Request Body

Sample Request (Non Templated)

curl --location 'https://api.brazeno.com/api/v1/sms' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "to": "+15551234567",
  "from": "+15558675309",
  "body": "This is a sample SMS message for testing purposes.",
  "clientIdentifier": "client-001"
}'

Sample Request (Templated)

curl --location 'https://api.brazeno.com/api/v1/sms' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "templateId": "tmpl_1234567890abcdef",
  "to": "+15551234567",
  "from": "+15558675309",
  "data": {
    "name": "Alex Example",
    "address": "123 Example Street",
    "etor": "8pm"
  },
  "clientIdentifier": "client-001",
  "notBefore": "2025-01-01T12:00:00Z",
  "notAfter": "2025-01-01T14:00:00Z"
}'

Sample Response

200 OK

{
    "status": "queued",
    "messageId": "1234567890abcdef"
}

Response Fields

Rate Limiting

To ensure fair usage of resources, the Send SMS API endpoint is rate-limited based on each client’s API key. If the rate limit is exceeded, subsequent requests will be temporarily blocked until the rate limit resets.

Current Rate Limit

The current rate limit may vary based on your subscription plan and usage agreement. Please refer to the API’s response headers to monitor your rate limit status, or contact us for your specific rate limit settings.

Rate Limit Headers

On each response, the following headers provide rate limit details:

Exceeded Rate Limit Response

If the rate limit is exceeded, the following response will be returned:

{
    "error": "Rate limit exceeded"
}

Increasing Rate Limit

If your application requires a higher rate limit, please reach out to the Brazeno support team to discuss rate limit adjustments that suit your requirements. We are happy to accommodate higher traffic where possible. Contact us via email at contact@emsgnow.net or through your Brazeno representative.

2. Get SMS Status

Retrieve message status events using either a POST (for multiple message IDs) or a GET (for a single message ID).

Headers

• x-api-key (required): API key for authorization.
• Content-Type: application/json

Endpoint

https://api.brazeno.com/api/v1/message/status

Sample Request (POST - multiple messageIds)

curl --location 'https://api.brazeno.com/api/v1/message/status' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{
  "messageIds": [
    "1eff6f78-0701-453e-8c6c-8cb969d2e5cd",
    "7d4b3db1-e4fa-44ff-8ac6-94b29b40885e"
  ]
}'

Sample Request (GET - single messageId)

curl --location --request GET 'https://api.brazeno.com/api/v1/message/status?messageId=390b6f28-20bd-4cc5-8cae-6e598f9abf8b' \
--header 'x-api-key: YOUR_API_KEY'

Sample Response (both verbs)

[
  {
    "messageId": "390b6f28-20bd-4cc5-8cae-6e598f9abf8b",
    "clientIdentifier": "approval-886f97ec-ecfe-4285-b2e7-f4fdff4c9000-1757449306535",
    "to": "+15551234567",
    "from": "+15558675309",
    "channel": "sms",
    "statuses": [
      {
        "status": "queued",
        "statusAt": "2025-09-09T20:21:46.646Z",
        "url": null,
        "userAgent": null
      },
      {
        "status": "sent to provider",
        "statusAt": "2025-09-09T20:21:47.162Z",
        "url": null,
        "userAgent": null
      }
    ]
  }
]

Response Fields

statuses Array

Error Responses

401 Unauthorized

{
    "error": "API key is required"
}

403 Forbidden

{
    "error": "Invalid API key"
}

500 Internal Server Error

{
    "error": "Failed to retrieve SMS status"
}

429 Too Many Requests

{
    "error": "Rate limit exceeded"
}