GetSentMessage

This article explains how to obtain information about the messages sent from a particular process via the Unico Check REST API.

How to use it?

Make a GET request to the /messages/sent/{processoId} endpoint

With a valid Access token, make a request to the endpoint (GET/messages/sent/{processoId}).

Parameters:

• HEADER PARAMETERS

Name	Type	Mandatory/Optional	Description
APIKEY	String	Mandatory	API key
Authorization	String	Mandatory	Access token

• PATH PARAMETERS

Name	Type	Mandatory/Optional	Description
processoId	String	Mandatory	Process number

Successful request

If the request was executed successfully, the return response is a JSON containing the following parameters:

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

The return parameters are:

Name	Type	Description
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.

Request error

If an error occurs, the return response is a JSON containing the error code and description:

{
    "Error": {
        "code": "40004",
        "description": "Error description"
    }
}

For more information on the errors returned, see the list available in the article Response Errors.

Any concerns?

Missing something or still need help? If you are already a customer or partner, you can contact us through the Help Center.