integration_instructionsREST API Reference

Briccs Messaging API Documentation

Integrate SMS messaging into your application using Briccs HTTP APIs. Send single messages, bulk campaigns, OTPs, Unicode content, flash alerts, and receive delivery reports through callback URLs.

Start Integration arrow_forward View Endpoints

menu_bookIntroduction

This guide explains how to integrate Briccs Messaging SMS services through HTTP APIs. Any HTTP client in any programming language can send requests to the API.

sendSend SMS

Single or multi-recipient messages.

inventory_2Bulk SMS

Different messages to different recipients.

analyticsDelivery Reports

Track accepted, pending, delivered, and failed traffic.

flash_onFlash SMS

Urgent messages that display immediately.

languageUnicode SMS

Send non-Latin language content.

verified_userOTP Ready

Use time-sensitive SMS for verification flows.

rocket_launchQuick Start

Before sending SMS, create an API account and authenticate to receive a token. Use the token in subsequent API calls.

1Get credentials

Request your username and password from your Briccs account manager.

2Login via API

POST your credentials to the login endpoint.

3Save token

Store the token securely for server-side requests.

4Send SMS

Append ?token=TOKEN to message requests.

lock

Security: Always use HTTPS, keep credentials server-side, and never expose tokens in browser code or mobile apps.

publicBase URL

Submit API requests to the Briccs Messaging HTTP gateway. Your live base URL may be confirmed during account setup.

BASEContact Us

fact_checkContent Headers

The API supports JSON and XML payloads. Set both Content-Type and Accept.

Header	Accepted values
`Content-Type`	`application/json` or `application/xml`
`Accept`	`application/json` or `application/xml`

keyAuthentication

POST/api/rest/auth/loginh

Parameter	Type	Required	Description
`username`	String	Yes	Your account username.
`password`	String	Yes	Your account password.

Success Response

{
  "token": "M2JiNDM1M2EtZjExNC00N2NmLTg4YzEtNTZhMTE3OWY5NjZi",
  "user": {
    "userName": "testh1",
    "serviceId": "0682aea3-2f6f-46b1-a69f-37663bd16751",
    "customerId": "88cec01a-050b-4843-b7ae-581adc865bdd",
    "pushUrl": ""
  }
}

outgoing_mailSend Single SMS POST

POST is recommended for most integrations. It supports arrays of recipients, JSON bodies, callbacks, Unicode, and flash messages.

POST/api/rest/message?token={your_token}

Parameter	Type	Required	Description
`sender`	String	Yes	Sender ID. Alpha: 3-11 chars. Numeric: 3-14 chars.
`receivers`	Array	Yes	Recipient numbers in international format.
`text`	String	Yes	Message body.
`encoding`	String	No	`GSM` by default, or `UTF` for Unicode.
`isflash`	Boolean	No	Set `true` for flash messages.
`pushUrl`	String	No	Public URL for delivery report callbacks.

JSON Example

{
  "sender": "BRICCS",
  "receivers": ["2348100000000"],
  "text": "Your OTP is 482910",
  "encoding": "GSM"
}

linkSend Single SMS GET

GET is available for simple legacy integrations. Use POST for production applications where possible.

GET/api/rest/message?username={username}&password={password}&sender=BRICCS&receiver=2348100000000&text=Hello

info

GET uses receiver for one number. POST uses receivers as an array.

inventory_2Send Multiple SMS

Use the bulk endpoint to send different messages to different recipients in one API call.

POST/api/rest/message/list?token={your_token}

[
  { "sender": "BRICCS", "receivers": ["2348100000000"], "text": "Hello John, your order has shipped." },
  { "sender": "BRICCS", "receivers": ["233240000000"], "text": "Hello Ama, your appointment is confirmed." }
]

flash_onFlash SMS

Flash SMS displays directly on the phone screen. Use it carefully for OTPs and urgent alerts.

{ "sender": "BRICCS", "receivers": ["2348100000000"], "text": "URGENT: Your OTP is 482910", "isflash": true }

languageUnicode SMS

Set encoding to UTF for non-Latin languages. Unicode SMS has shorter segment limits than GSM.

{ "sender": "BRICCS", "receivers": ["2250100000000"], "text": "Bonjour, votre code est 482910", "encoding": "UTF" }

monitoringDelivery Reports

Set pushUrl to receive delivery report callbacks instead of polling. Your URL must be publicly reachable and able to receive POST requests.

{ "sender": "BRICCS", "receivers": ["2348100000000"], "text": "Your order is ready.", "pushUrl": "https://example.com/sms/delivery-report" }

straightenCharacter Limits

Long SMS messages are split into segments. Each segment is billed as one SMS.

GSM: 160 characters for a single SMS, 153 per segment for long SMS.

160 characters per SMS

Unicode: 70 characters for a single SMS, 67 per segment for long SMS.

70 characters

reportError Codes

Code	Description	Resolution
`AU04`	Invalid username	Check username spelling.
`AU05`	Invalid password	Verify or reset password.
`MSG01`	Invalid message format	Check JSON/XML structure.
`MSG02`	Invalid sender ID	Use valid sender ID length and approved sender where required.
`MSG03`	Invalid receiver number	Use international format without spaces.

task_altBest Practices

lockSecurity

Use HTTPS, protect tokens, and keep credentials on your server.

edit_noteMessage quality

Validate numbers, use correct encoding, and keep campaign text concise.

syncReliability

Retry safely, log message IDs, and monitor delivery callbacks.

tableQuick Reference

Action	Method	Endpoint
Login	POST	`/api/rest/auth/loginh`
Send SMS	POST	`/api/rest/message?token=TOKEN`
Send SMS	GET	`/api/rest/message?username=...&password=...`
Bulk SMS	POST	`/api/rest/message/list?token=TOKEN`
Flash SMS	POST	`/api/rest/message?token=TOKEN` with `isflash`
Unicode SMS	POST	`/api/rest/message?token=TOKEN` with `encoding=UTF`