e-mail contato@buscarcep.com.br ou fale conosco acesso ao painel administrativo
Web Service de buscas de Endereços e SMS
 
principal cadastrar exemplos planos web service
 
Especificação Técnica | SMS | v3
 
 

#1 - Instalar o APP

Leia com atenção ABSOLUTAMENTE TODAS as orientações abaixo:

  • Dentro de seu painel administrativo, no menu SMS, cadastre o número que será utilizando juntamente com Código de Área + DDD + Número;
  • Após o cadastro você terá 2 meses para homologar este número. Após isso basta comprar uma extensão deste período de uso do serviço;
Cadastro de Celulares no Painel Administrativo, menu SMS.
  • Instale o aplicativo SMS Buscar Cep disponível na Google Play, em https://play.google.com/store/apps/details?id=br.com.buscarcep.sms;
  • Seu telefone deve ter um Android 5.0 (Lollipop, API21) ou superior e ser um telefone intermediário. Abaixo segue uma lista de smartphones homologados;
    • Samsung Galaxy S6;
    • Samsung Galaxy S7;
    • Samsung Galaxy J7;
    • Novos telefones podem ser testados, e iremos lhe ajudar a monitorar isso.
  • Você vai precisar ter um número de telefone válido de qualquer operadora e que envie SMS;
    • O Buscar Cep não se responsabiliza, e nem terá nenhuma responsabilidade, por bloqueios advindos de sua Operadora de Telefonia nos envios de SMS;
    • Você pode utilizar linhas pré ou pós pagas. Nosso sistema consegue validar se os envios de seu número estão chegando ao destino;
    • O Buscar Cep irá enviar SMS de seu número somente para gerenciar os envios, com mensagens de sistema. Em hipótese alguma enviaremos outros tipos de SMS;
    • Seu telefone deve estar 100% do tempo conectado a internet, pois ele estará em permanente comunicação com nossa API para realizar os envios do SMS; caso ele fique por muito tempo sem conexão, nossa API vai identificar isso e irá desativar o celular, sendo necessário uma intervenção manual para ativação dentro do Painel Administrativo;

Após instalar o APP lembre de configurar o mesmo:

  • Rodar Serviço: deve estar ativo, para que o APP funcione em background no telefone;
  • Debug: deve estar habilitado somente para que você verifique se o APP está rodando em background, fora isso, mantenha-o desligado;
  • Tempo em segundos: é o tempo que seu celular vai até a API verificar se tem algum SMS para ser enviado. Nossa sugestão é 30 (segundos). Esse valor pode ser menor e isso dependerá muito do Celular utilizado suportar tantas rotinas;
  • Número: utilize SEMPRE o número completo com código do país + DDD + número, exemplo: 5531988881234;
  • Chave: sua chave no Buscar Cep de seu cadastro.

Lembre-se ainda de habilitar as permissões em seu aplicativo, após instalado, para utilização dos recursos de localização, SMS e telefone.

  • Mensagens de massa (iguais) serão automaticamente priorizadas pelo sistema e adicionado um #ID_ENVIO ao final da mesma, afim de evitar bloqueios das Operadoras;
  • Todas as respostas a SMS serão enviados via POST a URL configurada em seu cadastro, no menu Meus Dados.
 
 

Chave para testes: Chave_Gratuita_BuscarCep
Esta chave permite envios de teste para fins de manipulação dos retornos do web service, porém os SMS enviados não chegam ao destino.

HTTPS/SSL SMS:
https://buscarcep.com.br/ws3/?telefone=5531986251000&texto=SEU_TEXTO&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1

HTTPS/SSL Conultando status de SMS:
https://buscarcep.com.br/ws3/?eid=NUMERO_ID_ENVIO&chave=Chave_Gratuita_BuscarCep

CONSULTANDO CRÉDITOS:
https://buscarcep.com.br/ws3/?chave=Chave_Gratuita_BuscarCep

#2 - Enviando SMS

Tipo Formato URL
SMS https://buscarcep.com.br/ws3/?telefone=5531986251000&texto=SEU_TEXTO&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1
  • Todos os valores em negrito são obrigatórios, exceto o parâmetro identificador;
  • O tipo SMS é enviado somente para celulares;
  • Mensagens de massa (iguais) serão automaticamente priorizadas pelo sistema e adicionado um #ID_ENVIO ao final da mesma, afim de evitar bloqueios das Operadoras;
  • Todas as respostas a SMS serão enviados via POST a URL configurada em seu cadastro, no menu Meus Dados.

Parâmetros para envio do SMS

Nome Tamanho Tipo de dado Obrigatório?
telefone - varchar Sim. Formato: Código País + Código de Área + Telefone.
13 caracteres numéricos.
Ex.: 5531986251000
texto 160 varchar Sim. Caso envie SMS.
chave 100 varchar Sim.
identificador 100 varchar Opcional.
tel_retorno 255 varchar Opcional.
Ex.: 5531986251001

* Por padrão, todas as mensagens SMS enviadas esperam resposta do destinatário, e caso sejam respondidas pelo destinatário as respostas serão vinculadas ao último SMS enviado a ele. O vínculo é realizado pelo campo telefone da mensagem enviada com o telefone da mensagem de resposta. Portanto evite enviar várias perguntas/SMS (para um mesmo telefone) esperando uma resposta, tente realizar e aguardar uma resposta por vez (para um mesmo telefone).

* O parâmetro tel_retorno informa para qual telefone será enviado as respostas de quem responder as suas mensagens enviadas. Este recurso é gratuito e não gera custo.

 

Parâmetros de retorno da solicitação

Nome Descrição retorno
id_envio Identificador único da sua transação. Com este identificador que o buscar cep te retorna você pode consultar o status de suas transações.
resultado  
resultado_txt  

Variáveis de controle de resultado

resultado resultado_txt
1 sucesso
-2 chave inexistente
-3 texto invalido ou com caracteres especiais
-4 parametros incorretos
-9 numero celular invalido

#3 - Consultando status SMS

Tipo Formato URL
SMS https://buscarcep.com.br/ws3/?eid=NUMERO_ID_ENVIO&chave=Chave_Gratuita_BuscarCep
  • Todos os valores em negrito são obrigatórios.

Parâmetros para solicitação de status

Nome Tamanho Tipo de dado Obrigatório?
eid 10 int Sim.
chave 100 varchar Sim.

Parâmetros de retorno da solicitação

Nome Descrição retorno
id_envio ID do envio solicitado.
enviado "a" para aguardando; "s" para enviado e "e" para enviado.
ret_codigo "SMS_delivered" para entregue; "SMS_sent" para enviado; "Generic_failure" para erro; ou vazio.
data_registro Data da solicitação em formato americano.
data_envio Data de envio em formato americano.
identificador Identificador enviado na solicitação.
resultado  
resultado_txt  

Variáveis de controle de resultado

resultado resultado_txt
1 sucesso
-1 retorno nao encontrado

#4 - Consultando respostas de um SMS

Tipo Formato URL
SMS https://buscarcep.com.br/ws3/?eid=NUMERO_ID_ENVIO&resposta=s&chave=Chave_Gratuita_BuscarCep
  • Todos os valores em negrito são obrigatórios.

Parâmetros para solicitação de status

Nome Tamanho Tipo de dado Obrigatório?
eid 10 int Sim.
resposta 1 varchar Sim. Aceita "s".
chave 100 varchar Sim.

Parâmetros de retorno da solicitação

Nome Descrição retorno
id_resposta ID da resposta.
telefone Telefone da resposta.
resposta Texto da resposta.
data_registro Data da resposta.
resultado  
resultado_txt  

Variáveis de controle de resultado

resultado resultado_txt
1 sucesso
-1 resposta nao encontrada
 
 
     
www.buscarcep.com.br | política de uso | fale conosco | EUA um produto desenvolvido por
Host-Up Soluções Web