API

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

Recuperar lista de mensajes
Recuperar un mensaje específico
Verificar código

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.

Parámetros de solicitud completos

No se requieren parámetros de solicitud.

Parámetros de respuesta completos

Parámetros de respuesta

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 los siguientes detalles del mensaje que se envía.

Objeto de datos

Nombre	Amable	Descripción
account_id	`string`	Identificador único de su cuenta.
id	`string`	Identificador único de su mensaje.
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.Ir a la página de remitentes.
to	`string[]`	Número(s) de teléfono móvil del destinatario en formato internacional.
status	`string`	Estado inicial de su mensaje. Valores posibles: `PENDING`, `FAILED`, `DELIVERED`, `SEEN`
channel	`string`	El canal de comunicación envía su mensaje. Valores posibles: `SMS` y `WHATSAPP` Por defecto: `SMS`
text	`string`	Su mensaje de texto se enviará a los destinatarios.
template_id	`string`	Identificador único de tu plantilla enviada. Puedes ver las plantillas disponibles o crear una nueva desde tu cuenta en la página de plantillas.Ir a la página de plantillas.
parameters	`string[]`	Estos valores se utilizan para reemplazar los marcadores de posición en su plantilla de mensaje, lo que le permite personalizar el mensaje para cada destinatario. Por defecto: Vacío
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`
country	`string`	País de destino del destinatario del mensaje.
direction	`string`	Especifica si el sistema recibe el mensaje o si este lo envía al destinatario. Valores posibles: `OUTBOUND`, `INBOUND`
type	`string`	Determina la estructura del contenido del mensaje. Valores posibles: `TEXT`, `TEMPLATE`
create_date	`string`	Hora en que se inició el mensaje
update_date	`string`	Fecha de la última actualización de estado de su mensaje.
code	`string`	Código proporcionado por el usuario, de 4 a 6 dígitos
expired	`boolean`	Indica si el código ha expirado. Valores posibles: `TRUE`, `FALSE` Por defecto: `FALSE`

Recuperar lista de mensajes

GET

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

Recuperar un mensaje específico

GET

https://api.topmessage.es/v1/messages/{Id}

Verificar código

GET

https://api.topmessage.es/v1/messages?to={receipnet_number}&code={code}&expired=false

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

Muestra de respuesta

'X-Total-Count': 1

{
    "data": [
        {
            "id": "b63ddae0-48c4-4e81-879c-2170a05051ca",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "from": "19134216816",
            "to": "48727516980",
            "channel": "SMS",
            "status": "DELIVERED",
            "text": "Hi there! Just testing out this cool SMS feature. https://topmessage.com",
            "segment_count": 1,
            "direction": "OUTBOUND",
            "country": "US",
            "type": "TEXT",
            "template": {
                "id": "67d0c347-d946-49ed-958f-3de966278525"
            },
            "schedule": "2024-11-20T08:11:46Z",
            "create_date": "2024-11-25T08:35:13Z",
            "update_date": "2024-11-25T08:35:14Z"
        }
    ]
}