Documentação da API MozeSMS Obter mensagens enviadas

Introdução

A API MozeSMS permite enviar mensagens SMS usando a plataforma MozeSMS. Este documento fornece informações detalhadas sobre os endpoints disponíveis, os parâmetros aceitos e as respostas esperadas.

API base URL

Os endereços de URL que voce precisa usar para se conectar ao servidor MozeSMS :

Base URL
  • https://api.mozesms.com
  • Autenticação

    Para autenticar suas solicitações, inclua o cabeçalho de autorização na seguinte forma:
  • Authorization: Bearer {sua_token}
  • Substitua {sua_token} pelo token de autenticação fornecido pela MozeSMS.

    Endpoints

    Consultar Mensagens SMS
  • /messages/v2
  • Método:

    GET

    Parâmetros:

    • start_date (opcional): Data de início para a consulta (formato: 'YYYY-MM-DD').
    • end_date (opcional): Data de término para a consulta (formato: 'YYYY-MM-DD').
    • idsms (opcional): ID único da mensagem SMS.
    • from (opcional): Número de telefone do remetente/ senderID.
    • to (opcional): Número de telefone do destinatario.
    • status_code (opcional): Código de status da mensagem.

    Exemplo de Solicitação:

    curl -X GET "http://api.mozesms.com/messages/v2?start_date=2023-01-01&end_date=2023-12-31" -H "Authorization: Bearer sua_token"

    Exemplo de Resposta:

    [
        {
            "idsms": 1,
            "from": "123456789",
            "to": "987654321",
            "message": "Olá, mundo!",
            "status_code": 1,
            "status": "Enviada",
            "parts": 1
        },
        // ... outras mensagens ...
    ]

    Erros

    A API retorna os seguintes códigos de status:

    • 200 OK: A solicitação foi bem-sucedida.
    • 401 Unauthorized: Falha na autenticação. Verifique suas credenciais.
    • 404 Not Found: O recurso solicitado não foi encontrado.

    Estados da Mensagem

    Códigos de Estado (status_code)

    Ao filtrar mensagens pelo estado, você pode encontrar os seguintes códigos de estado:

    • 0: Pendente
    • 1: Enviada
    • 2: Entregue
    • 3: Expirada
    • 4: Não Entregue
    • 5: Agendada
    • 6: Rejeitada
    • 7: Inválida

    Exemplos em varias linguagens

         
    <?php 
    $apiEndpoint = 'http://api.mozesms.com/messages/v2';
    $apiKey = 'sua_token';
    $estadoFiltrado = 1; // status_code para 'Enviada'
    
    // Parâmetros para filtrar mensagens
    $params = [
        'status_code' => $estadoFiltrado,
    ];
    
    // Construa a URL da solicitação
    $requestUrl = $apiEndpoint . '?' . http_build_query($params);
    
    // Inicialize a sessão cURL
    $ch = curl_init();
    
    // Configure as opções cURL
    curl_setopt_array($ch, [
        CURLOPT_URL => $requestUrl,
        CURLOPT_RETURNTRANSFER => true,
        CURLOPT_HTTPHEADER => [
            "Authorization: Bearer $apiKey"
        ],
    ]);
    
    // Execute a solicitação cURL e obtenha a resposta
    $response = curl_exec($ch);
    
    // Verifique por erros cURL
    if (curl_errno($ch)) {
        echo 'Erro cURL: ' . curl_error($ch);
    }
    
    // Feche a sessão cURL
    curl_close($ch);
    
    // Exiba a resposta da API
    echo $response;
    
    ?>
    
     
    


    file: getmessages.php
    
    curl -X GET "http://api.mozesms.com/messages/v2?start_date=2023-01-01&end_date=2023-12-31" -H "Authorization: Bearer sua_token"
    
    
    import requests
    
    api_endpoint = 'http://api.mozesms.com/messages/v2'
    api_key = 'sua_token'
    estado_filtrado = 1  # status_code para 'Enviada'
    
    # Parâmetros para filtrar mensagens
    params = {
        'status_code': estado_filtrado,
    }
    
    # Faça a solicitação usando requests
    response = requests.get(api_endpoint, params=params, headers={'Authorization': f'Bearer {api_key}'})
    
    # Exiba a resposta da API
    print(response.text)
    
     
        


    file: getmessages.py
    
    const http = require('http');
    const querystring = require('querystring');
    
    // MozeSMS API endpoint for querying SMS messages
    const apiEndpoint = 'http://api.mozesms.com/messages/v2';
    
    // Sua chave de API MozeSMS
    const apiKey = 'sua token';
    
    // Parâmetros para consultar mensagens SMS
    const params = {
        start_date: '2023-8-01',
        end_date: '2023-10-17',
        // idsms: '',
        // from: '',
        // status_code: '',
    };
    
    // Construa a string de consulta
    const queryString = querystring.stringify(params);
    
    // Construa a URL da solicitação
    const requestUrl = `${apiEndpoint}?${queryString}`;
    
    // Opções para a solicitação HTTP
    const options = {
        method: 'GET',
        headers: {
            Authorization: `Bearer ${apiKey}`,
        },
    };
    
    // Faça a solicitação usando http
    const req = http.request(requestUrl, options, (res) => {
        let data = '';
    
        // A resposta está chegando
        res.on('data', (chunk) => {
            data += chunk;
        });
    
        // A resposta foi totalmente recebida
        res.on('end', () => {
            // Saída da resposta da API
            console.log(data);
        });
    });
    
    // Lidar com erros de solicitação
    req.on('error', (error) => {
        console.error('Erro na requisição:', error.message);
    });
    
    // Finalizar a solicitação
    req.end();
    
    


    file: getmessages.js
    
    import java.io.BufferedReader;
    import java.io.IOException;
    import java.io.InputStreamReader;
    import java.net.HttpURLConnection;
    import java.net.URL;
    
    public class MozeSMSExample {
        public static void main(String[] args) {
            String apiEndpoint = "http://api.mozesms.com/messages/v2";
            String apiKey = "sua_token";
            int estadoFiltrado = 1; // status_code para 'Enviada'
    
            try {
                // Construa a URL da solicitação
                String requestUrl = apiEndpoint + "?status_code=" + estadoFiltrado;
                URL url = new URL(requestUrl);
    
                // Abra a conexão HTTP
                HttpURLConnection connection = (HttpURLConnection) url.openConnection();
                connection.setRequestMethod("GET");
                connection.setRequestProperty("Authorization", "Bearer " + apiKey);
    
                // Leia a resposta
                BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
                String line;
                StringBuilder response = new StringBuilder();
    
                while ((line = reader.readLine()) != null) {
                    response.append(line);
                }
    
                // Exiba a resposta da API
                System.out.println(response.toString());
    
                // Feche a conexão
                connection.disconnect();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
    
    
    .asString();


    file: getmessages.java
    
    #include <iostreamp>
    #include <curl/curl.h>
    
    int main() {
        const char* apiEndpoint = "http://api.mozesms.com/messages/v2";
        const char* apiKey = "sua_token";
        int estadoFiltrado = 1; // status_code para 'Enviada'
    
        // Construa a URL da solicitação
        char requestUrl[256];
        sprintf(requestUrl, "%s?status_code=%d", apiEndpoint, estadoFiltrado);
    
        // Inicialize a biblioteca cURL
        CURL* curl = curl_easy_init();
    
        if (curl) {
            // Configure as opções cURL
            curl_easy_setopt(curl, CURLOPT_URL, requestUrl);
            curl_easy_setopt(curl, CURLOPT_HTTPHEADER, "Authorization: Bearer sua_token");
    
            // Execute a solicitação cURL
            CURLcode res = curl_easy_perform(curl);
    
            // Verifique por erros cURL
            if (res != CURLE_OK) {
                fprintf(stderr, "Erro cURL: %s\n", curl_easy_strerror(res));
            }
    
            // Libere os recursos do cURL
            curl_easy_cleanup(curl);
        }
    
        return 0;
    }