Documentación de la API TopMessage | Recuperar mensajes y verificar códigos

Obtener mensaje

Recupere detalles de los mensajes entrantes y salientes y verifique los códigos de autenticación enviados a sus clientes. Acceda a una lista de todos los mensajes o busque información sobre un mensaje específico utilizando el ID de mensaje único proporcionado cuando se creó o recibió.

Ejemplos de casos de uso

La verificación del usuario fue exitosa si el encabezado X-Total-Count tiene el valor 1 o la lista de objetos de datos en respuesta no está vacía.

Los siguientes son algunos ejemplos de casos de uso para la API TopMessage:

Accede a información detallada sobre todos tus mensajes enviados para monitorear la entrega, rastrear el rendimiento y optimizar tu estrategia de mensajería.

Parámetros de solicitud completos

No se requieren parámetros de solicitud.

Parámetros de respuesta completos

La respuesta incluye todos los parámetros de la solicitud, junto con los parámetros adicionales que se enumeran a continuación.

Nombre	Amable	Descripción
data	`object`	Contiene información del mensaje.

Data Object

Nombre	Amable	Descripción
id	`string`	Identificador único de su mensaje.
account_id	`string`	Identificador único de su cuenta.
status	`string`	Estado inicial de su mensaje. Valores posibles: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
from	`string`	Nombre de remitente desde el cual se enviará tu mensaje. Puedes ver los nombres disponibles o crear uno nuevo en la página de remitentes.
to	`string[]`	Número(s) de teléfono móvil del destinatario en formato internacional.
text	`string[]`	Su mensaje de texto se enviará a los destinatarios.
channel	`string`	El canal de comunicación envía su mensaje. Valores posibles: `SMS` y `WHATSAPP` Por defecto: `SMS`
segment_count	`integer`	El número de segmentos que componían su mensaje.
encoding	`string`	Codificación de su mensaje. Valores posibles: `STANDARD` y `UNICODE`
direction	`string`	Indica el flujo del mensaje: si fue enviado por su sistema o recibido de un usuario. Valores posibles: `OUTBOUND`, `INBOUND`
country	`string`	Especifica el país del destinatario para mensajes salientes y el país del remitente para mensajes entrantes. El valor se proporciona en formato ISO 3166-1 alpha-2.
type	`string`	Indica el tipo de contenido del mensaje enviado o recibido. Ayuda a identificar si es un texto plano, una plantilla o un mensaje multimedia (como imágenes o vídeos), incluido contenido interactivo para WhatsApp.
schedule	`string`	Especifica la hora en que se debe enviar el mensaje. La hora debe estar en UTC y seguir el formato ISO-8601 ("2024-12-01T18:00:00Z"). La hora programada no puede establecerse a más de 1 año en el futuro. Por defecto: Ahora
create_date	`string`	Hora en que se inició el mensaje
update_date	`string`	Fecha de la última actualización de estado de su mensaje.

GET

https://api.topmessage.es/v1/messages

X-TopMessage-Key: {API_KEY}
Content-Type: application/json

Muestra de respuesta

'X-Total-Count': 1

{
    "data": [
        {
            "id": "0f15fa5d-97ef-46d5-844a-f507f1c4c461",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "341511234567",
            "text": "¡Hola! Estoy probando esta genial función de SMS. https://topmessage.es",
            "channel": "SMS",
            "segment_count": "1",
            "encoding": "STANDARD",
            "direction": "OUTBOUND",
            "country": "ES",
            "type": "text",
            "schedule": "2024-11-10T08:11:46Z",
            "create_date": "2024-11-10T08:11:46Z",
            "update_date": "2024-11-10T08:11:46Z"
        },
        {
            "id": "6fc214dc-4e51-4fce-bc0a-324a1d8a542b",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "341511234568",
            "text": "Solo una prueba rápida de esta función de SMS.",
            "channel": "SMS",
            "segment_count": "1",
            "encoding": "STANDARD",
            "direction": "OUTBOUND",
            "country": "ES",
            "type": "text",
            "schedule": "2024-11-10T08:11:46Z",
            "create_date": "2024-11-10T08:11:46Z",
            "update_date": "2024-11-10T08:11:46Z"
        }
    ]
}