# Message status API

API for querying SMS statistics and message details

Version: 3.1.2.1

## Servers

Production environment
```
https://sms-apistatus.namirialtsp.com/api
```

Pre-release staging environment
```
https://sms-apistatus.preprod.namirialtsp.com/api
```

Development and testing environment
```
https://sms-apistatus.test.namirialtsp.com/api
```

## Security

### ApiKeyAuth

HTTP API Key authentication using account credentials.

**Format**: `X-Api-Key: YOUR_API_KEY`

**How to obtain credentials**:
1. Contact Namirial support to create a Message Status API account
2. Receive API key via secure channel
3. Test credentials in TEST environment first

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

Type: apiKey
In: header
Name: X-Api-Key

## Download OpenAPI description

[Message status API](https://docs.namirial.app/_bundle/products/sms/openapi-api-status.yaml)

## MessageStatus

Retrieve delivery status and statistics for SMS messages.

**Authentication**: API Key required (`X-Api-Key` header)

### Get latest SMS from phone number

 - [GET /messagestatus/phonenumber/{phonenumber}](https://docs.namirial.app/products/sms/openapi-api-status/messagestatus/getlatestsmsfromnumber.md): Retrieves the delivery status of the latest messages sent to a given phone number.

### Get latest SMS from reference key

 - [GET /messagestatus/reference/{referencekey}](https://docs.namirial.app/products/sms/openapi-api-status/messagestatus/getlatestsmsfromreferencekey.md): Retrieves the delivery status of the latest messages associated with the external key specified in the reference.key parameter of the send API.

### Get SMS details from message ID

 - [GET /messagestatus/{messageid}](https://docs.namirial.app/products/sms/openapi-api-status/messagestatus/getsmsdetailfrommessageid.md): Retrieves the delivery status for a specific message.