Need help?
Go to account
API Documentation
Schema
The Schema defines the data structures used across Emisri API services covering request fields, response shapes, and nested objects for each endpoint.
SMS MODEL
Send transactional and promotional/marketing SMS messages to one or multiple recipients in a single request.
Request fields
Body
| Field | Type | Required | Description |
|---|---|---|---|
| sender | string | yes | Your registered Sender ID (max 11 characters). |
| text | string | yes | The SMS message content. |
| destination | array | yes | One or more recipient phone numbers in international format (e.g. 2348012345678). |
| options | object | no | Optional configuration for scheduling, DND, and URL shortening. See Options Object below. |
| campaignName | string | no | A label for grouping messages under a campaign. |
options object
| Field | Type | Required | Description |
|---|---|---|---|
| scheduleAt | string | no | ISO 8601 datetime to schedule the message (e.g. 2026-05-21T09:00:00Z). Omit to send immediately. |
| excludeDnd | boolean | no | Set to true to bypass Do Not Disturb restrictions for this message. |
| urlShortening | object | no | URL shortening and click tracking configuration. See URL Shortening Object below. |
options.urlShortening object
| Field | Type | Required | Description |
|---|---|---|---|
| enabled | boolean | yes | Whether URL shortening is active for this message. |
| longUrl | string | yes | The original URL to be shortened and embedded in the message. |
| trackClicks | boolean | no | Whether to track clicks on the shortened URL. |
Response fields
A successful request returns the message record. Use messageId to poll for status updates and campaignId to retrieve campaign-level analytics.
Response
| Field | Type | Required | Description |
|---|---|---|---|
| messageId | string | — | Unique ID assigned to the message. Use this to fetch message status or details. |
| campaignId | string | — | ID of the campaign this message belongs to. Returned when campaignName is provided. |
| destination | array | — | The recipient phone numbers the message was sent to. |
| sender | string | — | The Sender ID used for this message. |
| status | string | — | Current delivery status of the message. |
| createdAt | string | — | ISO 8601 timestamp of when the message was created. |
| updatedAt | string | — | ISO 8601 timestamp of the last status update. |
Estimate object
| Field | Type | Required | Description |
|---|---|---|---|
| available_balance | number | — | Your account balance after this request. |
| charge | number | — | Total units charged for this message. |
| encoding | string | — | Character encoding used (e.g. GSM7, UCS2). |
| message_length | number | — | Total character count of the message. |
| pages | number | — | Number of SMS parts this message is split into. |