Notification API Documentation
These endpoints let you send internal mobile notifications and retrieve notification history from SMSMobileAPI. Notifications can be sent to a specific mobile device and then tracked through the list endpoint.
The notification/list endpoint returns notification sending time and distribution time in GMT, including full datetime strings and Unix timestamps.
Quickstart
Base URL
Examples
Authentication
Notification endpoints authenticate using the apikey parameter.
Common concepts
Target mobile
Notifications are sent to a specific mobile device using sid. The list endpoint can filter the same target using sidentifiant or sid.
Distributed status
- distribued=1 means the notification was distributed.
- distribued=0 means not distributed.
- distribued_status returns distributed or not_distributed.
Dates and timezones
- sent_* fields represent the notification send date/time in GMT.
- distributed_* fields represent the distribution date/time in GMT.
- *_at_unix fields are Unix timestamps.
List endpoint behavior
- The list endpoint always returns a maximum of 200 rows.
- Results are ordered from newest to oldest using send date/time.
- Date filters use dateAjout internally and are exposed as date_from / date_to.
Errors
| HTTP | Example error | Meaning |
|---|---|---|
| 400 | {"success":false,"message":"Missing required param: apikey."} | Missing or empty apikey. |
| 400 | {"success":false,"message":"Missing required params: apikey and sid are mandatory."} | Missing sid on notification/send. |
| 400 | {"success":false,"message":"Missing required param: message."} | Missing message on notification/send. |
| 400 | {"success":false,"message":"Invalid date_from format. Expected YYYY-MM-DD."} | Invalid date_from format on notification/list. |
| 400 | {"success":false,"message":"Invalid distribued value. Allowed values: 0 or 1."} | Invalid distribued filter value. |
| 500 | {"success":false,"message":"DB connection failed."} | Database connection problem. |
| 500 | {"success":false,"message":"Query failed: ..."} | SQL / execution error. |
Notification – Send
Create a new notification for a target mobile device.
Endpoint
Query / body parameters
| Parameter | Type | Description |
|---|---|---|
| apikey | string | Required Your API key. |
| sid | string | Required Target mobile sidentifiant. |
| title | string | Optional Notification title. Default: Notification. |
| message | string | Required Notification message content. |
| type | string | Optional Notification type. Default: notification. |
Example success response
{
"success": true,
"message": "Notification created.",
"id": 22087,
"apikey": "YOUR_API_KEY",
"sid": "508b004b4aadacc4"
}
Notification – List
Retrieve the latest notifications for an API key, with optional filtering.
Endpoint
Query parameters
| Parameter | Type | Description |
|---|---|---|
| apikey | string | Required Your API key. |
| sidentifiant | string | Optional Filter notifications by target mobile. |
| sid | string | Optional Alias of sidentifiant. |
| distribued | 0 | 1 | Optional 1 = distributed only, 0 = not distributed only. |
| date_from | YYYY-MM-DD | Optional Filter sent date from this day. |
| date_to | YYYY-MM-DD | Optional Filter sent date up to this day. |
Example success response
{
"success": true,
"message": "Notifications retrieved successfully.",
"filters": {
"sidentifiant": "508b004b4aadacc4",
"distribued": "1",
"date_from": "",
"date_to": "",
"limit": 200
},
"count": 1,
"data": [
{
"sidentifiant": "508b004b4aadacc4",
"title": "Notification",
"message": "vers miano",
"distribued": "1",
"distribued_status": "distributed",
"distributed_date_gmt": "2026-03-18",
"distributed_time_gmt": "10:18:30",
"distributed_at_gmt": "2026-03-18 10:18:30",
"distributed_at_unix": 1773829110,
"distributed_timezone": "GMT",
"sent_date_gmt": "2026-03-18",
"sent_time_gmt": "10:15:03",
"sent_at_gmt": "2026-03-18 10:15:03",
"sent_at_unix": 1773828903,
"sent_timezone": "GMT"
}
]
}
Send response fields
| Field | Type | Description |
|---|---|---|
| success | bool | Request status. |
| message | string | Human-readable result message. |
| id | int | Created notification ID in database. |
| apikey | string | Echoed API key. |
| sid | string | Target mobile sidentifiant used during creation. |
List response fields
| Field | Type | Description |
|---|---|---|
| success | bool | Request status. |
| message | string | Human-readable result message. |
| filters | object | Echoed filters used by the request. |
| count | int | Number of returned notifications. |
| data | array | List of notifications. |
| data[].sidentifiant | string | Target mobile identifier. |
| data[].title | string | Notification title. |
| data[].message | string | Notification message. |
| data[].distribued | string | Raw distributed flag. |
| data[].distribued_status | string | distributed or not_distributed. |
| data[].distributed_date_gmt | string | Distribution date in GMT. |
| data[].distributed_time_gmt | string | Distribution time in GMT. |
| data[].distributed_at_gmt | string | Full distribution datetime in GMT. |
| data[].distributed_at_unix | int|null | Distribution datetime as Unix timestamp. |
| data[].distributed_timezone | string | Always GMT. |
| data[].sent_date_gmt | string | Send date in GMT. |
| data[].sent_time_gmt | string | Send time in GMT. |
| data[].sent_at_gmt | string | Full send datetime in GMT. |
| data[].sent_at_unix | int|null | Send datetime as Unix timestamp. |
| data[].sent_timezone | string | Always GMT. |
