Documentação da API de Gerenciamento de Chamadas
Esses endpoints permitem que você recupere seu Chamadas Perdidas, Chamadas recebidas atendidas, e Chamadas efetuadas Sincronizado do aplicativo móvel SMSMobileAPI para seu painel de controle + API.
Importante: se o aplicativo móvel estiver em execução em segundo plano, o sistema do telefone poderá impor um atraso (geralmente de até 10 minutos) entre as sincronizações. Você sempre pode abrir o aplicativo para sincronizar manualmente, se necessário.
Precisar de ajuda? api@smsmobileapi.com
Início rápido
URL base
PEGAR https://api.smsmobileapi.com
Todos os endpoints abaixo estão documentados como PEGAR solicitações. Substituir SUA_CHAVE_API Com sua chave verdadeira (não a compartilhe publicamente).
Exemplos
GET https://api.smsmobileapi.com/call/missed/list/?apikey=YOUR_API_KEY
GET https://api.smsmobileapi.com/call/incoming/list/?apikey=YOUR_API_KEY&limit=50&offset=0&sort_by=call_date_ms&sort_dir=desc
GET https://api.smsmobileapi.com/call/outgoing/list/?apikey=YOUR_API_KEY&q=3247&date_from_ms=1700000000000&date_to_ms=1700864000000
Autenticação
Os endpoints de gerenciamento de chamadas autenticam-se usando o apikey parâmetro de consulta.
Validação da assinatura: Os endpoints de entrada/saída validam sua chave de API e verificam a validade da sua assinatura (dateLimit >= CURDATE()Se expirado, você receberá api_expirado.
Conceitos comuns
Paginação
Usar limite e desvio Para paginar os resultados.
Carimbos de data/hora
- data_da_chamada_ms é um timestamp UNIX em milissegundos.
- call_datetime_utc é armazenado como uma string de data e hora UTC (campo do banco de dados).
- Para chamadas perdidas, a API retorna um valor formatado. data string (derivada de um valor em milissegundos).
Procurar
- Chamadas perdidas: procurar Corresponde ao número ou nome.
- Entrada/Saída: q partidas número_de_telefone ou nome_em_cache.
Triagem (somente entrada/saída)
A classificação é controlada por ordenar por + diretório_de_ordenar (Apenas campos permitidos). As chamadas perdidas são sempre ordenadas da mais recente para a mais antiga.
Erros
| HTTP | Exemplo de erro | Significado |
|---|---|---|
| 400 | {"success":false,"error":"missing_apikey"} | Ausente ou vazio apikey. |
| 403 | {"success":false,"error":"invalid_apikey"} | Chave de API não encontrada/não reconhecida. |
| 403 | {"success":false,"error":"api_expired"} | Sua assinatura expirou (limite de data é anterior a hoje). |
| 500 | {"success":false,"error":"server_error","detail":"..."} | Erro do servidor (banco de dados, SQL, exceção). |
Observação: o endpoint de Chamadas Perdidas também pode retornar mensagens como Chave de API ausente ou erros de preparação de SQL, dependendo da situação.
Lista de chamadas perdidas
Recuperar chamadas perdidas sincronizadas do dispositivo móvel.
Ponto final
PEGAR https://api.smsmobileapi.com/call/missed/list/
Parâmetros de consulta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| apikey | corda | Obrigatório Sua chave de API está vinculada ao celular. |
| desvio | inteiro | Opcional Deslocamento de paginação (padrão: 0). |
| limite | inteiro | Opcional Número máximo de linhas (padrão: 100, máximo: 500). |
| procurar | corda | Opcional Pesquisa por número ou nome (SQL LIKE). |
| data_início | AAAA-MM-DD | Opcional Filtrar a partir deste dia (00:00:00). |
| data_fim | AAAA-MM-DD | Opcional Filtrar até este dia (23:59:59). |
Lista de chamadas recebidas
Recuperar chamadas recebidas e atendidas, sincronizadas a partir do dispositivo móvel.
Ponto final
PEGAR https://api.smsmobileapi.com/call/incoming/list/
Parâmetros de consulta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| apikey | corda | Obrigatório Sua chave de API (validada em relação à assinatura). |
| limite | inteiro | Opcional Linhas por página (padrão: 50, máximo: 200). |
| desvio | inteiro | Opcional Deslocamento de paginação (padrão: 0). |
| ordenar por | corda | Opcional Permitido: data_da_chamada_ms call_datetime_utc duração_segundos número_de_telefone criado_em nome_em_cache geolocalização |
| diretório_de_ordenar | asc|desc | Opcional Padrão: descrição. |
| data_de_ms | int (ms) | Opcional Filtrar onde data_de_chamada_ms >= data_de_origem_ms. |
| data_para_ms | int (ms) | Opcional Filtrar onde data_da_chamada_ms <= data_para_ms. |
| q | corda | Opcional Pesquisar em número_de_telefone ou nome_em_cache (COMO). |
Lista de chamadas efetuadas
Recuperar chamadas efetuadas e sincronizadas do dispositivo móvel.
Ponto final
PEGAR https://api.smsmobileapi.com/call/outgoing/list/
Parâmetros de consulta
Os parâmetros e o comportamento são os mesmos das chamadas recebidas.
| Parâmetro | Tipo | Descrição |
|---|---|---|
| apikey | corda | Obrigatório Sua chave de API (validada em relação à assinatura). |
| limite | inteiro | Opcional Linhas por página (padrão: 50, máximo: 200). |
| desvio | inteiro | Opcional Deslocamento de paginação (padrão: 0). |
| ordenar por | corda | Opcional Permitido: data_da_chamada_ms call_datetime_utc duração_segundos número_de_telefone criado_em nome_em_cache geolocalização |
| diretório_de_ordenar | asc|desc | Opcional Padrão: descrição. |
| data_de_ms | int (ms) | Opcional Filtrar onde data_de_chamada_ms >= data_de_origem_ms. |
| data_para_ms | int (ms) | Opcional Filtrar onde data_da_chamada_ms <= data_para_ms. |
| q | corda | Opcional Pesquisar em número_de_telefone ou nome_em_cache (COMO). |
campos de chamadas perdidas
| Campo | Tipo | Descrição |
|---|---|---|
| sucesso | booleano | Status da solicitação. |
| desvio | inteiro | Deslocamento de paginação retornado. |
| limite | inteiro | Limite de paginação retornado. |
| contar | inteiro | Número de linhas retornadas em dados. |
| dados | variedade | Lista de chamadas perdidas. |
| dados[].número | corda | Número de telefone do chamador. |
| data[].name | corda | Nome do contato em cache (pode estar vazio). |
| data[].data | corda | Cadeia de data e hora formatada derivada de um registro de data e hora em milissegundos. |
Campos de entrada/saída
| Campo | Tipo | Descrição |
|---|---|---|
| sucesso | booleano | Status da solicitação. |
| apikey | corda | Resposta enviada pela API (sua chave). |
| limite | inteiro | Número de linhas retornadas por página. |
| desvio | inteiro | Deslocamento de paginação retornado. |
| ordenar por | corda | Campo de classificação aplicado. |
| diretório_de_ordenar | corda | Direção de classificação aplicada. |
| filtros | objeto | Filtros com eco (data_de_ms, data_para_ms, q). |
| contar | inteiro | Número de linhas retornadas em linhas. |
| linhas | variedade | Lista de chamadas. |
| linhas[].número_de_telefone | corda | Número de telefone. |
| linhas[].nome_em_cache | string|nulo | Nome do contato em cache (pode ser nulo). |
| linhas[].call_date_ms | inteiro | Registro de data e hora da chamada em milissegundos. |
| linhas[].call_datetime_utc | corda | Campo de data e hora UTC (banco de dados). |
| linhas[].duração_seg | inteiro | Duração em segundos. |
| linhas[].geo_localização | string|nulo | Rótulo de geolocalização (pode ser nulo/vazio). |
| linhas[].criadas_em | corda | Carimbo de data/hora de inserção do servidor. |
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian