 Especificação Técnica | SMS | v2 |
| |
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/ws2/?telefone=5531986251000&texto=SEU_TEXTO&chave=Chave_Gratuita_BuscarCep&identificador=CLIENTE1
HTTPS/SSL Consultando status de SMS:
https://buscarcep.com.br/ws2/?eid=NUMERO_ID_ENVIO&chave=Chave_Gratuita_BuscarCep
CONSULTANDO CRÉDITOS:
https://buscarcep.com.br/ws2/?chave=Chave_Gratuita_BuscarCep |
|
#1 - Enviando SMS
| Tipo |
Formato URL |
| SMS |
https://buscarcep.com.br/ws2/?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, porém leia o ITEM #3 com atenção. |
| |
|
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 |
| -1 |
credito insuficiente |
| -3 |
chave inexistente |
| -4 |
parametros incorretos |
| -8 |
texto invalido ou com caracteres especiais |
| -9 |
numero celular invalido |
|
|
#2 - Consultando status SMS
- 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 |
|
#3 - Consultando respostas de um SMS
* Não conseguimos garantir que as respostas serão capturadas, por constantes error genéricos das operadoras de telefonia, portanto caso necessite desta resposta com 100% de confiança desaconselhamos o uso desta API e sugerimos o uso da API de SMS v3 - Envio do SMS pelo seu APP.
| Tipo |
Formato URL |
| SMS |
https://buscarcep.com.br/ws2/?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 |
|
acesso ao painel administrativo
