Skip to main content
Version: 1.0

UnifierAPI

Unifier API is an HTTP API for omnichannel messaging. Use it to send messages (including fallback routes), retrieve notifications for DLRs, inbound messages or download inbound media and other events.

The API base URL is:

https://unifier{separator}{platform_domain}

Note: Replace {platform_domain} with your platform domain. {separator} can be either . or -, depending on your platform configuration.

Supported channels: RBM, SMS, Telegram, WhatsApp, Email*, Facebook and Instagram Messenger.
* Outbound only

Typical flows:

  • Send messages with optional fallback messages (POST /v1/messages).
  • Poll for notifications (GET /v1/updates).
  • Register a customer webhook URL in your connection settings to receive the same notification payloads as push-style Notification events (signed with X-Msg-Api-Signature).

Authentication: Every REST call (except your own webhook endpoint) must include the API key in the X-API-Key header. Keys are client_secret on the customer connection. Some deployments also enforce IP whitelist on the connection.

Definitions:

  • Message request is the HTTP request from customer to Unifier API to send a message intended recipient's device that can also contain fallback messages.
  • Outbound message is the message that is delivered from our service to the telecom network or RBM Google, WhatsApp etc to terminate at the intended recipient's device.
  • Inbound message is the message that was initiated and sent by a mobile subscriber (end user) through their device,routed via the SMS telecom network or RBM Google, WhatsApp etc to a designated sender of the message request.
  • DLR is a status sent back by the telecom network to confirm whether an SMS message that was previously submitted has been successfully delivered to the intended recipient's handset, or to report a failure/error if delivery was unsuccessful.
  • Notification is an information of an inbound message, DLR or an event of a fallback.