# Namirial SMS Gateway API

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

Version: 27.1.0.4

## 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
```

## Security

### basicAuth

HTTP Basic Authentication using account credentials.

**Format**: `Authorization: Basic base64(username:password)`

**How to obtain credentials**:
1. Contact Namirial support to create an SMS account
2. Receive username and password via secure channel
3. Test credentials in TEST environment first

See [Authentication documentation](https://docs.namirial.app/products/sms/enterprise-documentation/developer-documentation/authentication) for details.

Type: http
Scheme: basic

## Download OpenAPI description

[Namirial SMS Gateway API](https://docs.namirial.app/_bundle/products/sms/openapi.yaml)

## SmsServices

Send SMS messages using your account credentials.

**Authentication**: HTTP Basic Auth required

### Check service health

 - [POST /api/Services/checkServiceStatus](https://docs.namirial.app/products/sms/openapi/smsservices/checkservicestatus.md): 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

### Send SMS message

 - [POST /api/Services/send](https://docs.namirial.app/products/sms/openapi/smsservices/sendsms.md): 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

### Get service status

 - [GET /api/Services/status](https://docs.namirial.app/products/sms/openapi/smsservices/getservicesstatus.md): Get detailed service status information

## SmsAdmin

Send SMS with administrative privileges on behalf of other accounts.

**Authentication**: HTTP Basic Auth required

### Check service health (admin)

 - [POST /api/Admin/checkServiceStatus](https://docs.namirial.app/products/sms/openapi/smsadmin/admincheckservicestatus.md): Admin health check endpoint

### Send SMS with admin privileges

 - [POST /api/Admin/send](https://docs.namirial.app/products/sms/openapi/smsadmin/adminsendsms.md): Send an SMS message on behalf of another account using admin credentials.

Use case: Send SMS for other accounts without their credentials

Additional parameters: account and lra (Local Registration Authority)

### Get admin service status

 - [GET /api/Admin/status](https://docs.namirial.app/products/sms/openapi/smsadmin/getadminstatus.md): Get detailed admin service status information