Documentación de la API TopMessage

Autenticación

Al realizar solicitudes de API, debe incluir su clave API en el encabezado HTTP. El formato del encabezado debería verse así:

X-TopMessage-Key: {API_KEY}

Administre sus claves API

aquí

Enviar mensajes

Envíe fácilmente uno o más mensajes a sus clientes a través de sus canales preferidos, como SMS y WhatsApp, utilizando una única API unificada. Comience con un simple mensaje de texto definiendo el destino y el contenido, o aproveche las funciones avanzadas para mejorar su estrategia de comunicación.

Ejemplos de casos de uso

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

Envía un único mensaje SMS, perfecto para comunicaciones directas uno a uno, como alertas o confirmaciones.

Parámetros de solicitud completos

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

Data Object

Nombre	Amable	Descripción
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 TopMessage
to	`string[]`	Número(s) de teléfono móvil del destinatario en formato internacional. 341511234567
text	`string`	Su mensaje de texto se enviará a los destinatarios. 🎉 Éxito. Su prueba con la API de TopMessage se envió correctamente.

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. Ir a 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.

POST

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

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

Solicitar muestra

Payload

cURL

Java

Python

PHP

Node.js

{
    "data": {
        "from": "TopMessage",
        "to": [
            "341511234567"
        ],
        "text": "🎉 Éxito. Su prueba con la API de TopMessage se envió correctamente."
    }
}

Muestra de respuesta

{
    "data": [
        {
            "id": "0f15fa5d-97ef-46d5-844a-f507f1c4c461",
            "account_id": "0d1f7f1c-27df-41bf-8bdc-5666608a4285",
            "status": "PENDING",
            "from": "TopMessage",
            "to": "341511234567",
            "text": "🎉 Éxito. Su prueba con la API de TopMessage se envió correctamente.",
            "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"
        }
    ]
}