Loading...
Use read endpoints to understand whether a project is currently functional and to inspect aggregate message counts for OTP and custom traffic.
Read the current delivery-readiness state for the project. This route tells you whether the project has an active linked device and can serve real sends.
1{2 "success": true,3 "data": {4 "functional": true5 }6}| Field | Meaning |
|---|---|
| functional | True when at least one linked device is active for the project. |
| Status | When | Codes |
|---|---|---|
| 200 | The project status summary was returned. | — |
| 401 | The API key header was missing or invalid. | API_KEY_MISSING, API_KEY_INVALID |
| 403 | The API key belongs to a project that is not active. | PROJECT_DISABLED |
Read aggregate OTP and custom SMS counters for the project. These values are grouped by traffic type so your analytics can separate challenge volume from custom message volume.
1{2 "success": true,3 "data": {4 "otp": { "processed": 120, "queued": 3, "failed": 2 },5 "custom": { "processed": 34, "queued": 1, "failed": 0 }6 }7}| Field | Meaning |
|---|---|
| otp.processed | OTP messages processed by the client device as sent. |
| otp.queued | OTP messages still queued and waiting for device processing. |
| otp.failed | OTP messages the client device failed to send, or queued items that timed out. |
| custom.processed | Custom SMS messages processed by the client device as sent. |
| custom.queued | Custom SMS messages still queued and waiting for device processing. |
| custom.failed | Custom SMS messages the client device failed to send, or queued items that timed out. |
| Status | When | Codes |
|---|---|---|
| 200 | The aggregate OTP and custom SMS counters were returned. | — |
| 401 | The API key header was missing or invalid. | API_KEY_MISSING, API_KEY_INVALID |
| 403 | The API key belongs to a project that is not active. | PROJECT_DISABLED |