Curitiba DOCUMENTAÇÃO WebService PGSMS e PG Versão 1.0

Transcrição

1 Curitiba DOCUMENTAÇÃO WebService PGSMS e PG Versão 1.0

2 Sumário 1. REQUISIÇÕES RESPOSTAS API PG MÉTODOS... 3 Nome: envioavulso... 3 Nome: getstatusporagrupador API PGSMS MÉTODOS... 6 Nome: enviodecampanha... 6 Nome: envioavulso... 7 Nome: getstatusavulso... 8 Nome: getstatusavulsoentredatas... 9 Nome: getretorno... 9 Nome: getresposta Nome: validatelefone Versão 1.0 Última alteração: 21/06/2016 Página 2 de 11

3 1. Requisições Todas as requisições são feitas por utilizando protocolo SOAP. 2. Respostas Tipo do retorno XML ou JSON, valor default XML. 3. API PG wsdl: Tipos Complexos: Toda de data deve respeitar o formato: (ano-mes-dia hora:minuto:segundo) Variável valor valor que será utilizado como variável Métodos Nome: envioavulso Objetivo: Método para envio de mensagens avulsa. Assinatura: envioavulso($, $cod_template, $cod_carteira, $ , $titulo, $dadosvariaveis, $nomearquivo=null, dadoadicional=null, $agrupador=null) Retorno: Retorna um ID único para referencias futuras. Autenticação da empresa, utilizado em todos os métodos. cod_template Código da template, seu cadastro é feito pelo painel de ( e deve ser único na empresa. Versão 2.4 Última alteração: 21/06/2015 Página 3 de 11

4 cod_carteira Codigo da carteira, seu cadastro é feito pelo painel de ( e deve ser único na empresa. Endereço de . titulo Assunto do s, o template ja possui título, deixar vazio. dadosvariaveis array de variavel, os valores serao substituidos no template na ordem -var1- -var2- -varx-. nomearquivo nome do arquivo com extensão para ser enviado em anexo, parâmetro opcional. arquivobase64 dados do arquivo em base64 para enviar em anexo, parâmetro opcional. dadoadicional campo reservado para informar dados de sua preferência que irá retornar nos relatórios, parâmetro opcional agrupador campo para informar um valor para agrupamento dos envios, usado para buscar os s com o mesmo código agrupador, parâmetro opcional. Nome: getstatusporagrupador Objetivo: Método que retorna o status de todas as mensagens que possuem o agrupador informado. Assinatura: getstatusporagrupador($, $agrupador) Retorno: Retorna uma com o Status. Versão 1.0 Última alteração: 21/06/2016 Página 4 de 11

5 agrupador Autenticação da empresa, utilizado em todos os métodos. valor informado no método de envio avulso, retorna o status de todas as mensagens que possuem o agrupador informado. Versão 1.0 Última alteração: 21/06/2016 Página 5 de 11

6 4. API PGSMS WSDL: Tipos Complexos: Toda de data deve respeitar o formato: (ano-mes-dia hora:minuto:segundo) lote int quantidade Total de envios no lote. datainicio Data de início para o envio do lote. datafim Data de fim para o lote. Dado fone Numero do telefone. msg Mensagem a ser enviada para o telefone informado Métodos Todos os métodos retornam um XML ou JSON com as informações indicadas. Nome: enviodecampanha Objetivo: Método para criar campanhas de SMS, a campanha será listada no painel sendo possível realizar todas as ações como uma campanha que é criada pelo mesmo. Assinatura: enviodecampanha(,carteira,campanha,lotes,dados, retorno) Retorno: quantidade total de registros processados e bloqueados. Versão 1.0 Última alteração: 21/06/2016 Página 6 de 11

7 Autenticação da empresa, utilizado em todos os métodos. carteira Código da carteira, seu cadastro é feito pelo painel de SMS ( e deve ser único na empresa. campanha Nome desejado para identificar a campanha. lote[] lotes Array do tipo complexo lote. dado[] dados Array do tipo completo dado. retorno Tipo do retorno XML ou JSON, valor default XML. Nome: envioavulso Objetivo: Método para criar campanhas de SMS, a campanha será listada no painel sendo possível realizar todas as ações como uma campanha que é criada pelo mesmo. Assinatura: envioavulso(,carteira,msg,fones,data,retorno,dadocliente) Retorno: Retorna um ID unicio para referencias futuras. Autenticação da empresa, utilizado em todos os métodos. carteira Código da carteira, seu cadastro é feito pelo painel de SMS ( e deve ser único na empresa. Versão 1.0 Última alteração: 21/06/2016 Página 7 de 11

8 campanha Nome desejado para identificar a campanha. lote[] lotes Array do tipo complexo lote. dado[] dados Array do tipo completo dado. retorno Tipo do retorno XML ou JSON, valor default XML. Nome: getstatusavulso Objetivo: Metodo para consulta de status. Assinatura: getstatusavulso(, id) Retorno: Retorna XML com status do ID informado. Autenticação da empresa, utilizado em todos os metodos. int id ID retornado no envioavulso. Versão 1.0 Última alteração: 21/06/2016 Página 8 de 11

9 Nome: getstatusavulsoentredatas Objetivo: Metodo para consulta de status. Assinatura: getstatusavulsoentredatas(,datainicio,datafim) Retorno: Retorna um XML com o status de todos os envios avulso feitos entre a data solicitada. datainicio datafim Autenticação da empresa, utilizado em todos os métodos. Data inicial da consulta, formato da data (anomes-dia hora:minuto:segundo). Data fim da consulta, formato da data (anomes-dia hora:minuto:segundo). Nome: getretorno Objetivo: status de todos os envios realizados dentro da data solicitada. Assinatura: getstatusavulsoentredatas(,datainicio,datafim) Retorno: Retorna um XML com o status de todos os envios realizados dentro da data solicitada. datainicio datafim Autenticação da empresa, utilizado em todos os metodos. Data inicial da consulta, formato da data (ano-mes-dia hora:minuto:segundo). Data fim da consulta, formato da data (ano-mes-dia hora:minuto:segundo). Versão 1.0 Última alteração: 21/06/2016 Página 9 de 11

10 Nome: getresposta Objetivo: respostas recebidas. Assinatura: getresposta() Retorno: Retorna um XML com todas as respostas (MO) recebidas através das mensagens enviadas.. Autenticação da empresa, utilizado em todos os métodos. Nome: getsmsdisponivel Objetivo: respostas recebidas. Assinatura: getsmsdisponivel(,carteira) Retorno: método que retorna um XML do total de Sms disponivel para envio de acordo com a configuração feita pelo painel. Autenticação da empresa, utilizado em todos os métodos. carteira Codigo da carteira, seu cadastro é feito pelo painel de SMS ( e deve ser único na empresa. Nome: validatelefone Objetivo: valida se o telefone existe e qual sua operadora Assinatura: validatelefone(, fone) Retorno: Versão 1.0 Última alteração: 21/06/2016 Página 10 de 11

11 Método que valida se o telefone existe e qual sua operadora. Autenticação da empresa, utilizado em todos os metodos. fone Numero de telefone, pode ser mais de um mas devem ser separados por virgula (, ). Versão 1.0 Última alteração: 21/06/2016 Página 11 de 11