Consultar estado

La API permite consultar el estado actual de un mensaje determinado. Para esto se utiliza el id retornado al momento del envío del mensaje.

Antes de comenzar

Tenga disponible el id retornado por la solicitud de envío y la llave de API. Utilice el endpoint del canal que creó el mensaje.

Secuencia de consulta

1. Sustituya {id} en la URL de SMS o Email indicada a continuación.
2. Ejecute una solicitud GET con X-Api-Key.
3. Revise la respuesta HTTP y lea status.
4. Compruebe que el destinatario, la referencia y el grupo corresponden al mensaje que investiga.

Una consulta exitosa confirma la recuperación del registro, no la entrega del mensaje.

Solicitud para consultar el estado de un SMS

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

El {id} es el código de identificación del mensaje retornado en el envío.

Respuesta: 200 OK

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

Solicitud para consultar el estado de un email

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

Pruébalo en Postman

El {id} es el código de identificación del mensaje retornado en la solicitud de envío.

Respuesta: 200 OK

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

Si la consulta falla, consulte Respuestas de error. Para otros canales, utilice Actividades.