Agendamento de SMS

Instruções para o agendamento de SMS - Individual ou em Lote

Importante:

O cancelamento de um SMS só pode ser feito até sua data de agendamento. Após, o SMS terá sido enviado à operadora e não poderá ser cancelado.

Schedule SMS

POST https://message.uniqmobile.com.br/api/sms/schedule-sms

Este endpoint permite que seja agendada uma mensagem.

Headers

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

Request Body

Name	Type	Description
MessageText	string	Conteúdo da mensagem a ser agendada
Numbers	string	Destinatários que irão receber o SMS, separados por vírgula
Scheduled	string	Data e horário para o agendamento
From	string	Nome do remetente. Pode ser
ExternalId	string	ID externo para identificação da mensagem
SMSExternalIds	string	IDs externos para identificação dos SMS, separados por vírgula

200 Exemplo 1: Sem ExternalId e sem SMSExternalId Exemplo 2: Sem ExternalId e com SMSExternalId Exemplo 3: Com ExternalId e sem SMSExternalId Exemplo 4: Com ExternalId e com SMSExternalId Exemplo 5: Envio em Lote sem ExternalId e sem SMSExternalId Exemplo 6: Envio em Lote com ExternalId e com SMSExternalId

Exemplo 1

{
    "Success": true, 
    "Object": {
        "MessageId": 270731384,
        "ExternalId": null,
        "SMS":[
            {
                "SMSId": 13547,
                "SMSExernalId": null
            }
        ]
    }, 
    "Message": "Sua Mensagem está agendada, use o Id para buscar o resultado do envio"
}

Exemplo 2

{
    "Success": true, 
    "Object": {
        "MessageId": 270731384,
        "ExternalId": null,
        "SMS":[
            {
                "SMSId": 13547,
                "SMSExernalId": "MEU_SMS_EXTERNAL_ID"
            }
        ]
    }, 
    "Message": "Sua Mensagem está agendada, use o Id para buscar o resultado do envio"
}

Exemplo 3

{
    "Success": true, 
    "Object": {
        "MessageId": 270731384,
        "ExternalId": "MEU_EXTERNAL_ID",
        "SMS":[
            {
                "SMSId": 13547,
                "SMSExernalId": null
            }
        ]
    }, 
    "Message": "Sua Mensagem está agendada, use o Id para buscar o resultado do envio"
}

Exemplo 4

{
    "Success": true, 
    "Object": {
        "MessageId": 270731384,
        "ExternalId": "MEU_EXTERNAL_ID",
        "SMS":[
            {
                "SMSId": 13547,
                "SMSExernalId": "MEU_SMS_EXTERNAL_ID"
            }
        ]
    }, 
    "Message": "Sua Mensagem está agendada, use o Id para buscar o resultado do envio"
}

Exemplo 5

{
    "Success": true, 
    "Object": {
        "MessageId": 270731384,
        "ExternalId": null,
        "SMS":[
            {
                "SMSId": 13547,
                "SMSExernalId": null
            },
            {
                "SMSId": 13548,
                "SMSExernalId": null
            },
        ]
    }, 
    "Message": "Sua Mensagem está agendada, use o Id para buscar o resultado do envio"
}

Exemplo 6

{
    "Success": true, 
    "Object": {
        "MessageId": 270731384,
        "ExternalId": "MEU_EXTERNAL_ID",
        "SMS":[
            {
                "SMSId": 13547,
                "SMSExernalId": "MEU_SMS_EXTERNAL_ID #1"
            },
            {
                "SMSId": 13548,
                "SMSExernalId": "MEU_SMS_EXTERNAL_ID #2"
            },
        ]
    }, 
    "Message": "Sua Mensagem está agendada, use o Id para buscar o resultado do envio"
}

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

Importante:

Por padrão, a plataforma da Uniq possui um limite de 3000 requisições por minuto. Requisições de envio além deste limite serão respondidas com o código de status HTTP 429.

Exemplos

Curl

curl --request POST \
    --url https://message.uniqmobile.com.br/api/sms/schedule-sms \
    --header 'api-key: XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX' \
    --header 'content-type: application/json' \
    --data '{"Numbers":"5598999999999","MessageText":"UNIQ: EXEMPLO AGENDAMENTO ENVIO CURL 01","Scheduled":"dd/MM/yyyy HH:mm:ss","From":"","ExternalId":null,"SMSExternalIds":null}'

Python

import requests
from requests.structures import CaseInsensitiveDict

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

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

data = """
{
    "Numbers": "5598999999999",
    "MessageText": "UNIQ: EXEMPLO AGENDAMENTO ENVIO PYTHON 01",
    "From": "",
    "Scheduled": "dd/MM/yyyy HH:mm:ss",
    "ExternalId": null,
    "SMSExternalIds": null
}
"""

resp = requests.post(url, headers=headers, data=data)

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/schedule-sms";

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

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

    var data = @"{
      ""Numbers"": ""5598999999999"",
      ""MessageText"": ""UNIQ: EXEMPLO AGENDAMENTO ENVIO C# 01"",
      ""From"": """",
      ""Scheduled"": ""dd/MM/yyyy HH:mm:ss"",
      ""ExternalId"": null,
      ""SMSExternalIds"": null
    }";

    using (var streamWriter = new StreamWriter(httpRequest.GetRequestStream()))
    {
      streamWriter.Write(data);
    }

    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/schedule-sms";

var xhr = new XMLHttpRequest();
xhr.open("POST", 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);
    }
};

var data = `{
    "Numbers": "559899999999",
    "MessageText": "UNIQ: EXEMPLO AGENDAMENTO ENVIO JS 01",
    "From": "",
    "Scheduled": "dd/MM/yyyy HH:mm:ss",
    "ExternalId": null,
    "SMSExternalIds": null
}`;

xhr.send(data);

PHP

<?php

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

$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
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);

$data = <<<DATA
{
    "Numbers": "559899999999",
    "MessageText": "UNIQ: EXEMPLO AGENDAMENTO ENVIO PHP 01",
    "From": "",
    "Scheduled": "dd/MM/yyyy HH:mm:ss",
    "ExternalId": null,
    "SMSExternalId": null
}
DATA;

curl_setopt($curl, CURLOPT_POSTFIELDS, $data);

$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 data = JSON.stringify(
    {"Numbers":"5598999999999",
    "MessageText":"UNIQ: EXEMPLO AGENDADO Node 01",
    "From":"",
    "Scheduled": "dd/MM/yyyy HH:mm:ss",
    "ExternalId":null,
    "SMSExternalIds":null})

const options = {
  hostname: 'message.uniqmobile.com.br',
  path: '/api/sms/schedule-sms',
  method: 'POST',
  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.write(data)

req.end()

Existe um limite de 100 SMS por requisição

Ao fazer o envio, será retornado um JSON com o ID do lote da mensagem e o ID das mensagens SMS individuais:

{
    "Success": true, 
    "Object": {
        "MessageId": 270731384,
        "ExternalId": null,
        "SMS":[
            {
                "SMSId": 13547,
                "SMSExernalId": null
            }
        ]
    }, 
    "Message": "Sua Mensagem está agendada, use o Id para buscar o resultado do envio"
}

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.
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
Message	Mensagem com mais detalhes sobre a requisição

Possíveis Retornos

HTTP Status	Mensagem
200	Sua Mensagem foi agendada, use o Id para buscar o resultado do envio
401	Erro de Autenticação com a Api-key
401	Usuário Não Encontrado
401	Usuário inativo
400	Data de Agendamento vazia
400	Número(s) inválido(s)
400	Números devem ser separados apenas por vírgula
400	Crédito insuficiente
400	Os números não são apenas dígitos
400	O número {numero} possui menos que 11 caracteres
400	O Conteúdo da mensagem está vazio
400	Texto acima de {limite} caracteres
400	Limite de SMS por requisição excedido
400	ExternalId já existe
400	SMSExternalId já existe
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.