Sends an SMS message with administrative privileges. Allows sending on behalf of a sub-account or specifying an LRA.
Before making requests, ensure you have configured authentication.
For the full technical reference, see the OpenAPI specification.
POST /api/Admin/send| Name | Required | Description |
|---|---|---|
Authorization | Yes | Basic Auth credentials. See Authentication. |
Content-Type | Yes | Must be application/json. |
| Parameter | Type | Required | Description |
|---|---|---|---|
destination | string | Yes | Destination phone number in E.164 format (e.g. +390000000000) |
text | string | Yes | Message text to send |
reference | object | No | Tracking reference. See Reference Attribute |
service | string | No | Service identifier (e.g. MY_SERVICE) |
action | string | No | Action within the service (e.g. 2FA, PASSWORD_RESET) |
key | string | No | Custom tracking key (e.g. user ID, order ID) |
account | string | No | Account username to send on behalf of (impersonation) |
lra | integer | No | Local Registration Authority (LRA) identifier |
detailed | boolean | No | Return detailed response including provider info (default: false) |
businessRelationId | string | No | One Platform Business Relation ID. Overrides default business relation settings |
webhook | object | No | Inline webhook configuration. See Webhook configuration |
attemptCount | integer | No | Deprecated — no longer required and has no effect |
{
"destination": "+390000000000",
"text": "Administrative message",
"reference": {
"service": "MY_SERVICE",
"action": "NOTIFICATION",
"key": "admin-task-123"
},
"account": "sub-account-name",
"lra": 1234,
"detailed": true
}200 — Message accepted
{
"message": "0: Accepted for delivery",
"provider": "PROVIDER1",
"id": "7b8ef313-f1f2-4c4f-bffa-438c287ba9d8"
}500 — Send error
{
"code": 8,
"message": "Wrong number",
"details": null
}| HTTP Status | Error code | Error type | Solution |
|---|---|---|---|
500 | 8 | Wrong destination number | Verify number format and country code |
500 | 56 | Invalid number | Check number validity with carrier |
500 | 59 | Invalid reference service | Use a valid service identifier |
500 | 60 | Message blocked by anti-flooding | Reduce sending rate |
500 | 61 | Message in watchlist | The destination number is blocked. Contact Namirial support if you believe this is an error |
500 | 64 | SMS provider not available | Retry or contact support |
500 | 66 | Invalid message text | Ensure the text field is not empty and does not exceed 1600 characters |
500 | 74 | Message containing URL is denied | Contact support to configure URL sending for your account |
500 | 76 | Account not found | Verify the account field contains a valid username |
Authentication failures return HTTP 401 with error code 63.
| Code | Description | Solution |
|---|---|---|
| 63 | Missing basic authentication header | Include Authorization: Basic base64(username:password) header |
| 63 | Username or password not valid | Verify credentials are correct and account is active |
{
"code": 63,
"message": "Username or password not valid",
"details": null
}See Authentication for setup instructions.
If your account does not have the required privileges, the API returns HTTP 403.
{
"code": 63,
"message": "User user_test not authorized for webmethod send",
"details": null
}See Authentication for more information.