Skip to content
DEVELOPER DOCUMENTATION
/
/
/
Check service health

Namirial SMS Gateway API (27.1.0.4)

Send SMS messages worldwide with enterprise-grade reliability and delivery tracking.

Complete SMS Gateway Documentation
Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Production environment

https://sms.namirialtsp.com/

Pre-production staging environment (coming soon)

https://sms.preprod.namirialtsp.com/

Development and testing environment

https://sms.test.namirialtsp.com/

SmsServices

Send SMS messages using your account credentials.

Authentication: HTTP Basic Auth required

Operations

Check service health

Request

Health check endpoint to verify SMS Gateway availability.

Use case: Monitor service status before sending SMS or in health check routines.

Request: POST with empty body (no parameters required)

Response: HTTP 200 if service is operational

curl -i -X POST \
  https://sms.namirialtsp.com/api/Services/checkServiceStatus

Responses

Service is operational.

Bodyapplication/json
globalStatusbooleanrequired

Overall service availability.

dbStatusbooleanrequired

Database connectivity status.

servicesStatusbooleanrequired

Internal services availability.

errorMessagestring

Error message if any component is unavailable. Empty string when all systems are operational.

versionNumberstringrequired

Current API version.

Example: "27.1.0.2"
Response
application/json
{
  "globalStatus": true,
  "dbStatus": true,
  "servicesStatus": true,
  "errorMessage": "",
  "versionNumber": "27.1.0.2"
}

Send SMS message

Request

Send an SMS message to a destination phone number using your account credentials.

Use case: Standard SMS sending for your applications (2FA, notifications, alerts).

Delivery: Messages are queued and sent asynchronously. Use webhooks or Message Status API to track delivery.

Character limits:

  • GSM-7 encoding: 160 chars
  • UCS-2 encoding: 70 chars
Security
basicAuth
Bodyapplication/json

Send parameters

destinationstring^\+[1-9]\d{6,14}$required

Destination phone number in E.164 international format.

Format: +[country code][number] (e.g., +393401234567)

Example: "+390000000000"
textstring[ 1 .. 1600 ] charactersrequired

Message text to send.

Character limits:

  • GSM-7: 160 chars (single), 153 chars (multi-part)
  • UCS-2: 70 chars (single), 67 chars (multi-part)

Encoding: Automatically detected

Special characters: Emojis trigger UCS-2 (higher cost)

referenceobject(ReferenceService)

Tracking reference to correlate SMS with your business logic. If any field is specified, service is required.

detailedboolean

Return detailed response including provider name.

  • true: Response includes provider
  • false: Response without provider
Default false
businessRelationIdstring<= 255 characters

Business Relation Identifier for One Platform integration.

Overrides default business relation settings.

webhookobject
attemptCountinteger(int32)Deprecated

DEPRECATED: No longer used. Retry logic is handled automatically.

curl -i -X POST \
  -u <username>:<password> \
  https://sms.namirialtsp.com/api/Services/send \
  -H 'Content-Type: application/json' \
  -d '{
    "destination": "+390000000000",
    "text": "Your verification code is: 123456",
    "reference": {
      "service": "SPID",
      "action": "VERIFICATION",
      "key": "123123456456"
    },
    "businessRelationId": "123456789",
    "webhook": {
      "url": "https://example.com/webhook"
    },
    "detailed": false
  }'

Responses

SMS accepted for delivery.

Bodyapplication/json
idstringrequired

Unique message identifier (UUID). Use to query status via Message Status API.

messagestringrequired

Status message. Format: <code>: <description>. Code 0 = accepted.

providerstring or null

SMS provider used (only when detailed=true).

Response
application/json
{
  "id": "7b8ef313-f1f2-4c4f-bffa-438c287ba9d8",
  "message": "0: Accepted for delivery"
}

Get service status

Request

Get detailed service status information

curl -i -X GET \
  https://sms.namirialtsp.com/api/Services/status

Responses

Service is operational.

Bodyapplication/json
globalStatusbooleanrequired

Overall service availability.

dbStatusbooleanrequired

Database connectivity status.

servicesStatusbooleanrequired

Internal services availability.

errorMessagestring

Error message if any component is unavailable. Empty string when all systems are operational.

versionNumberstringrequired

Current API version.

Example: "27.1.0.2"
Response
application/json
{
  "globalStatus": true,
  "dbStatus": true,
  "servicesStatus": true,
  "errorMessage": "",
  "versionNumber": "27.1.0.2"
}

SmsAdmin

Send SMS with administrative privileges on behalf of other accounts.

Authentication: HTTP Basic Auth required

Operations