Versão: 2.00 – obsoleta Última Atualização: 01/02/2015
Índice
- Introdução
- Enviando mensagens via SMS – MPG_SendSimple_SMS
- Enviando mensagens via SMS – MPG_SendandFollowUp_SMS
- Enviando mensagens via SMS – MPG_Send_SMS
- Consultando o status das mensagens
- Obtendo o saldo de créditos em conta
- Consultando envios realizados em um determinado período
- Calculando o nº de caracteres em UTF-8 e UTF-16
1. Introdução
Seguindo a documentação presente nesta página, você irá conseguir integrar o seu sistema com o Gateway SMS do Mobi Pronto! Para começar de pé direito, sugerimos que você leia os requerimentos, as notas importantes (onde comunicamos novidades e mudanças futuras) e as descrições de cada método. Desta forma, você irá ganhar tempo e conhecer a solução como um todo. Em caso de dúvida, estamos aqui para ajudá-lo! Acesse sua conta, crie um ticket de suporte e entre em contato conosco. Divirta-se integrando!
1.1. Requerimentos
É necessário ter acesso a “Credencial” da sua conta para realizar a integração. Estes dados podem ser encontrados no menu de “Configurações”, opção “Dados de Integração”. Sugerimos que você também aproveite para adicionar o “Remetente do SMS”, o mesmo irá ajudar seus destinatários a saberem quem é o remetente da mensagens enviadas a eles.
1.2. URL do Web Service
http://pw-api.com/sms/v_2_00/service.asmx
1.3. Notas importantes
1 Esta versão está obsoleta, favor utilizar a versão atual!
2. Enviando mensagens via SMS – MPG_SendSimple_SMS
O MPG_SendSimple_SMS é o método síncrono simples de enviar mensagens via SMS através do nosso Gateway. Mensagens com até 160 caracteres podem ser enviadas para qualquer país que o Mobi Pronto possui cobertura.
2.1. Parâmetros do MPG_SendSimple_SMS
| Parâmetro | Requerido? | Formato | Descrição |
|---|---|---|---|
| CREDENCIAL | Sim | A(40) | Credencial da sua conta no Mobi Pronto |
| MOBILE | Sim | A(15) | Número celular do destinatário em formato internacional. Exemplo para o Brasil: +55(21)999999999 |
| MESSAGE | Sim | A(160) | Conteúdo da mensagem a ser enviada via SMS. |
2.2. Retornos do MPG_SendSimple_SMS
| Código de Retorno | Tipo | Descrição |
|---|---|---|
| 000 | Sucesso | Mensagem enviada com sucesso |
| 001 | Erro | Credencial inválida |
| 005 | Erro | MOBILE com formato inválido |
| 007 | Erro | Flag Send_Project tem que ser S,s or Y,y or N,n |
| 008 | Erro | MESSAGE ou MESSAGE + NOME_PROJETO com mais de 160 posições. SMS concatenado com mais de 15300 posições |
| 009 | Erro | Créditos insuficientes em conta |
| 010 | Erro | Gateway SMS da conta bloqueado |
| 012 | Erro | MOBILE correto, porém com crítica |
| 013 | Erro | Conteúdo da mensagem inválido ou vazio |
| 015 | Erro | País sem cobertura ou não aceita mensagens concatenadas (SMS Longo) |
| 016 | Erro | MOBILE com código de área inválido |
| 017 | Erro | Operadora não autorizada para esta credencial |
| 018 | Erro | MOBILE se encontra em lista negra |
| 800 a 899 | Erro | Falha no Gateway |
| 900 | Erro | Erro de autenticação ou limite de segurança excedido |
| 901 a 999 | Erro | Erro no acesso as operadoras |
3. Enviando mensagens via SMS – MPG_SendandFollowUp_SMS
O MPG_SendandFollowUp_SMS é o método síncrono de enviar mensagens via SMS através do nosso Gateway. Mensagens com até 160 caracteres podem ser enviadas para qualquer país que o Mobi Pronto possui cobertura. Este método têm como característica retornar também o ID da mensagem.
3.1. Parâmetros do MPG_SendandFollowUp_SMS
| Parâmetro | Requerido? | Formato | Descrição |
|---|---|---|---|
| CREDENCIAL | Sim | A(40) | Credencial da sua conta no Mobi Pronto |
| PRINCIPAL_USER | Sim | A(50) ou “” | Controle interno do cliente |
| AUX_USER | Sim | A(20) | O valor atribuído a este parâmetro pode ser utilizado como referência em filtros, facilitando a identificação de mensagens específicas em relatórios criados por você a partir da plataforma |
| SEND_PROJECT | Sim | Se (S)im a sigla da mensagem vem no início Se (N)ão não vem. Tamanho máximo=9 (XXXXXXXX:) Exemplo: MPG: |
|
| MOBILE | Sim | A(15) | Número celular do destinatário em formato internacional. Exemplo para o Brasil: +55(21)999999999 |
| MESSAGE | Sim | A(160) | Conteúdo da mensagem a ser enviada via SMS. |
3.2. Retornos do MPG_SendandFollowUp_SMS
| Código de Retorno | Tipo | Descrição |
|---|---|---|
| 000:ID | Sucesso | Mensagem enviada com sucesso. Onde o ID é o identificar único da mensagem no Mobi Pronto |
| 001 | Erro | Credencial inválida |
| 005 | Erro | MOBILE com formato inválido |
| 007 | Erro | Flag Send_Project tem que ser S,s or Y,y or N,n |
| 008 | Erro | MESSAGE ou MESSAGE + NOME_PROJETO com mais de 160 posições. SMS concatenado com mais de 15300 posições |
| 009 | Erro | Créditos insuficientes em conta |
| 010 | Erro | Gateway SMS da conta bloqueado |
| 012 | Erro | MOBILE correto, porém com crítica |
| 013 | Erro | Conteúdo da mensagem inválido ou vazio |
| 015 | Erro | País sem cobertura ou não aceita mensagens concatenadas (SMS Longo) |
| 016 | Erro | MOBILE com código de área inválido |
| 017 | Erro | Operadora não autorizada para esta credencial |
| 018 | Erro | MOBILE se encontra em lista negra |
| 800 a 899 | Erro | Falha no Gateway |
| 900 | Erro | Erro de autenticação ou limite de segurança excedido |
| 901 a 999 | Erro | Erro no acesso as operadoras |
4. Enviando mensagens via SMS – MPG_Send_SMS
O MPG_Send_SMS é o método síncrono que permite enviar mensagens utilizando o filtro AUX_USER. Mensagens com até 160 caracteres podem ser enviadas para qualquer país que o Mobi Pronto possui cobertura.
4.1. Parâmetros do MPG_Send_SMS
| Parâmetro | Requerido? | Formato | Descrição |
|---|---|---|---|
| CREDENCIAL | Sim | A(40) | Credencial da sua conta no Mobi Pronto |
| PRINCIPAL_USER | Sim | A(50) ou “” | Controle interno do cliente |
| AUX_USER | Sim | A(20) | O valor atribuído a este parâmetro pode ser utilizado como referência em filtros, facilitando a identificação de mensagens específicas em relatórios criados por você a partir da plataforma |
| SEND_PROJECT | Sim | Se (S)im a sigla da mensagem vem no início Se (N)ão não vem. Tamanho máximo=9 (XXXXXXXX:) Exemplo: MPG: |
|
| MOBILE | Sim | A(15) | Número celular do destinatário em formato internacional. Exemplo para o Brasil: +55(21)999999999 |
| MESSAGE | Sim | A(160) | Conteúdo da mensagem a ser enviada via SMS. |
4.2. Retornos do MPG_Send_SMS
| Código de Retorno | Tipo | Descrição |
|---|---|---|
| 000 | Sucesso | Mensagem enviada com sucesso |
| 001 | Erro | Credencial inválida |
| 005 | Erro | MOBILE com formato inválido |
| 007 | Erro | Flag Send_Project tem que ser S,s or Y,y or N,n |
| 008 | Erro | MESSAGE ou MESSAGE + NOME_PROJETO com mais de 160 posições. SMS concatenado com mais de 15300 posições |
| 009 | Erro | Créditos insuficientes em conta |
| 010 | Erro | Gateway SMS da conta bloqueado |
| 012 | Erro | MOBILE correto, porém com crítica |
| 013 | Erro | Conteúdo da mensagem inválido ou vazio |
| 015 | Erro | País sem cobertura ou não aceita mensagens concatenadas (SMS Longo) |
| 016 | Erro | MOBILE com código de área inválido |
| 017 | Erro | Operadora não autorizada para esta credencial |
| 018 | Erro | MOBILE se encontra em lista negra |
| 800 a 899 | Erro | Falha no Gateway |
| 900 | Erro | Erro de autenticação ou limite de segurança excedido |
| 901 a 999 | Erro | Erro no acesso as operadoras |
3. Consultando o status das mensagens
Utilizando a URL Callback é possível obter o status atual das mensagens. Clique aqui para visualizar.
4. Obtendo o saldo de créditos em conta
O método MPG_Credits serve para consultar o número de créditos disponíveis em sua conta.
4.1. Parâmetros do MPG_Credits
| Parâmetro | Requerido? | Formato | Descrição |
|---|---|---|---|
| CREDENCIAL | Sim | A(40) | Credencial da sua conta no Mobi Pronto |
| TOKEN | Sim | A(6) | Código de acesso ao Gateway |
| STATUS | Sim | A(3) | Caso preenchido vêm com o código de erro |
4.2. Retornos do MPG_Credits
| Código de Retorno | Tipo | Descrição |
|---|---|---|
| N. DE CRÉDITOS | Sucesso | O número de créditos disponível em sua conta. Este retorno contém 5 casas decimais. Ex: 855357,20000. Em caso de erro, o retorno será -1 e no campo STATUS, irá conter um dos erros abaixo. |
| 001 | Erro | Credencial inválida |
| 800 a 899 | Erro | Falha no Gateway |
| 900 | Erro | Erro de autenticação ou limite de segurança excedido |
| 901 a 999 | Erro | Erro no acesso as operadoras |
5. Consultando envios realizados em um determinado período
O método MPG_Query01 é utilizado para consultar as mensagens de texto SMS enviadas através da sua conta em um determinado intervalo de tempo.
5.1. Parâmetros do MPG_Query01
| Parâmetro | Requerido? | Formato | Descrição |
|---|---|---|---|
| CREDENCIAL | Sim | A(40) | Credencial da sua conta no Mobi Pronto |
| TOKEN | Sim | A(6) | Código de acesso ao Gateway |
| START_DATE | Sim | A(10) | Data inicial da consulta. Ex: 14/07/2017 |
| END_DATE | Sim | A(10) | Data final da consulta. Ex: 15/07/2017 |
| AUX_USER | Sim | A(20) | O valor atribuído a este parâmetro pode ser utilizado como referência em filtros, facilitando a identificação de mensagens específicas em relatórios criados por você a partir da plataforma |
| MOBILE | Sim | A(15) | Número celular do destinatário em formato internacional. Exemplo para o Brasil: +55(21)999999999 |
| STATUS_CODE | Sim | N | 0 – SMS enviado com erro de crítica 1 – SMS enviado com sucesso 2 – Ambos |
5.2. Retornos do MPG_Query01
| Código de Retorno | Tipo | Descrição |
|---|---|---|
| XML | Sucesso | XML com os resultados solicitados (máximo de 1000 linhas). Os campos incluem: código auxiliar, data de envio, mobile, flag de recebimento, código de retorno e message |
| 001 | Erro | Credencial inválida |
| 002 | Erro | Data inicial inválida |
| 003 | Erro | Data final inválida |
| 005 | Erro | Mobile com formato inválido |
| 890 | Erro | Falha no método MPG_Query, favor entrar em contato com o suporte |
6. Calculando o nº de caracteres em UTF-8 e UTF-16
O método MPG_Calculate_Message_Length_UTF8_or_UTF16 é utilizado para calcular o número de caracteres (UTF-8 ou UTF-16) presentes no conteúdo da mensagem.
6.1. Parâmetros do MPG_Calculate_Message_Length_UTF8_or_UTF16
| Parâmetro | Requerido? | Formato | Descrição |
|---|---|---|---|
| CREDENCIAL | Sim | A(40) | Credencial da sua conta no Mobi Pronto |
| TOKEN | Sim | A(6) | Código de acesso ao Gateway |
| MESSAGE | Sim | A | Conteúdo da mensagem no qual o cálculo será feito |
6.2. Retornos do MPG_Calculate_Message_Length_UTF8_or_UTF16
| Código de Retorno | Tipo | Descrição |
|---|---|---|
| N. DE CARACTERES | Sucesso | Número de caracteres UTF-8 ou UTF-16 encontrados na MESSAGE. Note que, caso exista algum caracter UTF-16 no conteúdo, todos os outros caracteres serão contados como 16-bit (2 bytes) |
| -1 | Erro | Credencial inválida |
| -2 | Erro | Token inválido |
| -9 | Erro | Erro interno, favor entrar em contato com o suporte |