Get SMS Delivery Status

Retrieve the delivery status of the sent SMS(s).

When sending SMS(s) using the MainBrainer SMS Send APIs, the APIs return a QueueId value that can then be used to retrieve the delivery status for the sent SMSs. Use this endpoint to retrieve the delivery status updates for an SMS sending QueueId. The response will include the following delivery statuses as per the latest status of the sent SMS:

  • Total
  • Submitted
  • Processed
  • Delivered
  • Failed
Request
Security:
Bearer
path Parameters
id
required
string <uuid>

The queueId value received as response from the endpoints SMS/Send Batch, SMS/Single send, and Predefined Template SMS Send.

Responses
200

Success

400

Bad Request

401

Unauthorized

409

Conflict

422

Client Error

500

Server Error

get/sms/{id}/status
Request samples
const fetch = require('node-fetch');

const id = 'YOUR_id_PARAMETER';
const resp = await fetch(
  `https://apisms.mainbrainer.com/sms/${id}/status`,
  {
    method: 'GET',
    headers: {
      Authorization: 'YOUR_API_KEY_HERE'
    }
  }
);

const data = await resp.text();
console.log(data);
Response samples
{
  • "Id": "string",
  • "Status": 0,
  • "StatusText": "string",
  • "StatusFailedReason": "string",
  • "Details": [
    • {
      • "Total": 0,
      • "Queued": 0,
      • "Submitted": 0,
      • "Delivered": 0,
      • "Failed": 0
      }
    ]
}