Buscar informações do envio

Observação

Se estiver procurando a versão antiga com chaves de criptografia, veja Buscar informações do envio V2

Quando o envio de notificações é feito com ReturnMode em RESUME, a resposta será um RequestID que poderá ser utilizado para buscar os dados das notificações

Esse serviço irá retornar informações sobre o número de notificações enviadas, processadas e que ainda estão processando

JSON Body

{
  "hash": "COMPANY_HASH",
  "sentId": 00
}

• hash: Hash da empresa onde o template está registrado
• sentId: O ID que foi retornado ao enviar as notificações com ReturnMode = RESUME

Resposta

• A resposta é uma string encriptada da seguinte forma:
  • DadosEncriptados + IV + NovoIvEncriptado
• A estrutura desencriptada será a seguinte:

  {
    "RequestId": 1,
    "RequestDate": "2023-06-05T16:00:00",
    "RequestStatus": "PROCESSED",
    "TotalNumberReceived": 4,
    "TotalNumberValid": 4,
    "TotalNumberSuccess": 4,
    "TotalNumberError": 0,
    "TotalNumberWaiting": 0,
    "TotalNumberCanceled": 0,
    "RequestResult": [
      {
        "RequestSeq": 1,
        "RequestPhoneNumber": "111111111",
        "RequestStatus": "sent",
        "RequestMessage": "OK",
        "RequestSentDatetime": "2024-08-05T16:00:00",
        "RequestDeliveryDatetime": "2024-08-05T16:00:00",
        "RequestReadDatetime": "2024-08-05T16:00:00",
        "RequestHasButton": true,
        "RequestUserAnswered": true,
        "RequestUserAnswer": "Sim",
        "SentKeys": [
          {
            "Description": "NOME",
            "Value": "Giuliano"
          }
        ],
        "SentParms": [
          {
            "Cod": "CPF",
            "Value": "11111111111"
          },
          {
            "Cod": "RG",
            "Value": "11111111-1"
          }
        ]
      },
      {
        "RequestSeq": 1,
        "RequestPhoneNumber": "222222222",
        "RequestStatus": "sent",
        "RequestMessage": "OK",
        "RequestSentDatetime": "2024-08-05T16:00:00",
        "RequestDeliveryDatetime": "2024-08-05T16:00:00",
        "RequestReadDatetime": "2024-08-05T16:00:00",
        "RequestHasButton": true,
        "RequestUserAnswered": true,
        "RequestUserAnswer": "Sim",
        "SentKeys": [
          {
            "Description": "NOME",
            "Value": "Giuliano"
          }
        ],
        "SentParms": [
          {
            "Cod": "CPF",
            "Value": "11111111111"
          },
          {
            "Cod": "RG",
            "Value": "11111111-1"
          }
        ]
      },
      {
        "RequestSeq": 2,
        "RequestPhoneNumber": "333333333",
        "RequestStatus": "sent",
        "RequestMessage": "OK",
        "RequestSentDatetime": "2024-08-05T16:00:00",
        "RequestDeliveryDatetime": "2024-08-05T16:00:00",
        "RequestReadDatetime": "2024-08-05T16:00:00",
        "RequestHasButton": true,
        "RequestUserAnswered": true,
        "RequestUserAnswer": "Sim",
        "SentKeys": [
          {
            "Description": "NOME",
            "Value": "Giuliano"
          }
        ],
        "SentParms": [
          {
            "Cod": "CPF",
            "Value": "11111111111"
          },
          {
            "Cod": "RG",
            "Value": "11111111-1"
          }
        ]
      },
      {
        "RequestSeq": 2,
        "RequestPhoneNumber": "444444444",
        "RequestStatus": "sent",
        "RequestMessage": "OK",
        "RequestSentDatetime": "2024-08-05T16:00:00",
        "RequestDeliveryDatetime": "2024-08-05T16:00:00",
        "RequestReadDatetime": "2024-08-05T16:00:00",
        "RequestHasButton": true,
        "RequestUserAnswered": true,
        "RequestUserAnswer": "Sim",
        "SentKeys": [
          {
            "Description": "NOME",
            "Value": "Giuliano"
          }
        ],
        "SentParms": [
          {
            "Cod": "CPF",
            "Value": "11111111111"
          },
          {
            "Cod": "RG",
            "Value": "11111111-1"
          }
        ]
      }
    ]
  }

• Valores para o RequestStatus base:
  • CANCELED
  • QUEUED
  • PROCESSED
  • PROCESSING
• Valores para o status de RequestResult:
  • canceled
  • waiting
  • sent
  • delivered
  • failed

Exemplos

C#/.NET

Dica

Para aplicações .NET Framework e .NET, um pacote AnnA.Services está disponível em: https://www.nuget.org/packages/AnnA.Services

  var httpClient = new HttpClient
  {
    BaseAddress = new Uri("YOUR_ANNA_URL")
  };

  var result = await httpClient.PostAsJsonAsync("REST/Credentials/GetToken", new
  {
    hash = "COMPANY_HASH",
    user = "USER",
    pass = "PASSWORD"
  });

  var tokenResponse = await result.Content.ReadFromJsonAsync<GetTokenResponse>();

  httpClient.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", tokenResponse?.Data.Token);

  var getDataResult = await httpClient.PostAsJsonAsync("REST/Notifications/GetData", new
  {
    hash = "COMPANY_HASH",
    sentId = 00
  });

  var getDataContent = await getDataResult.Content.ReadAsStringAsync();

  return getDataContent;

  public class GetTokenResponse
  {
    [JsonPropertyName("success")]
    public bool Success { get; set; }

    [JsonPropertyName("message")]
    public string Message { get; set; } = string.Empty;

    [JsonPropertyName("data")]
    public TokenData Data { get; set; } = new();
  }

  public class TokenData
  {
    [JsonPropertyName("Token")]
    public string Token { get; set; } = string.Empty;

    [JsonPropertyName("ExpiresIn")]
    public string ExpiresIn { get; set; } = string.Empty;
  }

Java

  public class Main {
    public static void main(String[] args) throws IOException, InterruptedException {
      var httpClient = HttpClient.newHttpClient();
      Gson gson = new Gson();

      String environmentUri = "YOUR_ANNA_URL";

      var credentials = new HashMap<String,String>();
      credentials.put("hash", "COMPANY_HASH");
      credentials.put("user", "USER");
      credentials.put("pass", "PASSWORD");

      var credentialsJson = gson.toJson(credentials);

      var httpRequest = HttpRequest.newBuilder()
              .uri(URI.create(environmentUri + "REST/Credentials/GetToken"))
              .header("Content-Type", "application/json")
              .POST(HttpRequest.BodyPublishers.ofString(credentialsJson))
              .build();

      var credentialsResponse = httpClient.send(httpRequest, HttpResponse.BodyHandlers.ofString());

      var tokenObj = gson.fromJson(credentialsResponse.body(), GetTokenResponse.class);

      var getDataRequestBody = new HashMap<String, Object>();
      getDataRequestBody.put("hash", "COMPANYHASH");
      getDataRequestBody.put("sentId", 00);

      var getDataRequestBodyJson = gson.toJson(getDataRequestBody);

      var getDataRequest = HttpRequest.newBuilder()
              .uri(URI.create(environmentUri + "REST/Notifications/GetData"))
              .setHeader("Content-Type", "application/json")
              .setHeader("Authorization", "Bearer "+tokenObj.data.get("Token"))
              .POST(HttpRequest.BodyPublishers.ofString(getDataRequestBodyJson))
              .build();


      var getDataResponse = httpClient.send(getDataRequest, HttpResponse.BodyHandlers.ofString());

      System.out.println(getDataResponse.body());
    }
  }

  class GetTokenResponse {
    public String success;
    public String message;
    public HashMap<String,Object> data;
  }