Libro de registro

El punto final de la API para consultar registros proporciona una interfaz directa para obtener información sobre los mensajes enviados y recibidos. Este punto final es esencial para monitorear la comunicación de mensajes o para detectar errores de transmisión. Ofrece los datos necesarios para analizar de manera transparente el procesamiento y el intercambio de mensajes dentro de la aplicación.

Puede restringir la búsqueda mediante parámetros para obtener exactamente los datos que necesita. De forma predeterminada, cada uno de los puntos finales mencionados a continuación devuelve hasta 100 entradas. Puede paginar sus registros con offset y limit (máx. 100 por consulta) o con show_page e items (máx. 10000 por consulta).

Todos los valores de tiempo (timestamp, dlr_timestamp) se devuelven en hora local alemana (zona horaria Europe/Berlin, CET/CEST) sin desplazamiento UTC. Los parámetros date_from y date_to también se refieren a esta zona horaria.

Parámetros opcionales

Name
id
Type
integer
Description
El ID del mensaje.
Name
date_from
Type
timestamp
Description
Fecha de inicio desde la cual buscar en el formato AAAA-MM-DD 2020-01-01.
Name
date_to
Type
timestamp
Description
Fecha de finalización hasta la cual buscar en el formato AAAA-MM-DD 2020-05-30.
Name
state
Type
string
Description
Estado del mensaje. Esto podría ser, por ejemplo, completed / failed en Voice o DELIVERED / NOTDELIVERED etc. en SMS. No disponible para mensajes recibidos.
Name
to
Type
string
Description
Número de teléfono del destinatario en cualquier formato.
Name
limit
Type
integer
Description
Limita el número de entradas a devolver. Debe ser un número entero entre 1-100.
Name
offset
Type
integer
Description
Punto de inicio desde el cual se deben consultar las entradas.
Name
show_page
Type
integer
Description
Página a consultar, empezando por 1. Se ignora si se establece offset.
Name
items
Type
integer
Description
Número de entradas por página al usar show_page. Debe ser un número entero entre 1-10000. Se ignora si se establece offset.

GET

Mensajes enviados

A través de este punto final, puede consultar las últimas entradas de sus registros. De forma predeterminada, recibirá hasta 100 entradas por consulta.

Solicitud

GET

/api/journal/outbound

curl -G "https://gateway.seven.io/api/journal/outbound" \
  -H "X-Api-Key: SU_CLAVE_API"

Respuesta

[
  {
    "id": "77231715575",
    "to": "49176123456789",
    "from": "sender",
    "text": "Hello World",
    "timestamp": "2024-02-13 05:50:58.802",
    "price": "0.0750",
    "dlr": "DELIVERED",
    "dlr_timestamp": "2024-02-13 05:51:13.185",
    "mccmnc": "26207",
    "latency": "14.3830",
    "type": "direct",
    "channel": "RCS",
    "connection": "http",
    "label": null,
    "foreign_id": null
  },
  {
    "id": "77231715551"
    // ...
  }
]

GET

Mensajes recibidos

A través de este punto final, puede consultar los mensajes recibidos, p. ej. SMS y WhatsApp. De forma predeterminada, recibirá hasta 100 entradas por consulta.

Solicitud

GET

/api/journal/inbound

curl -G "https://gateway.seven.io/api/journal/inbound" \
  -H "X-Api-Key: SU_CLAVE_API"

Respuesta

[
  {
    "id": "4603396",
    "from": "49176123456789",
    "to": "49151123456789",
    "text": "Awesome! Your message was received.",
    "timestamp": "2025-01-16 12:53:17",
    "reply_to_message_id": "77258554687",
    "price": 0
  },
  {
    "id": "1865514",
    "from": "49176123456789",
    "to": "49151123456789",
    "text": "Your Code is: 1035. Don't share it with anyone.",
    "timestamp": "2024-03-03 00:17:02",
    "reply_to_message_id": null,
    "price": 0.01
  },
  {
    // ...
  }
]

GET

Mensajes de voz

A través de este punto final, puede consultar las últimas entradas de sus registros. De forma predeterminada, recibirá hasta 100 entradas por consulta.

Solicitud

GET

/api/journal/voice

curl -G "https://gateway.seven.io/api/journal/voice" \
  -H "X-Api-Key: SU_CLAVE_API"

Respuesta

[
  {
    "id": "1429729",
    "from": "49157123456789",
    "to": "49176123456789",
    "xml": false,
    "text": "Hallo, Ihr Authentifizierungscode lautet: 1 2 3 4 5 6.",
    "duration": "17",
    "status": "completed",
    "error": null,
    "timestamp": "2024-03-01 14:20:03",
    "price": "0.045"
  },
  {
    "id": "1429671"
    // ...
  }
]