API HTTPS
Inserir Mensagens
https://apihttp.disparopro.com.br:8433/mt
curl -X POST -H "Authorization: Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a" -H "Content-Type: application/json" -d '[ { "numero": "5511999887744", "servico": "short", "mensagem": "Texto da mensagem", "parceiro_id": "5034e65a0c", "codificacao": "0", "nome_campanha" : "Nome da Campanha" } ]' "https://apihttp.disparopro.com.br:8433/mt"
$curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://apihttp.disparopro.com.br:8433/mt", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => "[ { \"numero\": \"5511999887744\", \"servico\": \"short\", \"mensagem\": \"Texto da mensagem\", \"parceiro_id\": \"5034e65a0c\", \"codificacao\": \"0\", \"nome_campanha\" : \"Nome da Campanha\" } ]", CURLOPT_HTTPHEADER => [ "authorization: Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a", "content-type: application/json" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
require 'uri' require 'net/http' url = URI("https://apihttp.disparopro.com.br:8433/mt") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Post.new(url) request["authorization"] = 'Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a' request["content-type"] = 'application/json' request.body = "[ { \"numero\": \"5511999887744\", \"servico\": \"short\", \"mensagem\": \"Texto da mensagem\", \"parceiro_id\": \"5034e65a0c\", \"codificacao\": \"0\", \"nome_campanha\" : \"Nome da Campanha\" } ]" response = http.request(request) puts response.read_body
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); RequestBody body = RequestBody.create(mediaType, "[ { \"numero\": \"5511999887744\", \"servico\": \"short\", \"mensagem\": \"Texto da mensagem\", \"parceiro_id\": \"5034e65a0c\", \"codificacao\": \"0\", \"nome_campanha\" : \"Nome da Campanha\" } ]"); Request request = new Request.Builder() .url("https://apihttp.disparopro.com.br:8433/mt") .post(body) .addHeader("authorization", "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
var unirest = require("unirest"); var req = unirest("POST", "https://apihttp.disparopro.com.br:8433/mt"); req.headers({ "content-type": "application/json", "authorization": "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a" }); req.type("json"); req.send([ { "numero": "5511999887744", "servico": "short", "mensagem": "Texto da mensagem", "parceiro_id": "5034e65a0c", "codificacao": "0", "nome_campanha" : "Nome da Campanha" } ]); req.end(function (res) { if (res.error) throw new Error(res.error); console.log(res.body); });
var client = new RestClient("https://apihttp.disparopro.com.br:8433/mt"); var request = new RestRequest(Method.POST); request.AddHeader("content-type", "application/json"); request.AddHeader("authorization", "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a"); request.AddParameter("application/json", "[ { \"numero\": \"5511999887744\", \"servico\": \"short\", \"mensagem\": \"Texto da mensagem\", \"parceiro_id\": \"5034e65a0c\", \"codificacao\": \"0\", \"nome_campanha\" : \"Nome da Campanha\" } ]", ParameterType.RequestBody); IRestResponse response = client.Execute(request);
Cabeçalho
{ "Authorization": "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a", "Content-Type": "application/json" }
Parâmetros
Campo | Tipo | Descrição |
---|---|---|
usuario | string | Usuário da API HTTP Não Segura (Obrigatório, ex: 5c45b8e1c4e51). |
senha | string | Senha da API HTTP Não Segura (Obrigatório, ex: 5c5b5e14). |
numero | string | Número da mensagem (Obrigatório, ex: 5511988663344). |
servico | string | Serviço da mensagem obrigatório [] |
parceiro_id | string | Id externo para uso do parceiro (Não obrigatório, máximo 100 caracteres) |
mensagem | string | Texto da mensagem obrigatório (Máximo 1377 caracteres, 9 PDUs para 7-BIT e 20 PDUs para 16-BIT). |
codificacao | string | Codificação da mensagem (Não obrigatório, 0 para 7-bits e 8 para 16-bits). |
nome_campanha | string | Nome Campanha (Opcional, ex: Happy Christmas) |
Tarifação
Codificação | Tipo | Descrição |
---|---|---|
0 | 7-bits | Neste formato de envio, um PDU pode ter no máximo 160 caracteres como mensagem simples: sem acentuação, caracteres especiais ou emojis. Ao ultrapassar o limite de caracteres, sua mensagem será equivalente a 2 disparos e o limite diminuirá para 153, assim, você pode atingir um limite máximo de 1377 caracteres (9 PDUs). Caso isso aconteça, a cada 153 caracteres na mesma mensagem, o valor de um disparo será acrescentado. O contratante fica ciente que mensagens mais longas significam mais custo devido a concatenação desses PDUs.Veja aqui os caracteres permitidos neste formato de envio |
8 | 16-bits | No formato de 16 bits você consegue enviar mensagens personalizadas com um limite de 70 caracteres: com acentuação e emojis . O processo de concatenação e cobrança é o mesmo, ao ultrapassar o limite de caracteres, automaticamente, o limite diminuirá para 67 dentro da mesma mensagem disparada. Neste caso, o contratante fica ciente que mensagens mais longas significam mais custo devido a concatenação desses PDUs. Veja aqui os caracteres permitidos neste formato de envio. O tamanho máximo de caracteres que o sistema suporta para esse tipo de codificação é 1340 caracteres, totalizando 20 PDUs. Veja aqui os caracteres permitidos neste formato de envio |
Exemplo
Envio Unitário [Object]
{ "numero": "5511999887744", "servico": "short", "mensagem": "Texto da mensagem", "parceiro_id": "5034e65a0c", "codificacao": "0", "nome_campanha" : "Nome da Campanha" }
Envio Unitário [Array]
[ { "numero": "5511999887744", "servico": "short", "mensagem": "Texto da mensagem", "parceiro_id": "5034e65a0c", "codificacao": "0", "nome_campanha" : "Nome da Campanha" } ]
Múltiplos envios
[ { "numero": "5511999887744", "servico": "short", "mensagem": "Texto da mensagem", "parceiro_id": "5034e65a0c", "codificacao": "0", "nome_campanha" : "Nome da Campanha" }, { "numero": "5511999887744", "servico": "short", "mensagem": "Texto da mensagem", "parceiro_id": "5034e65a0c", "codificacao": "0", "nome_campanha" : "Nome da Campanha" } ]
Status das Mensagens
"ACCEPTED" => "Aguardando" "UNKNOWN" => "Falhada" "PAYREQUIRED" => "Sem Saldo"
Sucesso [Object]
"Inserido com Sucesso" HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": { "id": "v4d4ah3khm12ryi", "numero": "5511988663344", "status": "ACCEPTED", "parceiro_id": "5034e65a0c", "codigo_status": "02", "codigo_detalhe": "000", "descricao_detalhe": "Message Sent", "nome_campanha" : "Nome da Campanha", "id_campanha" : "1" } } "Número Inválido" HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": { "id": null, "numero": "5511988663344", "status": "UNKNOWN", "parceiro_id": "5034e65a0c", "codigo_status": "04", "codigo_detalhe": "190", "descricao_detalhe": "Unknown error", "nome_campanha" : "Nome da Campanha", "id_campanha" : "1" } }
Sucesso [Array]
"Inserido com Sucesso" HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": [ { "id": "v4d4ah3khm12ryi", "numero": "5511988663344", "status": "ACCEPTED", "parceiro_id": "5034e65a0c", "codigo_status": "02", "codigo_detalhe": "000", "descricao_detalhe": "Message Sent", "nome_campanha" : "Nome da Campanha", "id_campanha" : "1" } ] "detail": [ { "id": "v4d4ah3khm12ryi", "numero": "5511988663344", "status": "ACCEPTED", "parceiro_id": "5034e65a0c", "codigo_status": "02", "codigo_detalhe": "000", "descricao_detalhe": "Message Sent", "nome_campanha" : "Nome da Campanha", "id_campanha" : "1" } ] } "Número Inválido" HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": [ { "id": null, "numero": "5511988663344", "status": "UNKNOWN", "parceiro_id": "5034e65a0c", "codigo_status": "04", "codigo_detalhe": "190", "descricao_detalhe": "Unknown error", "nome_campanha" : "Nome da Campanha", "id_campanha" : "1" } ] }
Erro
HTTP/1.1 400 Bad Request { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Bad Request", "status": 400, "detail": "Mensagem de erro" } HTTP/1.1 500 Internal Server Error { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Internal Server Error", "status": 500, "detail": "Mensagem de erro" }
GET MT
https://apihttp.disparopro.com.br:8433/mt
curl -X POST -H "Authorization: Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a" "https://apihttp.disparopro.com.br:8433/mt"
$curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://apihttp.disparopro.com.br:8433/mt", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "authorization: Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a", "content-type: application/json" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
require 'uri' require 'net/http' url = URI("https://apihttp.disparopro.com.br:8433/mt") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["authorization"] = 'Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a' request["content-type"] = 'application/json' response = http.request(request) puts response.read_body
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); Request request = new Request.Builder() .url("https://apihttp.disparopro.com.br:8433/mt") .get() .addHeader("authorization", "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
var unirest = require("unirest"); var req = unirest("GET", "https://apihttp.disparopro.com.br:8433/mt"); req.headers({ "content-type": "application/json", "authorization": "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a" }); req.end(function (res) { if (res.error) throw new Error(res.error); console.log(res.body); });
var client = new RestClient("https://apihttp.disparopro.com.br:8433/mt"); var request = new RestRequest(Method.GET); request.AddHeader("content-type", "application/json"); request.AddHeader("authorization", "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a"); IRestResponse response = client.Execute(request);
Cabeçalho
{ "Authorization": "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a", "Content-Type": "application/json" }
Parâmetros
Campo | Tipo | Descrição |
---|---|---|
numero | string | Número da Mensagem (ex: 5511988663344). |
servico | string | Serviço da Mensagem [] |
codigo | string | ID da Mensagem |
data | string | Data em que a mensagem foi enviada (ex: dd/mm/YYYY) |
Exemplo URL
https://apihttp.disparopro.com.br:8433/mt https://apihttp.disparopro.com.br:8433/mt?codigo=v4d4ah3khm12ryi https://apihttp.disparopro.com.br:8433/mt?codigo=v4d4ah3khm12ryi&numero=5511988663344 https://apihttp.disparopro.com.br:8433/mt?codigo=v4d4ah3khm12ryi&numero=5511988663344&data=01/01/2020 https://apihttp.disparopro.com.br:8433/mt?codigo=v4d4ah3khm12ryi&numero=5511988663344&data=01/01/2020&servico=short
Consultar por vários valores
https://apihttp.disparopro.com.br:8433/mt?codigo=v4d4ah3khm12ryi,v4d4ah3khm12ryj https://apihttp.disparopro.com.br:8433/mt?numero=5511988663344,5511988663345 https://apihttp.disparopro.com.br:8433/mt?servico=
Sucesso
"Consultado com Sucesso" HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": [ { "id": "v4d4ah3khm12ryi", "status": "DELIVERED", "codigo_status": "03", "codigo_detalhe": "120", "descricao_detalhe": "Message received by mobile", "destino": "5511988663344", "parceiro_id": null, "data_insercao": "01/01/2020 13:19:20", "data_atualizacao": "01/01/2020 13:19:24" } ] } "Requisição Inválida" HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": [] } HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": "Mensagem de erro" }
Erro
HTTP/1.1 400 Bad Request { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Bad Request", "status": 400, "detail": "Mensagem de erro" } HTTP/1.1 500 Internal Server Error { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Internal Server Error", "status": 500, "detail": "Mensagem de erro" }
GET MO
https://apihttp.disparopro.com.br:8433/mo
curl -X POST -H "Authorization: Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a" "https://apihttp.disparopro.com.br:8433/mo"
$curl = curl_init(); curl_setopt_array($curl, [ CURLOPT_URL => "https://apihttp.disparopro.com.br:8433/mo", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_HTTPHEADER => [ "authorization: Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a", "content-type: application/json" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
require 'uri' require 'net/http' url = URI("https://apihttp.disparopro.com.br:8433/mo") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["authorization"] = 'Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a' request["content-type"] = 'application/json' response = http.request(request) puts response.read_body
OkHttpClient client = new OkHttpClient(); MediaType mediaType = MediaType.parse("application/json"); Request request = new Request.Builder() .url("https://apihttp.disparopro.com.br:8433/mo") .get() .addHeader("authorization", "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a") .addHeader("content-type", "application/json") .build(); Response response = client.newCall(request).execute();
var unirest = require("unirest"); var req = unirest("GET", "https://apihttp.disparopro.com.br:8433/mo"); req.headers({ "content-type": "application/json", "authorization": "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a" }); req.end(function (res) { if (res.error) throw new Error(res.error); console.log(res.body); });
var client = new RestClient("https://apihttp.disparopro.com.br:8433/mo"); var request = new RestRequest(Method.GET); request.AddHeader("content-type", "application/json"); request.AddHeader("authorization", "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a"); IRestResponse response = client.Execute(request);
Cabeçalho
{ "Authorization": "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a", "Content-Type": "application/json" }
Parâmetros
Campo | Tipo | Descrição |
---|---|---|
numero | string | Número da Mensagem (ex: 5511988663344). |
servico | string | Serviço da Mensagem [] |
codigo | string | ID da Mensagem |
data | string | Data em que a mensagem foi enviada (ex: dd/mm/YYYY) |
Exemplo URL
https://apihttp.disparopro.com.br:8433/mo https://apihttp.disparopro.com.br:8433/mo?codigo=v4d4ah3khm12ryi https://apihttp.disparopro.com.br:8433/mo?codigo=v4d4ah3khm12ryi&numero=5511988663344 https://apihttp.disparopro.com.br:8433/mo?codigo=v4d4ah3khm12ryi&numero=5511988663344&data=01/01/2020 https://apihttp.disparopro.com.br:8433/mo?codigo=v4d4ah3khm12ryi&numero=5511988663344&data=01/01/2020&servico=short
Consultar por vários valores
https://apihttp.disparopro.com.br:8433/mt?codigo=v4d4ah3khm12ryi,v4d4ah3khm12ryj https://apihttp.disparopro.com.br:8433/mt?numero=5511988663344,5511988663345 https://apihttp.disparopro.com.br:8433/mt?servico=
Sucesso
"Consultado com Sucesso" HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": [ { "id": "v4d4ah3khm12ryi", "origem": "5511988663344", "resposta": "Mensagem", "parceiro_id": "", "data_recebimento": "01/01/2020 13:19:36" } ] } "Requisição Inválida" HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": [] } HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": "Mensagem de erro" }
Erro
HTTP/1.1 400 Bad Request { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Bad Request", "status": 400, "detail": "Mensagem de erro" } HTTP/1.1 500 Internal Server Error { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Internal Server Error", "status": 500, "detail": "Mensagem de erro" }
Consultar Saldo
https://apihttp.disparopro.com.br:8433/balance
curl -X GET -H "Authorization: Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a" "https://apihttp.disparopro.com.br:8433/balance"
$curl = curl_init(); curl_setopt_array($curl, array( CURLOPT_URL => "https://apihttp.disparopro.com.br:8433/balance", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "GET", CURLOPT_POSTFIELDS => "", CURLOPT_HTTPHEADER => array( "authorization: Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a" ), )); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; }
require 'uri' require 'net/http' url = URI("https://apihttp.disparopro.com.br:8433/balance") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true http.verify_mode = OpenSSL::SSL::VERIFY_NONE request = Net::HTTP::Get.new(url) request["authorization"] = 'Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a' response = http.request(request) puts response.read_body
OkHttpClient client = new OkHttpClient(); Request request = new Request.Builder() .url("https://apihttp.disparopro.com.br:8433/balance") .get() .addHeader("authorization", "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a") .build(); Response response = client.newCall(request).execute();
var unirest = require("unirest"); var req = unirest("GET", "https://apihttp.disparopro.com.br:8433/balance"); req.headers({ "authorization": "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a" }); req.end(function (res) { if (res.error) throw new Error(res.error); console.log(res.body); });
var client = new RestClient("https://apihttp.disparopro.com.br:8433/balance"); var request = new RestRequest(Method.GET); request.AddHeader("authorization", "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a"); IRestResponse response = client.Execute(request);
Cabeçalho
{ "Authorization": "Bearer e372cab8ac49517b2b1a1748538ab5636c39a65a" }
Sucesso
HTTP/1.1 200 OK { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "OK", "status": 200, "detail": { "saldo": "50,35" } }
Erro
HTTP/1.1 400 Bad Request { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Bad Request", "status": 400, "detail": "Mensagem de erro" } HTTP/1.1 500 Internal Server Error { "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Internal Server Error", "status": 500, "detail": "Mensagem de erro" }