Consultar Saldo

Instruções para consulta de Saldo

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.

Check SMS Balance

GET https://message.uniqmobile.com.br/api/sms/check-sms-balance

Este endpoint permite que seja buscado o saldo do cliente

Headers

Name	Type	Description
Authentication	string	api-key para autenticação

200 Saldo obtido com sucesso

{
    "Success": true,
    "Object": {
        "ClientName": "UNIQ",
        "Credits": 100
    },
    "Message": "Saldo obtido com sucesso"
}

400 Algum erro durante a requisição

{
    "Success": false, 
    "Object": null, 
    "Message": "Mensagem referente ao erro"
}

500 Algum erro no nosso servidor durante a requisição

{
    "Success": false, 
    "Object": null, 
    "Message": "Mensagem referente ao erro"
}

Exemplos

Curl

curl --request GET \
    --url https://message.uniqmobile.com.br/api/sms/check-sms-balance \
    --header 'api-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \

Python

import requests
from requests.structures import CaseInsensitiveDict

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

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

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

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

C#

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

class MainClass {
  public static void Main (string[] args) {
    var url = "https://message.uniqmobile.com.br/api/sms/check-sms-balance";

    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);
    }
  }
}

JavaScript

var url = "https://message.uniqmobile.com.br/api/sms/check-sms-balance";

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

<?php

$url = "https://message.uniqmobile.com.br/api/sms/check-sms-balance";

$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);

?>

NodeJS

const https = require('https')

const options = {
  hostname: 'message.uniqmobile.com.br',
  path: '/api/sms/check-sms-balance',
  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
ClientName	Nome do Cliente
Credits	Saldo de SMS do cliente
Message	Mensagem com mais detalhes sobre a requisição

Possíveis Retornos

HTTP Status	Mensagem
200	Saldo obtido com sucesso
401	Erro de Autenticação com a Api-key
401	Usuário Inativo
401	Usuário Não Encontrado
400	Erro na busca pelas informações do usuário
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.