SMS API documentation

Como funciona o request_id

1. Visualize as contagens com action=preview. Nenhum request_id é necessário e nenhum registro é excluído.
2. Gere um request_id exclusivo para uma nova exclusão, por exemplo um UUID. Salve-o antes de enviar o action=delete.
3. Para repetições, timeouts ou HTTP 202, reutilize a mesma chave API, endpoint histórico, request_id e include_linked valor. Nunca gerar um novo ID automaticamente após um erro.
4. Quando completed=true, a operação está terminada. Reutilizar o ID retorna o mesmo resultado em vez de excluir os registros recém-chegados. Use um novo ID apenas para uma limpeza deliberadamente nova.

request_id identifica sua operação de exclusão, não um SMS individual. Formato permitido: 16–128 letras ASCII, dígitos, hífens ou sublinhados. Um UUID gerado com crypto.randomUUID() é adequado.

A eliminação é feita por lotes. HTTP 202 com continue_required=true exige repetir action=delete após 3 segundos. Não existe um cron em segundo plano. action=status apenas consulta o progresso, mesmo com HTTP 200.

Exemplos de exclusão e de estado

Substitua a amostra request_id com seu próprio valor único antes de começar. As seguintes solicitações de exclusão alteram o histórico real da conta; elas não são pré- visualização.

curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

curl -X POST "https://api.smsmobileapi.com/delete-history-sms-api/" \
  -H "Authorization: Bearer YOUR_OAUTH_ACCESS_TOKEN" \
  -d "action=delete" -d "include_linked=0" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

curl -G "https://api.smsmobileapi.com/delete-history-sms-api/" \
  --data-urlencode "apikey=YOUR_API_KEY" \
  -d "action=status" \
  -d "request_id=6d54ac58-41f1-4fbc-9a39-6e6c86089451"

GET também aceita action=preview ou action=delete. POST é recomendado: parâmetros de URL podem vazar no histórico do navegador e registros de servidor. Nunca coloque uma URL de exclusão em um link público, imagem ou pré-retch.

Para POST, envie todos os parâmetros no corpo do formulário ou um objeto JSON, nunca na string de consulta. Parâmetros desconhecidos são rejeitados; os filtros de data ou de celular não são suportados.

Autenticação para os parâmetros do histórico

Use apikey ou o cabeçalho Authorization: Bearer com um token de acesso emitido pelo OAuth2 do SMSMobileAPI. Não envie um refresh token nem uma chave API como token Bearer. Os tokens expirados são recusados.

Quando os escopos são definidos, history:read permite visualização/status e history:delete também permite exclusão. Restrições tanto no token quanto no cliente OAuth. Tokens legados sem escopos mantêm seu acesso à conta existente.

OAuth2 seleciona a chave primária exclusiva API. Se existirem várias chaves primárias, também fornecer apikey para selecionar uma pertencente à conta. Chaves secundárias nunca concedem acesso ao histórico primário de chaves.

Leia a resposta antes de continuar

count_delete é o número cumulativo removido por esta operação. selected_at_start é a seleção inicial; protected_at_start conta os registros excluídos. Use preview.linked_or_processing para contar registros vinculados mesmo quando include_linked=1.

{
    "result": {
        "error": 0,
        "history": "sms-api",
        "action": "delete",
        "request_id": "6d54ac58-41f1-4fbc-9a39-6e6c86089451",
        "status": "processing",
        "completed": false,
        "count_delete": 100,
        "total_before": 250,
        "selected_at_start": 200,
        "protected_at_start": 50,
        "include_linked": 0,
        "continue_required": true,
        "message": "Repeat GET or POST with the same request_id and include_linked to continue. Status requests do not run deletion."
    }
}

• 200 com completed=true: terminado. Uma resposta de 200 visualizações ou status sozinho não prova a conclusão.
• 400 INVALID_REQUEST_ID: verifique o formato. 404 REQUEST_NOT_FOUND: não existe nenhuma operação para este ID, chave API e histórico.
• 401: credenciais inválidas ou expiradas. 403: escopo insuficiente do OAuth ou conta não autorizada.
• 409 HISTORY_BUSY: outra limpeza está em execução; continue-a a partir do cliente original. 409 INCLUDE_LINKED_CONFLICT: restaurar o valor original include_linked.
• 409 OAUTH_ACCOUNT_AMBIGUOUS: fornecer uma chave API pertencente a esta conta.
• 503 ou interrupção da rede: alguns lotes já podem estar concluídos. Verifique a configuração, então tente novamente com o request_id original. Não crie uma operação de substituição automaticamente.