Buscando a praticidade na integração do seu sistema com o nosso, a Papo consultou desenvolvedores, pesquisou concorrentes e avaliou tecnologias, para

Transcrição

1 v1.0

2 Buscando a praticidade na integração do seu sistema com o nosso, a Papo consultou desenvolvedores, pesquisou concorrentes e avaliou tecnologias, para criar um web service de integração rápido e simples.

3 Send: Agenda um ou mais SMS para envio &pass=senha123 &numbers= ; &message=feliz ano novo com a Papo &alert=false &date= :59 &format=html Search: Obtém uma lista de SMS do sistema &pass=senha123 &date_start= :00 &date_end= :59 &numbers= ; &ids=17;44;780;56 &status=recebido &format=html

4 Send: Agenda um ou mais SMS para envio URL: user: pass: numbers: message: alert: date: format: registrado no sistema da papo Exemplo: Senha registrada no sistema da papo Exemplo: MinhaSenha123 Lista de celulares separados por ; para o envio do SMS Formato: ddnnnnnnnnn (DDD + Numero do telefone) Exemplo: ; ; ; Mensagem a ser enviada, com até 140 caracteres Exemplo: Feliz ano novo com a Papo. (Opcional) Define se o SMS será enviado como alerta ou SMS normal Possibilidades: true (Envia uma mensagem de alerta e não um SMS) false (Envia um SMS tradicional) Padrão: false (Opcional) Define a data e hora de agendamento para o envio da mensagem Formato: yyyy-mm-dd hh:nn (ano-mês-dia hora:minuto) Padrão: data e hora corrente no servidor Exemplo: :59 (Opcional) Define o formato que o web service vai retornar o resultado Possibilidades: html (Html formatado como uma página) xml (Xml contendo os dados) json (Json contendo os dados) Padrão: html

5 Retorno: Retorno da chamada ao web service SEND" result: error: label: ids: rejecteds: Resultado da requisição boolean possibilidades: true (Foi processado com sucesso) false (Foi detectado algum erro) Código do erro, caso o valor de result" seja "false" integer possibilidades: 1 (Nenhum número válido) 2 (Saldo insuficiente) 3 (Mensagem maior que 140 caracteres) 4 (Usuário ou Senha inválido) 5 (Data com formato inválido) 6 (Falta de campo obrigatório) Descrição textual do resultado string Lista de SMS registrados array de array formato: [[id, number], ] id: integer number: ddnnnnnnnnn (DDD + Numero do telefone) Lista de SMS rejeitados array formato: [number, ] number: ddnnnnnnnnn (DDD + Numero do telefone)

6 Search: Obtém uma lista de SMS do sistema URL: user: pass: registrado no sistema da papo Exemplo: Senha registrada no sistema da papo Exemplo: MinhaSenha123 date_start: (Opcional) Define a data e hora inicial do filtro Formato: yyyy-mm-dd hh:nn (ano-mês-dia hora:minuto) Exemplo: :00 date_end: (Opcional) Define a data e hora final do filtro Formato: yyyy-mm-dd hh:nn (ano-mês-dia hora:minuto) Exemplo: :59 numbers: (Opcional) Define a lista de celulares separados por ; para o filtro Formato: ddnnnnnnnnn (DDD + Numero do telefone) Exemplo: ; ; ; ids: status: format: (Opcional) Define a lista de IDs separados por ; para o filtro Exemplo: 17;73;81;549 (Opcional) Define o status para o filtro Possibilidades: agendado (Mensagem agendada mas ainda não enviada) enviado (Mensagem já enviada para o destinatário) confirmado (Mensagem com recebimento confirmado) recebido (Mensagem enviada para sua conta) (Opcional) Define o formato do retorno da requisição Possibilidades: html (Html formatado como uma página) xml (Xml contendo os dados) json (Json contendo os dados) Padrão: html

7 Retorno: Retorno da chamada ao web service SEARCH" date: sent: received: Data e hora do filtro realizado Tipo: Data Formato: yyyy-mm-dd hh:nn (ano-mês-dia hora:minuto) Lista de SMS enviados compatíveis com o filtro array de array formato: [[id, sender, receiver, message, date, comfirmed, status], ] id: integer number: ddnnnnnnnnn (DDD + Numero do telefone) message: string date: yyyy-mm-dd hh:nn (ano-mês-dia hora:minuto) confirmed: yyyy-mm-dd hh:nn (ano-mês-dia hora:minuto) status: string (agendado / enviado / confirmado) Lista de SMS recebidos compatíveis com o filtro array de array formato: [[id, number, message, date], ] id: integer number: ddnnnnnnnnn (DDD + Numero do telefone) message: string date: yyyy-mm-dd hh:nn (ano-mês-dia hora:minuto)

8