Report Total
Endpoint: https://api.smsdev.com.br/v1/report/total
Método: POST
, GET
ou JSON
Descrição: Esse método é utilizado para consulta relátório resumido de utilização por período.
Descrição dos parâmetros
Nome |
Tipo |
Padrão |
Obrigatório |
Descrição |
key |
texto |
|
sim |
Chave de autenticação de conta. |
date_from |
texto |
|
não |
Data início para filtro Ex: ’01/01/2020′. |
date_to |
texto |
|
não |
Data fim para filtro Ex: ’02/01/2020′. |
Let us know if you liked the post. That’s the only way we can improve.
{
"key" : "XXXXXXXXXXXXXXXXXXXX",
"date_from" : "01/01/2020",
"date_to" : "30/01/2020"
}
https://api.smsdev.com.br/v1/report/total?key=SUA_CHAVE_KEY&data_from=01/01/2020&data_to=30/01/2020
Copie e cole no navegador
curl --request GET \
--url 'https://api.smsdev.com.br/v1/report/total?key=SUA_CHAVE_KEY&data_from=01/01/2020&data_to=30/01/2020'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.smsdev.com.br/v1/report/total?key=SUA_CHAVE_KEY&data_from=01/01/2020&data_to=30/01/2020",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_SSL_VERIFYHOST => 0,
CURLOPT_SSL_VERIFYPEER => 0,
));
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
?>
HttpResponse<String> response = Unirest.get("https://api.smsdev.com.br/v1/report/total?key=SUA_CHAVE_KEY&data_from=01/01/2020&data_to=30/01/2020").asString();
var http = require("http");
var options = {
"method": "GET",
"hostname": "api.smsdev.com.br",
"port": null,
"path": "/v1/report/total?key=SUA_CHAVE_KEY&data_from=01/01/2020&data_to=30/01/2020",
"headers": {}
};
var req = http.request(options, function (res) {
var chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
var body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.end();
O método acima retorna código no padrão abaixo
{
"situacao" : "OK",
"codigo" : "1",
"data_inicio" : "01\/01\/2020",
"data_fim" : "30\/01\/2020",
"enviada" : "100",
"recebida" : "10200",
"blacklist" : "0",
"cancelada" : "0",
"qtd_credito" : "10300",
"descricao" : "CONSULTA REALIZADA"
}
Descrição de retorno
Nome |
Descrição |
situacao |
“OK” – Envio com sucesso
“ERRO” – Envio com erro
|
codigo |
Ver tabela de código de erros.
|
data_inicio |
Data início da requisição realizada.
|
data_fim |
Data fim da requisição realizada.
|
enviada |
Qtd de mensagens com status enviada no período.
|
recebida |
Qtd de mensagens com status recebida no período.
|
blacklist |
Qtd de mensagens com status blacklist no período.
|
cancelada |
Qtd de mensagens com status cancelada no período.
|
qtd_credito |
Qtd de crédito consumido no período.
|
descricao |
Texto da mensagem recebida (MO).
|