Obter informações sobre as mensagens enviadas

Este artigo explica como obter informações sobre as mensagens enviadas de um determinado processo através da REST API do Unico Check.

Como usar?

Faça uma requisição GET para o endpoint /messages/sent/{processoId}

Com o token de acesso válido, faça uma requisição para o endpoint (GET/messages/sent/{processoId}).

Parametros:

• HEADER PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
APIKEY	String	Mandatório	API key
Authorization	String	Mandatório	Token de acesso

• PATH PARAMETERS

Nome	Tipo	Mandatorio/Opcional	Descrição
processoId	String	Mandatório	Numero do processo

Requisição com Sucesso

Se a requisição foi executada com sucesso, a resposta de retorno é um JSON contendo os seguintes parâmetros:

{
  "Id": "11111111-1111-1111-1111-111111111111",
  "MessageList": [
    {
      "SentStatus": 1,
      "SentDate": "/Date(1586833200000-0300)/",
      "DeliveredStatus": 4,
      "DeliveredDate": "/Date(1586812095000-0300)/"
    },
    {
      "SentStatus": 2,
      "SentDate": "/Date(1586833200000-0300)/",
      "DeliveredStatus": 4,
      "DeliveredDate": null
    }
  ]
}

Os parâmetros de retorno são:

Nome	Tipo	Descrição
Id	string	Indica o ID do processo criado com o envio da foto. Ele é utilizado nos outros métodos de 'Processes'
MessageList.SentStatus	integer	Indica o status de entrega na operadora
MessageList.SentDate	datetime	Indica a data que a mensagem foi enviada.
MessageList.DeliveredStatus	integer	Indica o status de entrega no aparelho.
MessageList.DeliveredDate	datetime	Indica a Data que a mensagem foi recebida.

Erro na Requisição

Caso ocorra algum erro, a resposta de retorno é um JSON contendo o código e descrição do erro:

{
    "Error": {
        "code": "40004",
        "description": "Descrição do erro"
    }
}

Para mais infomações sobre os erros retornados, consulte a lista disponível no artigo Response Errors.

Dúvidas?

Não encontrou algo ou ainda precisa de ajuda? Se já é um cliente ou parceiro, pode entrar em contato através da Central de Ajuda.