Check status¶

The API allows you to check the current status of a specific message. To do this, use the id returned when the message was sent.

Before you begin¶

Have the message id returned by the delivery request and the API key. Use the endpoint for the channel that created the message.

Query workflow¶

Replace {id} in the SMS or Email URL below.
Send a GET request with X-Api-Key.
Check the HTTP response and read status.
Match the recipient, reference, and group to the message you are investigating.

A successful query confirms that the record was retrieved, not that the message was delivered.

Request to check the status of an SMS¶

GET https://send.obmessage.ai/api/v1/sms/{id}
X-Api-Key: {{API_KEY}}

The {id} is the message identification code returned during delivery.

Response: 200 OK

{
    "id": "string",
    "phone": "string",
    "reference": "string",
    "group": "string",
    "status": "string",
    "created_at": "string"
}

Request to check the status of an email¶

GET https://send.obmessage.ai/api/v1/email/{id}
X-Api-Key: {{API_KEY}}

Try it in Postman

The {id} is the message identification code returned in the delivery request.

Response: 200 OK

{
    "id": "string",
    "to": "string",
    "subject": "string",
    "reference": "string",
    "group": "string",
    "status": "string",
    "created_at": "string"
}

If the query fails, see Error responses. For other channels, use Activities.