Manual de Envio de Torpedos SMS Comtele. Introdução Cadastrar um Grupo Inserir ou Importar Contatos Ordem de envio...

Transcrição

1 Manual de Envio de Torpedos SMS Comtele Índice Introdução Cadastrar um Grupo Inserir ou Importar Contatos Ordem de envio Criar e Enviar uma Mensagens Salvando Mensagens de Envio no Sistema Agendamento de Envio Relatórios Opções de Conta Dados parautilização da API Geração de Código e Utilização Agendamento de SMS via API Obter Respostas de SMS via API Exemplo de código fonte em PHP Exemplo de código fonte em Java Web Service

2 Manual de Envio de Torpedos SMS Comtele Neste manual serão descritos todos os passos para enviar SMS através da interface no site ou através da API. Figura 01 Tela inicial de Após fazer o login você terá acesso a ferramenta de envio de Torpedos SMS, a tela de boas vindas informa qual é o seu login e o saldo atual conforme visto na Figura 02. 2

3 1. Cadastrar um Grupo Figura 02 Tela de Boas Vindas O próximo passo é criar Grupos para organização dos contatos, clique em Agenda em seguida na aba Grupos, insira o nome do grupo e uma breve descrição, depois clique no botão Salvar. Figura 03 Agenda -> Grupos 3

4 Depois de clicar no botão Salvar, o grupo será adicionado na tabela logo abaixo: Figura 04 Criação de grupos Para editar ou excluir um grupo, na aba Gruposclique no nome do grupo em que você quer fazer a alteração ou apagar. Figura 05 Agenda -> Grupos -> Nome 4

5 Em seguida, você tem a opção de editar o nome, a descrição ou excluir o grupo, para editar, faça as alterações que desejar e clique em salvar. Figura 06 Edição de grupos Ao salvar, a página é redirecionada para a guia Grupos com a mensagem de sucesso e o conteúdo do grupo já alterado. Figura 07 Atualização de grupos 5

6 Para excluir clique novamente no nome do grupo, a seguir clique no botão Excluir,aparecerá uma mensagem confirmando se você deseja excluir, clique em Ok. Figura 08 Exclusão de grupo 6

7 2.Inserir ou Importar Contatos Na opção Agendaclique na guia Cadastrar Contatos, No campo personalizado digite algo caso futuramente deseje enviar uma mensagem personalizada para esse contato,depois insira o número do celular (somente celular),selecione um grupo que o usuário vai pertencer e clique no botão Salvar.Caso o contato pertença à mais de um grupo, cadastre ele novamente selecionando o outro grupo. Figura 09 Agenda -> Cadastrar Contatos Após cadastrar o contato, você irá ver a seguinte mensagem de sucesso: Registro inserido com sucesso! Figura 10 Cadastro de contatos 7

8 Além de cadastrar cada contato individualmente, você tem a opção de importar vários contatos de uma só vez.este método permite você carregar um arquivo.txt ou.csv (formato de arquivo dobloco de Notas ou do MicrosoftExcel) com todos os seus contatos e inseri -los no sistema sem ter que cadastrar os contatos de um em um. Para isso você deve montar o arquivo com o seguinte padrão: Figura 11 Lista de contatos (Bloco de notas) NOTA: Figura 12 Lista de contatos (Excel) Para salvar o arquivo na extensão.csv não se esqueça de Salvar Como > CSV ( arquivo do excel separado por vírgulas ) (*.csv). 8

9 2.1. Ordem de envio Com o arquivo de importação dos contatos já pronto, no menu Agenda, clique na guia Carregar Contatos, selecione o arquivo que você criou, escolha o grupo em qual os contatos do arquivos serão carregados e clique no botão Carregar. Figura 13 Carregar contatos Se tudo der certo, você verá a tela abaixo, caso contrário, veja se os contatos que você está adicionandojá não estão adicionados ou verifique cuidadosamente o arquivo que contém os contatos, caso ele esteja incorreto, os arquivos não serão adicionados. Figura 14 Adicionando arquivos de contatos 9

10 Para buscar e visualizar os contatos que foram adicionados, no menu Agenda clique na aba Filtro,você tem duas formas para buscar contatos, escreva o nome do contato que você quer buscar ou selecione o Grupoe clique no botão Procurar. Figura 15 Filtrar contatos Feito isso, os contatos serão listados na tabela logo abaixo, contendo nome, celular, e- mail e o grupo em que os contatos foram adicionados. Figura 16 Lista de contatos carregada Para alterar os dados de um contato, no menu Agenda, clique aba Filtro, faça uma busca do contato e clique no nome dele. 10

11 Figura17 Agenda -> Filtro -> Editar contato Modifique o seu conteúdo, em seguida clique no botão Salvar.A página será redirecionada para a guia Filtrocom a seguinte mensagem de sucesso: Registro atualizado! Figura 18 Alterar contato Para excluir um contato, no menu Agenda, clique aba Filtro e faça uma busca do contato, a seguir, na tabela que os dados são exibidos, clique no Nomedo contato, na tela que abrirá, confira os dados do contato e veja se é ele mesmo que você quer excluir, após a confirmação clique no botão Excluir. 11

12 Figura 19 Agenda -> Editar contato -> Excluir Confirme a mensagem de exclusão, você será redirecionado para a aba Filtronovamente com a mensagem de sucesso: Registro Excluido! Figura 20 Exclusão de contato 12

13 3. Criar e Enviar uma Mensagens Para enviar uma mensagem, insira o seu login no campo De(seu código de cliente, ex: 50000, visto que este campo é para identificar o seu envio na base da operadora ), deixe o campo Para(Campo para digitar os números ) em branco, selecione o grupo ou grupos que você deseja fazer o envio, para utilizar a personalização na mensagem, clique no botão Personalizado, note que no campo Mensagem será adicionado um conteúdo referente ao botão que você clicou, feito isso, verifique se sua mensagem está correta, pronta para ser enviada, e clique no botão Enviar SMS. Caso você queira enviar a mensagem apenas para alguns contatos no campo Para digite os números dos celulares junto com seu respectivo DDD, caso for enviar para mais de um numero após digitá-los coloque vírgula (,)e logo em seguida digite o outro numero( Por exempo , ). Ou então selecione o grupo ou os grupos no qual deseja enviar os sms. Depois digite o conteúdo da mensagem e clique em Enviar SMS Figura 21 Compor mensagem NOTA: Não preencha o campo PARA quando você estiver utilizando um GRUPO e não selecione um GRUPO quando você estiver utilizando o campo PARA que é destinado para envios avulsos. 13

14 4. Salvando Mensagens de Envio no Sistema Esse procedimento permite que você salve suas mensagens na interface de sms podendo utiliza-la quantas vezes necessitar sem ter que escrevê-las novamente. Primeiro Passo. Selecione no Menu a opção Configurações depois selecione a aba Mensagens configuradas como mostra a figura abaixo. Realize o cadastro da Mensagem como indica a figura abaixo,você deve preencher os campos Campanha com um nome que represente a mensagem e em seguida preencha o campo Mensagem onde deve constar o conteúdo que será enviado em sua campanha de sms. Figura 22 Cadastro de Mensagem Após a realização dos procedimentos acima, clique no botão Salvar para cadastrar a mensagem ou em Limpar para preencher novamente. A imagem abaixo mostra a mensagem de cadastro com sucesso. 14

15 Figura 23 Cadastro de Mensagem Apos essa etapa caso já deseje enviar uma campanha com esta mensagem clique encima do nome na Campanha no caso Teste Campanha e altere a opção Status para Ativo como mostra a figura abaixo e clique em Salvar ou caso queira Excluir clique no botão Excluir. Figura 24 Cadastro de Mensagem - Ativando Realizado o procedimento acima clique no Menu Enviar SMS e lá estará a mensagem cadastrada por estar com status ATIVA, caso deixe a mensagem cadastrada como INATIVA o campo mensagem irá permanecer em branco. 15

16 Figura 25 Cadastro de Mensagem -Painel 5. Agendamento de Envio Após inserir a mensagem desejada você pode contar com a opção de agendamento de envio, basta selecionar o campo Agendar Para *como mostra a figura abaixo. Figura 26 Mensagem -> Compor Mensagem -> Agendar para* 16

17 Em seguida clique em Enviar SMS e a mensagem será envida. Figura 27 Mensagem enviada Para enviar mensagens sem ter que cadastrar os contatos na agenda, insira o código de cliente, ex: no campo De,preencha o campo Para: com os telefones que deseja enviar, no campo Grupo, selecione Nenhum, escreva sua mensagem e clique no botão Enviar. Figura 28 Enviar mensagem para contato 17

18 6.Relatórios Para ter o controle de quantos torpedos já foram enviados, você pode visualizar os relatórios, clique no menu Relatórios, antes de gerar um relatório é necessário selecionar o período que você quer ver os envios, selecione a data inicial e a data final clicando no ícone de calendário em seguida clique no botão Gerar Relatório. Figura 29 Gerar relatório de envio Após clicar no botão Gerar Relatório, será exibido um relatório detalhado constando Data, Hora e Número de Destino de cada disparo. 18

19 7.Opções de Conta Figura 30 Relatório gerado Para fazer alteração de algum dado cadastral no menu Configurações, clique em Editar meus dados, insira seus novos dados e clique no botão salvar, somente o campo nome não é alterável. Figura 31 Edição de contatos Ainda no menu Configuração, na aba Senha você tem a opção de alterar a sua senha. Digite sua nova senha no campo Senhae confirme no campo Repita Senha, emseguida clique no botão Alterar. 19

20 Figura 32 Alterar senha 8. Dados parautilização da API Geração de Código e Utilização Envio: 1- Solicitar a seguite URL um ID: &pwd=senha 2- Enviar o Torpedo SMS com a seguinte URL =Origem&msg=Mensagem&number=Destino ID: ID fornecidopeloprimeiropasso. Origem: Remetente Mensagem: Conteúdo da mensagem. Destino: Número para onde será enviado o torpedo, caso for enviado para mais de um, deverão ser separados por vírgulas. O padrão de envio é DDD+Número. Ex: , , * ERR_00 : Usuário Inativo * ERR_01 : Erro no Relatório * ERR_02 : Sem Crédito * ERR_03 : Créditos Expirados ConsultarSaldo: VisualizarRelatório egin=data1&dt_end=data2&mode=mode ID: ID fornecidopeloprimeiropasso. DATA1: Data inicial do relatório. Formato YYYY-MM-DD DATA2: Data final do relatório. Formato YYYY-MM-DD MODE:resume :RelatórioResumido MODE:detail :RelatórioDetalhado

21 Ex: _begin= &dt_end= &moe=detail 9. Agendamento de SMS via API O_DO_ID"&from=FROM&msg=MENSAGEM&number=TELEFONES_SEPARADO_POR_VIRGU LAS&sch_date=YYYY-MM-DD&sch_hour=HH:MM Parâmetros: ID: proveniente da chamada get_id FROM: Campo DE MSG: Mensagem texto (lembre-se que todos os caracteres deverão estar no padrão URL_ENCODE) NUMBER: Telefones separados por vírgula lembrando que a limitação é só da URL SCH_DATE: Data de agendamento no seguinte formato (YYYY-MM-DD) SCH_HOUR: Hora do agendamento no formato (HH:MM) Todos os campos são obrigatórios na API, porém caso não seja especificado os parâmetros sch_date e sch_hour será assumido de forma padrão como mensagem instantânea. 10. Obter Respostas de SMS via API XXXXXXXXXXXXXXXXXXXXXXXXXX&from=CPF_Cliente&msg=TesteAPI&number= Quando enviar uma mensagem pela API, deve-se mandar no campo from o nome do que deseja obter no campo reposta no relatório, podendo ser utilizado o nome de uma chave de tabela para inserir as informações em um banco de dados posteriormente. No exemplo acima, a informação que será enviada é CPF_Cliente Os demais campos podem ser enviados normalmente, o que importa neste caso é o campo from, pois é a partir dele que será filtrado o retorno. Desta forma as informações recebidas serão apresentadas no campo CPF_Cliente no relatório. Para obter o retorno, basta utilizar a URL: XXXXXXXXXXXXXXXXXXXXXXXXXX&dt_begin= &dt_end= &mode=_answer 21

22 Neste caso o importante é passar o campo mode como _answer para que seja retornado apenas as mensagens que possuem resposta e também o campo From no relatório. O relatório será retornado no formado CSV. Depois é só buscar dentre os registros retornados e filtrar pelo campo from, que no caso possui a chave da tabela,e realizar o que for preciso tendo em mãos a chave informada desde o envio da mensagem. 11. Exemplo de código fonte em PHP Abaixo segue um exemplo em código PHP para integração com a API. <html> <head> <title>exemplointegracao API</tilte> </head> <body> <form name="formapi" action=" <input type="hidden" name="fuse" value="send_msg"> <input type="hidden" name="id" value="valor_do_id"> <p> <input type="text" name="from" id="from"><br /> <input type="text" name="number" id="number"><br /> <input type="text" name="msg" id="msg" maxlength="159"><br /> <input type="submit" name="enviar" value="enviar"> </p> </form> </body> </html> Lembre-se que este é um simples exemplo, é necessário obter o ID pelo método já descrito acima. 22

23 12.Exemplo de código fonte em Java Abaixo segue um exemplo em código Java para integração com a API. /* * To change this template, choose Tools Templates * and open the template in the editor. */ package url_sender; import java.io.bufferedreader; import java.io.inputstreamreader; import java.net.url; /** * Sato */ public class Url_sender { /** args the command line arguments */ public static void main(string[] args) throws Exception{ // TODO code application logic here URL yahoo = new URL(" d=#password"); } } try (BufferedReader in = new BufferedReader( } new InputStreamReader( yahoo.openstream()))) { String inputline; while ((inputline = in.readline())!= null) System.out.println(inputLine); 23

24 13. Web Service Segue abaixo um exemplo para utilização da Web Service. public static void Main (string[] args) { ArrayList list = new ArrayList(); string [] numbers = new string[3]; numbers[0] = "numerodestino1"; numbers[1] = "numerodestino2"; numbers[2] = "numerodestino3"; if(api.connectapi("usuario", "senha")){ foreach(string s in numbers){ list.add(api.sendmsg("este é um exemplo pra uso do webservice Comtele", s, "Comtele")); } } foreach (string s in list) Console.WriteLine (s); } 24