Diário de Bordo

O endpoint da API para consulta de registros fornece uma interface direta para obter insights sobre mensagens enviadas e recebidas. Este endpoint é essencial para monitorar a comunicação de mensagens ou para identificar erros de transmissão. Ele oferece os dados necessários para analisar de forma transparente o processamento e a troca de mensagens dentro do aplicativo.

Você pode restringir a pesquisa por meio de parâmetros para obter exatamente os dados que precisa. Cada um dos endpoints mencionados abaixo retorna no máximo 100 entradas. Através dos parâmetros offset e limit, você pode consultar páginas mais profundas dos seus registros.

Parâmetros Opcionais

  • Name
    id
    Type
    integer
    Description

    O ID da mensagem.

  • Name
    date_from
    Type
    timestamp
    Description

    Data de início a partir da qual deve ser pesquisado no formato AAAA-MM-DD 2020-01-01.

  • Name
    date_to
    Type
    timestamp
    Description

    Data de término até a qual deve ser pesquisado no formato AAAA-MM-DD 2020-05-30.

  • Name
    state
    Type
    string
    Description

    Status da mensagem. Isso pode ser, por exemplo, completed / failed em Voice ou DELIVERED / NOTDELIVERED etc. em SMS.

  • Name
    to
    Type
    string
    Description

    Número de telefone do destinatário em qualquer formato.

  • Name
    limit
    Type
    integer
    Description

    Limita o número de entradas a serem retornadas. Deve ser um número inteiro entre 1-100.

  • Name
    offset
    Type
    integer
    Description

    Ponto de início a partir do qual as entradas devem ser consultadas.

GET

Mensagens Enviadas

Através deste endpoint, você pode consultar as últimas entradas dos seus registros. Você receberá no máximo 100 entradas a cada consulta.

Anfrage

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

Antwort

[
  {
    "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:50:63.102",
    "mccmnc": "26207",
    "latency": "14.3830",
    "type": "direct",
    "channel": "RCS",
    "connection": "http",
    "label": null,
    "foreign_id": null
  },
  {
    "id": "77231715551"
    // ...
  }
]
GET

SMS Recebidas

Por meio deste endpoint, você pode consultar as SMS recebidas. Você receberá no máximo 100 entradas a cada consulta.

Anfrage

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

Antwort

[
  {
    "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": null
  },
  {
    "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

Mensagens de Voz

Por meio deste endpoint, você pode consultar as últimas entradas dos seus registros. Você receberá no máximo 100 entradas a cada consulta.

Anfrage

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

Antwort

[
  {
    "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"
    // ...
  }
]