Relatórios de Status

Com os relatórios de status, você pode verificar o sucesso da entrega de um SMS e o respectivo momento. Existem basicamente duas opções: o método muito mais eficiente e rápido é um webhook diretamente para o seu servidor. Assim que um novo status estiver disponível, a URL desejada será chamada automaticamente. O método alternativo é consultar diretamente o status dos SMS através de uma solicitação à API. Se ainda não houver um status disponível, você pode precisar consultar novamente mais tarde. Por favor, use preferencialmente os webhooks. Ambas as variantes podem ser combinadas, por exemplo, caso o webhook falhe.

Fluxograma de SMS

Você receberá atualizações exclusivamente para relatórios de status que não são internos (Created, Queued, Processed), mas que foram enviados pela operadora de rede:

Relatório de Status	Explicação	Status Final
`DELIVERED`	O SMS foi entregue com sucesso.
`NOTDELIVERED`	O SMS não pôde ser entregue. Por favor, verifique o número do destinatário, se necessário.
`BUFFERED`	O SMS foi enviado com sucesso, mas foi armazenado temporariamente pelo SMSC, pois o destinatário está inacessível.
`TRANSMITTED`	O SMS foi enviado pelo SMSC e deve chegar em breve.
`ACCEPTED`	O SMS foi aceito pelo SMSC.
`EXPIRED`	O SMS não foi recebido antes do término do período de validade.
`REJECTED`	O SMS foi rejeitado pela operadora.
`FAILED`	Ocorreu um erro durante o envio.

Dependendo do operador de rede, diferentes relatórios de status podem ser enviados. A maioria dos operadores nunca envia um status BUFFERED. Tecnicamente, o status DELIVERED é um retorno direto do dispositivo final, no entanto, em algumas redes de destino, pode ocorrer o envio de relatórios de status incorretos. Infelizmente, não temos controle sobre isso.

Relatórios de status via Webhook

Idealmente, você deve assinar atualizações de um SMS via Webhook. Esta é a melhor e mais rápida maneira de receber os relatórios de status. Se isso não for possível por razões técnicas, por exemplo, porque você não tem um servidor publicamente acessível, você pode consultar os relatórios de status via API.

GET/api/statusObsoleto

Consultar relatórios de status

Consulte o status de um SMS. Esta consulta é possível no máximo 30 dias após o envio de um SMS. Por favor, note que esta API está obsoleta e pode ser desativada em breve. Em vez disso, use a consulta do log com o ID da mensagem como parâmetro.

Parâmetros

Name
msg_id
Type
string
Description
O ID do SMS cujo status você deseja consultar. Vários IDs podem ser especificados, separados por uma vírgula.

Requisição

GET

/api/status

curl -G https://gateway.seven.io/api/status \
    -H "X-Api-Key: IHR_API_SCHLÜSSEL" \
    -H "Accept: application/json"
    -d "msg_id=77232007287,77232007195"

Resposta

[
    {
        "id": "77232007287",
        "status": "DELIVERED",
        "status_time": "2024-02-16 15:43:16.905"
    },
    {
        "id": "77232007195",
        "status": "DELIVERED",
        "status_time": "2024-02-16 15:42:19.989"
    }
]