Atualizar status de entrega da mensagem

O método permite atualizar o status de entrega de uma mensagem específica.

🚧

Esteja ciente de que você não poderá executar esta etapa descrita acima diretamente na seção de Referência da API devido a limitações da ferramenta: não é possível calcular os cabeçalhos necessários e enviar uma solicitação simultaneamente.

Cabeçalhos e tipo de autorização

ParâmetroTipo de dadoDescrição
DatestringData e hora em que a solicitação foi gerada. A assinatura será válida por 15 minutos a partir dessa data. A data deve estar no formato “Thu, 01 Jan 2023 12:00:00 +0000” (RFC2822).
Content-typestringTipo de dados da solicitação. Atualmente, apenas application/json é suportado.
Content-MD5stringPara o corpo da solicitação, é necessário calcular o hash MD5 e indicá-lo no cabeçalho em letras minúsculas. Ao mesmo tempo, é importante lembrar que o corpo da solicitação é calculado como um fluxo de bytes, sem considerar o final da marcação JSON, e se houver “\n” ou espaços no final, eles também serão levados em conta.
X-SignaturestringAssinatura da solicitação como uma string. Ela é formada a partir do nome do método (GET/POST) em maiúsculas, com os valores dos cabeçalhos concatenados por “\n”. Os valores dos cabeçalhos são organizados em uma ordem específica. Se não houver cabeçalho, uma string vazia é especificada em seu lugar. Em seguida, adicione o caminho solicitado da URL sem o protocolo e o domínio (sem parâmetros GET) à string. A string resultante é calculada usando HMAC-SHA1 e, como segredo, utilizamos a chave secreta do canal obtida durante o registro. O hash resultante, em letras minúsculas, é indicado no cabeçalho X-Signature.
🚧

Você deve escrever o corpo da solicitação exatamente como foi escrito ao calcular os cabeçalhos.

Status da mensagem

StatusQuando o status deve ser usadoValor de status do enum.
SentA mensagem foi enviada da Kommo-
DeliveredA mensagem foi entregue ao destino1
ReadMensagem foi lida pelo destinatário2
ErrorMensagem não foi entregue-1

Códigos de erro

Código do erroQuando o código deve ser enviado?
901O usuário excluiu a mensagem
902Integração desativada no lado do canal
903Erro interno do servidor
904Não foi possível criar uma conversa (por exemplo, o usuário não está registrado no WhatsApp)
905Qualquer outro erro (você deve enviar o texto do erro)

Cabeçalho de tipo de dado quando a solicitação é bem-sucedida ou em caso de erro
Content-Type: application/hal+json

Exemplos de corpo da solicitação

Alterar status de entrega da mensagem para Lida

{
    "msgid": "XXXXXX-2aa3-464c-b6e4-4386d0f8f3ca",
    "delivery_status": 2
}

Alterar status de entrega da mensagem para Erro

{
    "msgid": "3419eef6-2aa3-464c-b6e4-4386d0f8f3ca",
    "delivery_status": -1,
    "error_code": 905,
    "error": "Ocorreu um erro desconhecido!"
}
Language