Consultar Status de Mensagem

Instruções para consulta de Status de Mensagem

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.

Message Status Check

GET https://message.uniqmobile.com.br/api/sms/message-status-check/{MessageId}

Este endpoint permite que seja buscado o status de uma determinada mensagem

Query Parameters

Name

Type

Description

MessageId

number

Id da mensagem a ser buscada

Headers

Name

Type

Description

Authentication

string

api-key para autenticação

{
    "Success": true, 
    "Object": {
        "MessageId": 560,
        "ExternalId": null,
        "MessageText": "Bom dia Teste!",
        "ScheduleDate": null,
        "SendDate": "2021-04-01T21:18:00",
        "StatusDescripition": "Em Andamento",
        "SMS" :[
            {
                "SMSId" : 568563,
                "SMSExternalId": null,
                "MessageText" : "Bom dia Teste!",
                "ScheduledDate": null,
                "SendDate": "2021-04-01T21:18:00",
                "ReturnDate": "2021-04-01T21:18:00",
                "Status": 2,
                "StatusDescription": "Sendo Processado",
                "SMSStatusDetails": "Encaminhando à operadora"
                "Number": 5598999999999
                "Operator": "OI"
            }
        ],
        "TotalSuccess": 0,
        "TotalError": 0,
        "TotalNumbers": 1,
     },
    "Message": "Relatório obtido com sucesso"
}

{
    "Success": true, 
    "Object": {
        "MessageId": 560,
        "ExternalId": null,
        "MessageText": "Teste SMS",
        "ScheduleDate": null,
        "SendDate": "2021-04-01T21:18:00",
        "StatusDescripition": "Em Andamento",
        "SMS" :[
            {
                "SMSId" : 568563,
                "SMSExternalId": null,
                "MessageText" : "Teste SMS",
                "ScheduledDate": null,
                "SendDate": "2021-04-01T21:18:00",
                "ReturnDate": "2021-04-01T21:18:00",
                "Status": 2,
                "StatusDescription": "Sendo Processado",
                "SMSStatusDetails": "Encaminhando à operadora"
                "Number": 5598999999999
                "Operator": "OI"
            },
            {
                "SMSId" : 568564,
                "SMSExternalId": null,
                "MessageText" : "Teste SMS",
                "ScheduledDate": null,
                "SendDate": "2021-04-01T21:18:00",
                "ReturnDate": "2021-04-01T21:18:00",
                "Status": 2,
                "StatusDescription": "Sendo Processado",
                "SMSStatusDetails": "Encaminhando à operadora"
                "Number": 5598900000000
                "Operator": "OI"
            }
        ],
        "TotalSuccess": 0,
        "TotalError": 0,
        "TotalNumbers": 2,
     },
    "Message": "Relatório obtido com sucesso"
}

Exemplos

curl --request GET \
    --url https://message.uniqmobile.com.br/api/sms/message-status-check/?MessageId=XXX\
    --header 'api-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \

import requests
from requests.structures import CaseInsensitiveDict

url = "https://message.uniqmobile.com.br/api/sms/message-status-check"

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

querystring = {"MessageId":XXX}

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/message-status-check/?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/message-status-check/?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/message-status-check/?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/message-status-check/${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

MessageId

ID da mensagem gerado no momento do envio

ExternalId

ID Externo da mensagem. Este parâmetro é opcional, e você pode utilizar o ID gerado pela UNIQ MOBILE para pegar o STATUS da mensagem.

MessageText

Texto da mensagem enviada

ScheduledDate

Parâmetro relacionado à agendamento de envio. Caso a mensagem tenha sido enviada de forma instantânea, será retornado null

SendDate

Data de envio da mensagem. Nos casos de agendamento, a data do envio será a mesma retornada no parâmetro ScheduledDate

StatusDescription

Descrição do status de envio do SMS junto a Operadora.

SMSId

ID do SMS gerado no momento do envio.

SMSExternalID

ID Externo do SMS. Este parâmetro é opcional, e você pode utilizar o ID gerado pela UNIQ MOBILE para pegar o STATUS do SMS

MessageText

Texto do SMS enviado

ScheduledDate

Parâmetro relacionado à agendamento de envio. Caso o SMS tenha sido enviado de forma instantânea, será retornado null

SendDate

Data do envio do SMS. Nos casos em que o cliente realize agendamento, a data de envio será a mesma retornada no parâmetro ScheduledDate

ReturnDate

Data do retorno do envio

Status

Status de envio do SMS

StatusDescription

Descrição do status de envio do SMS junto a Operadora.

SMSStatusDetail

Este parâmetro fornece mais detalhes sobre o Status do SMS

Number

Número de telefone para o qual o SMS foi enviado

Operator

Nome da Operadora

TotalSucess

Total de números com sucesso no envio

TotalError

Total de números com falha no envio

TotalNumbers

Total de números do envio

Message

Mensagem com mais detalhes sobre a requisição

Possíveis Retornos

HTTP Status

Mensagem

200

Mensagem obtida 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

400

Erro na busca pelas informações da Mensagem

429

Muitas Requisições Realizadas

500

Erro no servidor

503

Sistema indisponível no momento

504

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

PreviousConsultar Saldo NextConsultar Status de SMS

Last updated 4 years ago

hashtagImportante:

hashtagMessage Status Check

hashtagQuery Parameters

hashtagHeaders

hashtagExemplos

hashtagCampos de Retorno

hashtagPossíveis Retornos