Manual de Integração. SMSGold

ÍNDICE 1. Envio através do arquivo XML....3 2. Como funciona....3 3. Descrição do arquivo...3 4. Distribuição do arquivo....4 5. Tipos de distribuição do arquivo....4 6. Padrão de data e hora...5 7. Modelos de envio....5 Copyright 2015. Todos os direitos reservados. Página 2

1. Envio através do arquivo XML. Possuímos um processo para envio de SMS em massa através de uma importação simples de um Arquivo XML contendo as informações de Campanha, dos SMSs e da Distribuição dessa carga. 2. Como funciona. O Sistema recebe arquivo XML com as informações para envio (listadas abaixo), e publica no FTP que disponibilizamos. O irá importar o arquivo, criar a campanha e iniciar os envios de acordo com a distribuição, sem a necessidade de realizar a configuração da campanha via portal. Porém o acompanhamento da mesma continuara sendo através do Portal. 3. Descrição do arquivo. Arquivo: < smsgold > Inicio do Arquivo </ smsgold > Final do Arquivo Em: <autenticacao> <usuario>usuário utilizado no portal </usuario> <senha>senha utilizada no portal </senha> </autenticacao> Em: <campanha> <descricao>nome da campanha</descricao> <centrocusto>código do Centro de custo a ser utilizado (Caso não possuir centro de custo informe 0)</centrocusto> <receber_teste>s</receber_teste> (S para receber o teste, e N para não receber o teste) <ddd_teste>ddd</ddd_teste> (Caso queira receber um SMS de teste, caso contrário informe 0). <telefone_teste>telefone</telefone_teste> (Caso queira receber um SMS de teste, caso contrário informe 0). <enviar_whatsapp>s</enviar_whatsapp>(s para enviar a carga para quem possui WhatsApp, e N só enviar via SMS) <excluir_sem_whatsapp>s</excluir_sem_whatsapp>(s para enviar a carga somente para quem possui WhatsApp excluindo os que não possuem, e N para também enviar via SMS para quem não possua Whatsapp) </campanha> Copyright 2015. Todos os direitos reservados. Página 3

Em: <mailing>(sms's a serem enviados. Para cada cliente deve conter obrigatoriamente) <sms> <ddd>ddd do telefone movel</ddd> <telefone>numero do telefone movel</telefone> <mensagem>mensagem exata que deverá ser enviada</mensagem> <codigo>código chave da pessoa</codigo> </sms> OBS: Este "bloco" de informações é obrigatório para cada telefone móvel destino. </mailing> (Finaliza o bloco de informações dos clientes) 4. Distribuição do arquivo. Este "bloco" de informações é responsável pelo agendamento de SMS através de lotes. Esses lotes podem ser enviados no mesmo dia, ou nos dias seguintes, não é permitido agendamentos em atraso. Em <distribuicao> <lote>(os campos abaixo são obrigatórios e de acordo com a distribuição) <tipodistribuicao>(detalhado abaixo item 5)</tipodistribuicao> <quantidade>(quantidade de SMS's agendados para esse lote)</quantidade> <data>(data de Agendamento)</data> <horario_inicio>(horário de Inicio)</horario_inicio> <horario_fim>(horário de Término)</horario_fim> <intervalo>(intervalo regular de disparo no período)</intervalo> </lote> </distribuicao> 5. Tipos de distribuição do arquivo. - Agora : envio imediato. Obrigatório apenas a quantidade de SMSs para o lote. - As : Agendamento com apenas horário de inicio. Obrigatório informar o <horario_inicio> - Entre : Agendamento com inicio, término de envio e intervalos. Obrigatório informar <horario_inicio>, <horario_fim> e <intervalo>. OBS: O Campo intervalo tem o padrão em minutos. Copyright 2015. Todos os direitos reservados. Página 4

6. Padrão de data e hora. - Data: dd/mm/aaaa - Hora : hh:mm 7. Modelos de envio. Determinando a hora de envio. <?xml version="1.0" encoding="iso-8859-1"?> <smsgold> <autenticacao> <usuario>xxx</usuario> <senha>*****</senha> </autenticacao> <campanha> <descricao>campanha Teste /descricao> <centrocusto>7</centrocusto> <receber_teste>s</receber_teste> <ddd_teste>11</ddd_teste> <telefone_teste>xxxxxxxxx</telefone_teste> </campanha> <mailing> <sms> <ddd>11</ddd> <telefone> XXXXXXXXX </telefone> <mensagem>mensagem de Teste</mensagem> </sms> <sms> <ddd>13</ddd> <telefone> XXXXXXXXX </telefone> <mensagem>mensagem de Teste</mensagem> </sms> </mailing> <distribuicao> <lote> <tipodistribuiacao>as</tipodistribuiacao> <quantidade>2</quantidade> <data>dd/mm/aaaa</data> <horario_inicio>10:00</horario_inicio> </lote> Copyright 2015. Todos os direitos reservados. Página 5