Documentação da API

Baseado no Manual de Integração v2.7.2

Salvar PDF

Endpoint Base HTTP: http://apisms2.sendvox.com.br/

1. Integração HTTP

1.1 Envio SMS Simples

Existem dois métodos. O Método 2 (sem ID externo obrigatório) é o mais comum.

URL: http://apisms2.sendvox.com.br/integracao.do?account=[LOGIN]&code=[SENHA]&dispatch=sendmsg&type=E&to=[TELEFONE]&msg=[MENSAGEM]&tipoEnvio=1

Parâmetro	Tipo	Descrição
account	String	Login da conta (Obrigatório).
code	String	Senha da conta (Obrigatório).
dispatch	String	Use sendmsg para retorno de ID longo ou send para ID curto.
to	Numérico	55 + DDD + Número (Ex: 5511999998888).
msg	String	Texto da mensagem (160 caracteres).
tipoEnvio	Int	1=Longcode, 2=Shortcode/Token, 4=Carta.

1.2 Envio com Link Gerenciável

Gera links encurtados ou redirecionamento para WhatsApp.

...&msg=Ola%20&linkUrl=http://www.site.com&whatsNum=551199...&whatsText=Ola

Utilize as tags <LINK> e <WHATS> no corpo da mensagem.

1.3 Consulta Envio por Código

http://apisms2.sendvox.com.br/integracao.do?account=[...]&code=[...]&type=C&id=[ID_MENSAGEM]

1.4 Consulta Lista de Envios

Consulta múltiplos IDs separando por dois pontos (:).

http://apisms2.sendvox.com.br/integracao3.do?...&type=C&id=12345:67890

1.6 Envio HTTP com Retorno JSON

Para receber o retorno em JSON ao invés de texto puro, utilize o endpoint integracao3.do.

http://apisms2.sendvox.com.br/integracao3.do?...

Retorno Sucesso: {"id_mensagem":1637364991}

1.8 Envio de Arquivo (.txt)

Upload de arquivo TXT sem cabeçalho, separado por ponto e vírgula (;).

Layout: Telefone;Mensagem;CodExterno;Agendamento;LinkUrl;WhatsNum;WhatsTxt;

11999998888;Teste de envio;;;;;;

2. Consultas

2.1 Consulta Resposta (MO)

Recupera respostas dos clientes. Limite de 30 dias por requisição.

http://apisms2.sendvox.com.br/pesquisaResposta?account=[...]&code=[...]&dataInicio=DD/MM/AAAA&dataFim=DD/MM/AAAA

2.2 Consulta e Gestão de Créditos

Consultar: .../credito.do?...&type=C&loginUsuarioCredito=[LOGIN]

Incluir (Revenda): .../credito.do?...&type=A&qtdeSms=500

Remover (Revenda): .../credito.do?...&type=R&qtdeSms=500

3. Consulta Link

3.1 Consulta por Período

Relatório de quem clicou no link.

http://apisms2.sendvox.com.br/pesquisaLink?account=[...]&code=[...]&dataInicio=...&dataFim=...

4. Códigos de Erros (HTTP/JSON)

Código	Descrição
000	Sucesso / Enviada
010	Mensagem Vazia
013	Número incompleto ou inválido
080	Código da mensagem duplicado
174	Usuário sem crédito
240	Arquivo vazio
900	Login ou senha inválidos
901	IP não autorizado

5. WebService (SOAP)

WSDL: http://apisms2.sendvox.com.br/services?wsdl

5.1 cadastrarMensagem

<men:cadastrarMensagem>
  <mensagem>
    <login>...</login>
    <senha>...</senha>
    <nroCelular>11999998888</nroCelular>
    <txtMensagem>Teste</txtMensagem>
    <tipoEnvio>1</tipoEnvio>
  </mensagem>
</men:cadastrarMensagem>

5.2 consultarMensagem

Consulta unitária pelo código da mensagem.

5.3 consultarMensagemLista

Consulta múltiplos códigos separados por vírgula.

5.4 consultarResposta

Busca respostas (MO) por período ou código.

5.5 consultarSaldo

Retorna o saldo atual da conta.

5.6 consultarLink

Retorna interações de cliques.

6. Status de Mensagens

ID	Descrição
0	Em Análise de Envio
1	Aguardando Processamento
2	Enviada (na operadora)
3	Entregue (no celular)
6	Não Entregue (Erro)
13	Número Inválido
14	Bloqueada (Blacklist)
20	Spam

7. API JSON (REST)

Requer homologação de IP. POST: http://apisms2.sendvox.com.br/envio

7.1 Envio Unitário

{
  "account": "LOGIN", "code": "SENHA",
  "to": "11999998888", "msg": "Teste", "id": "id_interno",
  "coluna_a": "info_extra", "urlCallback": "http://seusite.com/retorno"
}

7.2 Envio Agrupado

Permite até 1000 mensagens por requisição.

{
  "account": "LOGIN", "code": "SENHA",
  "mensagens": [
    { "to": "11999991111", "msg": "Msg 1", "id": "1" },
    { "to": "11999992222", "msg": "Msg 2", "id": "2" }
  ]
}

7.3 Callback (Webhook)

O sistema envia um POST para sua URL com o status:

{
  "mensagens": [
    { "telefone": "5511...", "data": "2025-10-10", "id": 123, "status": "ENTREGUE" }
  ]
}