Manual de Utilização: Configuração de SMS
1. Configuração Geral
Esta é a primeira aba que se vê ao acessar a tela de “Configuração de SMS”. Aqui, você pode configurar os parâmetros gerais relacionados ao envio de SMS.
- API Habilitada?: Checkbox que indica se a API está habilitada ou não. Quando marcada, permite a comunicação com a API externa.
- Valor Unitário: Campo para informar o custo por SMS enviado. Exemplo: R$ 0,080.
- Chave API: Campo para inserir a chave de acesso à API. Assegure-se de que a chave é válida para garantir a comunicação. Exemplo: 9999999-8888-7777-aaaa-abcdef012345.
- Rota Preferencial: Dropdown menu que permite escolher a rota preferencial de envio do SMS. Por exemplo, se a sua empresa trabalha com diferentes operadoras ou serviços, você pode escolher qual deles é o principal.
- Documentação: Ícone/link para acessar a documentação relacionada à configuração de SMS. https://witi.me/documentacao/sms
2. Aba Avançado
Realize configurações avançadas no SMS da sua empresa. Nesta Aba voce poderá, indicar URLs para recepçao de callbacks, DLRs e MOs, indicar um JSON de classificação automática de respostas recebidas, indicar um SCRIPT C# a ser executado a cada resposta/MO recebido, indicar um SCRIPT C# a ser executado a cada submissão de nova mensagem feita pela API.
Callback: Habilite ou desabilite os callbacks/DLRs para sua empresa, caso estejam habilitados, preencha os campos URL DLR e URL MO com as respectivas URL. Estas URL serão chamadas toda vez que algum evento envolvendo suas mensagens ocorra.
2.1 Classificação
É possível realizar classificações automatizadas de cada resposta recebida, para isto, preencha o campo com um arquivo personalizado a sua escolha.
- Classificação Automática – JSON: Uma área onde é possível inserir regras em formato JSON para classificação automática de mensagens recebidas.
Exemplo:
[
{
"TextoPesquisa": "NAO",
"TipoCorrespondencia": 0,
"prioridade": 0,
"Enabled": true,
"Nome": "exata_1",
"Tag": "ignorar",
"Acao": "ignorar"
},
{
"TextoPesquisa": "NO",
"TipoCorrespondencia": 0,
"prioridade": 0,
"Enabled": true,
"Nome": "exata_2",
"Tag": "ignorar",
"Acao": "ignorar"
},
{
"TextoPesquisa": "NCO",
"TipoCorrespondencia": 0,
"prioridade": 0,
"Enabled": true,
"Nome": "exata_3",
"Tag": "ignorar",
"Acao": "ignorar"
},
{
"TextoPesquisa": "SIM",
"TipoCorrespondencia": 0,
"prioridade": 0,
"Enabled": true,
"Nome": "exata_4",
"Tag": "LEAD",
"Acao": "LEAD"
},
{
"TextoPesquisa": "QUERO",
"TipoCorrespondencia": 0,
"prioridade": 0,
"Enabled": true,
"Nome": "exata_5",
"Tag": "LEAD",
"Acao": "LEAD"
},
{
"TextoPesquisa": "aceito",
"TipoCorrespondencia": 0,
"prioridade": 0,
"Enabled": true,
"Nome": "exata_6",
"Tag": "LEAD",
"Acao": "LEAD"
},
{
"TextoPesquisa": "OK",
"TipoCorrespondencia": 0,
"prioridade": 0,
"Enabled": true,
"Nome": "exata_7",
"Tag": "LEAD",
"Acao": "LEAD"
},
{
"TextoPesquisa": "SIM.",
"TipoCorrespondencia": 0,
"prioridade": 0,
"Enabled": true,
"Nome": "exata_8",
"Tag": "LEAD",
"Acao": "LEAD"
},
{
"TextoPesquisa": "(VTC|CHUPA|VTNC|TOMAR NO|ARROMBADO|CUZAO|MEU OVO|MINHA ROLA|NO CU|PUTA|CACETE|VAI |BOSTA|PRESIDIO|SPAM|MERDA|FUCK|FOCK|FODAS|MORREU|FALECEU|FALECIDO|SEU CU|FODA.SE|CARALHO|SE FUDE|BUCETA)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_9",
"Tag": "blackList",
"Acao": "blackList"
},
{
"TextoPesquisa": "(VSF|VSFD)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_10",
"Tag": "blackList",
"Acao": "blackList"
},
{
"TextoPesquisa": "(SAIR|CANCELAR|PARE|PARA|PARAR|EXCLUIR|EXCLUSAO|EXCLUAM|TIREM|REMOVER|STOP|DESCADASTRAR|GOLPE|NAO QUERO MAIS|NAO AGUENTO|RETIRAR|EXIT)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_12",
"Tag": "blackList",
"Acao": "blackList"
},
{
"TextoPesquisa": "(LGPD|POLICIA|PROCESSO|PRIVACIDADE|PROCON)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_13",
"Tag": "blackList",
"Acao": "blackList"
},
{
"TextoPesquisa": "(NAO|N\\+UO|NO|N0|NCO)(AUTORIZO|QUERO|ACEITO)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_14",
"Tag": "blackList",
"Acao": "blackList"
},
{
"TextoPesquisa": "(IDIOTA|BABACA|PALHACO|FDP|PUTA|VAGABUNDO)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_15",
"Tag": "blackList",
"Acao": "blackList"
},
{
"TextoPesquisa": "(N\\+UO SOU|NAO E|NAO SOU|KKK|NUNCA)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_16",
"Tag": "ignorar",
"Acao": "ignorar"
},
{
"TextoPesquisa": "(N\\+UO|NAO|NCO|NOo|N\\+O|N A O|N\\+UO|N\\+AO|NENHUM|NO|N0)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_17",
"Tag": "ignorar",
"Acao": "ignorar"
},
{
"TextoPesquisa": "(SEU CELULAR TEM)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_18",
"Tag": "ignorar",
"Acao": "ignorar"
},
{
"TextoPesquisa": "(ESSE NMERO N0 @)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_19",
"Tag": "ignorar",
"Acao": "ignorar"
},
{
"TextoPesquisa": "(ONDE CO SEGUIU MEU NUMERO ?)",
"TipoCorrespondencia": 1,
"prioridade": 100,
"Enabled": true,
"Nome": "expressaoRegular_20",
"Tag": "ignorar",
"Acao": "ignorar"
}
]- TESTAR PROCESSAMENTO: Área destinada a testar a classificação e o processamento. Campos incluem “Origem”, “Data”, “Cod. Msg. Enviada”, “Texto Recebido”, entre outros.
- Atenção!: Uma nota importante sobre a necessidade de testar o processamento antes de salvar alterações.
2.2 Script MO
Este é o script que será executado para cada resposta de SMS recebida.
- Script MO – Código (C#): Uma área de texto para inserção do código personalizado em C#. Aqui, é possível visualizar e editar o código que processa as mensagens de resposta. Exemplo:
Boolean OnExecute(izLeads.Business.CSScriptHelperSMS helper,
izLeads.Business.Data.Public.Sms_resposta resposta,
izLeads.Business.Data.Public.Sms_resposta_tratamento tratamento)
{
Boolean retorno = false;
try
{
helper.Debug("Resposta Recebida");
helper.Debug(String.Format("id={0}, From={1}, To={2}, RemoteId={3}, " +
"dataRecepcao={4:dd/MM/yyyy hh:mm:ss}, idEmpresa={5}, classificacao={6} -> {7}",
resposta.idResposta,
resposta.From,
resposta.To,
resposta.RemoteID,
resposta.DataRecepcao,
resposta.IdEmpresa,
resposta.Classificacao,
resposta.Mensagem
));
// seu codigo
String ChaveAPI = "<<coloque sua chave de api>>";
helper.SMSService_APIURL = "https://apidb.witi.me/sms/send.aspx?chave=" + ChaveAPI;
// Exemplo de envio de SMS genérico
if(tratamento.Acao == "LEAD")
{
int idRota = 456;
// Descomente para enviar uma resposta
// helper.EnviaSMS("Boa noite", resposta.From, idRota, null);
}
tratamento.Tratado = true;
// para responder a teste sms, pela mesma rota,
// preencha esta variavel
tratamento.ResponderTexto = "Resposta 123";
retorno = true;
}
catch(Exception ex)
{
helper.Debug(ex);
}
finally
{
helper.Debug("Fim OnEvaluate");
}
return retorno;
}
Exemplo de Utilização:
Enviar uma mensagem de resposta: Voce pode enviar uma mensagem de resposta ao seu cliente, dependendo do conteudo do MO recebido.
Informar um CRM: Voce pode fazer uma chamada de HTTP transmitindo este MO para um sistema de CRM externo.
2.3 Script API Submit
Este é o script que será executado no momento do envio da mensagem para a API.
- Script OnSubmit MT – Código (C#): Uma área de texto para inserção do código personalizado em C#. Aqui, você pode visualizar e editar o código que processa o envio de mensagens para a API. Exemplo:
Boolean OnExecute(izLeads.Business.CSScriptHelperSMS helper,
izLeads.Business.Data.Public.Sms_mensagem Mensagem)
{
Boolean retorno = false;
try
{
helper.Debug("Mensagem Submetida");
helper.Debug(String.Format("numero={0}, mensagem={1}\nUniqueID={2}, Rota={3}, " +
"Codigo_cliente={4}, TagModelo={5}, idDisparo={6}",
Mensagem.numero,
Mensagem.mensagem,
Mensagem.UniqueID,
Mensagem.Rota,
Mensagem.Codigo_cliente,
Mensagem.TagModelo,
Mensagem.idDisparo
));
// Mensagem.mensagem = DateTime.Now.ToString();
retorno = true;
}
catch(Exception ex)
{
helper.Debug(ex);
}
finally
{
helper.Debug("Fim OnEvaluate");
}
return retorno;
}
Atenção!: Uma nota importante sobre a necessidade de testar o processamento antes de salvar alterações.
Exemplo de Utilização:
- Correçao da mensagem de entrada: Pode acontecer do sistema que voce utiliza para enviar esta mensagem seja de um terceiro, e que voce não tenha acesso a altera-lo diretamente. Assim, este SCRIPT permite que voce intercepte a mensagem entrante vinda do programa externo, e faça as alterações que julgar necessário.
Dicas Gerais:
- Salvar Alterações: Não se esqueça de clicar no botão “Salvar Alterações” após fazer qualquer modificação. Isso garantirá que suas configurações sejam aplicadas.
- Consultar Documentação: Ao enfrentar qualquer dificuldade, consulte a documentação ou entre em contato com a equipe de suporte técnico.
- Testes: Antes de implementar qualquer configuração em um ambiente de produção, faça testes em um ambiente de desenvolvimento ou sandbox para garantir o correto funcionamento.
Esperamos que este manual ajude você a configurar e entender todas as opções disponíveis na tela de “Configuração de SMS”. Se tiver dúvidas adicionais, não hesite em buscar suporte. Boa configuração!