Consultar Mensagens Recebidas pela Mensagem Enviada

Instruções para consulta de Mensagens Recebidas pela Mensagem Enviada

Importante:

As consultas possuem limite de 1 requisição a cada 30 segundos por endereço IP. Requisições além deste limite são respondidas com o código de status HTTP 429.

Replys by Message

GET https://message.uniqmobile.com.br/api/sms/replys-by-message/{MessageId}

Este endpoint permite que sejam consultadas todas as mensagens recebidas referentes à mensagem especificada.

Query Parameters

Name

Type

Description

MessageId

number

Id da mensagem em questão

Headers

Name

Type

Description

Authentication

string

api-key para autenticação

{
    "Success": true,
    "Object": {
        "Report": [
            {
                "ReceivedDate": "2021-04-01T21:18:00",
                "SMSId": 123545
                "MessageReceived": "Conforme solicitado, essa e a resposta",
                "MessageSent": "Poderia me responder?",
                "MessageId": 72,
                "Number": "5598999999999", 
            }
        ]
    },
    "Message": "Relatório obtido com sucesso"
}

{
    "Success": true,
    "Object": {
        "Report": [
            {
                "ReceivedDate": "2021-04-01T21:18:00",
                "SMSId": 123545
                "MessageReceived": "Conforme solicitado, essa e a resposta",
                "MessageSent": "Poderia me responder?",
                "MessageId": 72,
                "Number": "5598999999999",   
            },
            {
                "ReceivedDate": "2021-04-01T23:05:00",
                "SMSId": 123546
                "MessageReceived": "Oi, esta e a minha resposta",
                "MessageSent": "Ola, pode me responder?",
                "MessageId": 72,
                "Number": "5598900000000",   
            }
        ]
    },
    "Message": "Relatório obtido com sucesso"
}

Exemplos

curl --request GET \
    --url https://message.uniqmobile.com.br/api/sms/replys-by-message/?messageId=72 \
    --header 'api-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \

import requests
from requests.structures import CaseInsensitiveDict

url = "https://message.uniqmobile.com.br/api/sms/replys-by-message"

headers = CaseInsensitiveDict()
headers["api-key"] = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
headers["Content-Type"] = "application/json"

querystring = {"MessageId":XXXX}

resp = requests.get(url, headers=headers, params=querystring)

print(resp.status_code)
print(resp.text)

using System;
using System.IO;
using System.Net;

class MainClass {
  public static void Main (string[] args) {
    var MessageId = XXX;

    var url = $"https://message.uniqmobile.com.br/api/sms/replys-by-message/?MessageId={MessageId}";

    var httpRequest = (HttpWebRequest)WebRequest.Create(url);
    httpRequest.Method = "GET";

    httpRequest.Headers["api-key"] = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX";
    httpRequest.ContentType = "application/json";


    var httpResponse = (HttpWebResponse)httpRequest.GetResponse();
    using (var streamReader = new StreamReader(httpResponse.GetResponseStream()))
    {
      var result = streamReader.ReadToEnd();
      Console.WriteLine(httpResponse.StatusCode);
      Console.WriteLine(result);
    }
  }
}

var messageId = XXX

var url = `https://message.uniqmobile.com.br/api/sms/replys-by-message/?MessageId=${messageId}`;

var xhr = new XMLHttpRequest();
xhr.open("GET", url);

xhr.setRequestHeader("api-key", "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.onreadystatechange = function () {
    if (xhr.readyState === 4) {
        console.log(xhr.status);
        console.log(xhr.responseText);
    }
};

xhr.send();

<?php

$messageId = XXX;
$url = "https://message.uniqmobile.com.br/api/sms/replys-by-message/?MessageId={$messageId}";

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);

$headers = array(
   "api-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
   "Content-Type: application/json",
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);

$resp = curl_exec($curl);
$statuscode = curl_getinfo($curl)["http_code"];
curl_close($curl);

var_dump($statuscode);
var_dump($resp);

?>

const https = require('https')

const messageId = XXX

const options = {
  hostname: 'message.uniqmobile.com.br',
  path: `/api/sms/replys-by-message/${messageId}`,
  method: 'GET',
  headers: {
    'Content-Type': 'application/json',
    'api-key' : 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
  }
}

const req = https.request(options, res => {
  console.log(`statusCode: ${res.statusCode}`)

  res.on('data', d => {
    process.stdout.write(d)
  })
})

req.on('error', error => {
  console.error(error)
})

req.end()

Campos de Retorno

Campos

Descrição

Success

Retorna TRUE se a requisição foi finalizada com sucesso ou FALSE se houve falhas

Object

Campo com os resultados da requisição

ReceivedDate

Data em que a mensagem foi respondida pelo destinatário

SMSId

Id do SMS que foi respondido

MessageReceived

Mensagem respondida pelo destinatário

Number

Numero que respondeu o SMS

MessageSent

Mensagem enviada ao destinatário

MessageId

ID da mensagem enviada

Message

Mensagem com mais detalhes sobre a requisição‌‌‌

‌

‌‌

Possíveis Retornos

HTTP Status

Mensagem

200

Relatório obtido com sucesso

401

Erro de Autenticação com a Api-key

401

Usuário Inativo

401

Usuário Não Encontrado

400

Insira um Id de Mensagem válido

429

Muitas Requisições Realizadas

500

Erro do servidor

503

Sistema está indisponível no momento

504

Houve um time out na requisição ao efetuar a conexão com o endpoint.

PreviousConsultar Mensagens Recebidas por Período NextConsultar Mensagens Recebidas Por SMS

Last updated 4 years ago

hashtagImportante:

hashtagReplys by Message

hashtagQuery Parameters

hashtagHeaders

hashtagExemplos

hashtagCampos de Retorno

hashtagPossíveis Retornos