LIBERTY SMS MANUAL DE INTEGRAÇÃO 1.1

Transcrição

1 LIBERTY SMS MANUAL DE INTEGRAÇÃO 1.1 A integração com o sistema Liberty SMS é feita através de XML Web Services, via internet ou link dedicado. No endereço está a lista de comandos disponíveis para comunicação com o sistema via webservices. Os Exemplos estão no site disponível para download. COMANDOS DISPONÍVEIS PARA WEBSERVICES: SearchStatusSMS Retorna os Status das mensagens transmitidas. SearchStatusSMS2 Retorna os Status das mensagens transmitidas. 1

2 SearchStatusSMSNotRead Retorna os Status das mensagens transmitidas que ainda não foram lidas e marca COMO LIDOS. Se houverem 400 linhas, pode haver mais mensagens não lidas, a função deve ser chamada novamente com os mesmos parâmetros até que a mesma retorne vazio. RETORNO: Array de string de tamanho máximo de 400 linhas SearchStatusSMSNotRead2 Retorna os Status das mensagens transmitidas que ainda não foram lidas e marca COMO LIDOS. Se houverem 400 linhas, pode haver mais mensagens não lidas, a função deve ser chamada novamente com os mesmos parâmetros até que a mesma retorne vazio. RETORNO: Array de string de tamanho máximo de 400 linhas SearchResponseSMS Retorna as respostas das mensagens transmitidas. 2

3 PHONE; SENDEDDATE; SENDRECEIVED; MESSAGE SearchResponseSMS2 Retorna as respostas das mensagens transmitidas. PHONE; SENDEDDATE; SENDRECEIVED; MESSAGE SearchCostsSMS Retorna os Custos das mensagens transmitidas. SENDEDDATE; PHONE; STATUS; VALOR CreateCampaign Para criação da Campanha. name (STRING) com até 100 caracteres. description (STRING) com até 2000 caracteres. RETORNO: (INT) CAMPAIGNID ou 0 para Falha. 3

4 GetCampaign Retorna todas as Capanhas criadas para esse cliente. CAMPAIGNID; NAME CreateLot Para criação do Lote. campaignid (INT) name (STRING) com até 100 caracteres. description (STRING) com até 2000 caracteres., parâmetro opcional. message (STRING) com até 160 caracteres, parâmetro opcional. RETORNO: (INT) LOTID ou 0 para Falha CreateContacts Cria contatos para envio do SMS. lotid (INT) phone (STRING) Com até 11 caracteres., parâmetro opcional. Parameters Array de string, separados por ; CreateContacts2 Cria contatos para envio do SMS. 4

5 lotid (INT) arrcontacts Array de string e no formato PHONE;SCHEDULEDATE;...;... PHONE; SCHEDULEDATE - formato YYYY-MM-DD HH:MM:SS, parâmetro opcional PARAMS Ex: ; :00:00;Maria da Silva;R$ 5000, ;;Maria da Silva;R$ 5000,00 canstartlot (INT) 0 para NÃO iniciar o lote e 1 para Iniciar StartLot Habilita o lote a iniciar, de acordo com o agendamento. lotid (INT) SendSMS Cria uma mensagem individual. campaignid (INT), parâmetro opcional. phone (STRING) Com até 11 caracteres message (STRING) com até 160 caracteres. 5

6 SendSMS2 Cria uma mensagem individual. campaignid (INT), parâmetro opcional. phone (STRING) Com até 11 caracteres message (STRING) com até 160 caracteres. DelSchedulingSMS Deleta uma mensagem agendada. RETORNO : (INT) 0 para Sucesso ou 1 para Falha. ChangePassword Troca a senha do usuário. newpassword (STRING) Com até 18 caracteres alfanuméricos, diferente da senha anterior. 6