View
25
Download
3
Category
Preview:
Citation preview
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
1
TWW UNIMESSAGE Processamento e envio de mensagens SMS
Webservices
Manual de Integração
( Versão 3.02 )
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
2
TWW UNIMESSAGE Processamento e envio de mensagens SMS
WEBSERVICES
Manual de Integração
Todas as informações disponíveis nesse documento são confidenciais. Esse documento pode incluir falhas técnicas ou erros tipográficos. A TWW não é
responsável por quaisquer danos, que possam ser causados pela utilização desse documento.
A TWW se reserva o direito de alterar esse documento e os sistemas descritos nele a qualquer tempo e sem aviso prévio.
Autor: Carlos A A Moura – TWW do Brasil S A
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
3
Integração Unimessage
Existem várias formas de integração ao sistema TWW Unimessage, através de vários
meios de comunicação como: Linha telefônica discada, links de dados dedicados e internet.
O sistema TWW Unimessage provê comunicação interativa de forma fácil, com qualidade
e alta disponibilidade oferecendo todos os protocolos padrões da industria de
telecomunicações: TAP, TNPP, SMTP, FTP e, XML (Web Services), além de grande
maleabilidade quando é necessária a comunicação via protocolos proprietários e
customizados. Neste caso, a TWW oferece todo o suporte necessário à equipe de
desenvolvimento do cliente para uma integração tranqüila.
As mensagens são enviadas diretamente para o número do celular de destino, e todas as
mensagens processadas ficam armazenadas e contabilizadas no registro ( ID ) do cliente.
Integração Unimessage CAP
A integração com o sistema TWW Unimessage CAP é feita através de XML “Web Services”,
via internet ou link dedicado.
No endereço https://webservices.twwwireless.com.br/reluzcap/ está a lista de comandos
disponíveis para comunicação com o sistema.
A visualização dos detalhes, exemplos de métodos GET, POST e, SOAP, além da
possibilidade de execução de testes, pode ser feita através de navegadores MS Internet
Explorer ou Mozilla Firefox.
O WSDL com a descrição dos métodos pode ser baixado através da URL:
https://webservices.twwwireless.com.br/reluzcap/wsreluzcap.asmx?WSDL
O endereço IP da máquina do cliente, que acessará os webservices deve ser informado
préviamente à TWW para liberação no firewall.
O acesso deve ser feito através de login ( ID do cliente ) e senha.
O cadastro deve ser solicitado através do departamento comercial da TWW.
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
4
Página de Serviços WEB TWW Unimessage CAP:
Comandos Disponíveis:
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
5
AlteraSenha - Altera a senha de usuário. A senha pode ter no máximo 18 caracteres.
Retorna um boolean indicando o sucesso da operação. Campos necessários:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
SenhaAntiga
SenhaNova
BuscaSMS - Retorna um DataSet chamado OutDataSet contendo uma Tabela chamada
BuscaSMS com as mensagens transmitidas dentro de um período MÁXIMO DE 4 DIAS, e
um MÁXIMO DE 4000 SMSs. Retorna Nothing em caso de erro.
Campos necessários:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
SeuNum – Número ou cadeia de caracteres gerado pelo cliente e informado
no momento da postagem no sistema Unimessage.
DataIni - Do tipo DATETIME, que deve ser preenchido no formato ANSI:
“YYYY-MM-DD HH:MM:SS”.
DataFim - Do tipo DATETIME, que deve ser preenchido no formato ANSI:
“YYYY-MM-DD HH:MM:SS”.
BuscaSMSAgenda - Retorna um DataSet chamado OutDataSet com uma mensagem
agendada com o SEUNUM informado.
Campos necessários:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
6
SeuNum – Número ou cadeia de caracteres gerado pelo cliente e informado
no momento da postagem no sistema Unimessage.
Exemplo de dataset de retorno:
<?xml version="1.0" encoding="utf-8" ?> - <DataSet xmlns="https://www.twwwireless.com.br/reluzcap/wsreluzcap"> - <xs:schema id="OutDataSet" xmlns="" xmlns:xs="http://www.w3.org/2001/XMLSchema"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"> - <xs:element name="OutDataSet" msdata:IsDataSet="true" msdata:UseCurrentLocale="true"> - <xs:complexType> - <xs:choice minOccurs="0" maxOccurs="unbounded"> - <xs:element name="BuscaSMSAgenda"> - <xs:complexType> - <xs:sequence> <xs:element name="seunum" type="xs:string" minOccurs="0" /> <xs:element name="celular" type="xs:string" minOccurs="0" /> <xs:element name="mensagem" type="xs:string" minOccurs="0" /> <xs:element name="status" type="xs:string" minOccurs="0" /> <xs:element name="datarec" type="xs:dateTime" minOccurs="0" /> <xs:element name="dataenv" type="xs:dateTime" minOccurs="0" /> <xs:element name="datastatus" type="xs:dateTime" minOccurs="0" />
</xs:sequence> </xs:complexType> </xs:element> </xs:choice> </xs:complexType> </xs:element> </xs:schema>
- <diffgr:diffgram xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:diffgr="urn:schemas-microsoft-com:xml-diffgram-v1">
- <OutDataSet xmlns=""> - <BuscaSMSAgenda diffgr:id="BuscaSMSAgenda1" msdata:rowOrder="0"> <seunum>ABC123</seunum> <celular>551181115323</celular> <mensagem>Teste agendamento ws</mensagem> <status>OK</status> <datarec>2008-10-24T14:55:45.61-02:00</datarec> <dataenv>2008-10-25T10:00:00-02:00</dataenv> <datastatus>2008-10-24T14:55:45.61-02:00</datastatus>
</BuscaSMSAgenda> </OutDataSet> </diffgr:diffgram> </DataSet>
BuscaSMSAgendaDataset - Retorna um DataSet chamado OutDataSet contendo
uma Tabela chamada BuscaSMSAgenda com as mensagens agendadas. Retorna Nothing
em caso de erro.
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
7
Exemplos do método SOAP na interface web.
Campos necessários:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
BuscaSMSMO - Retorna um DataSet chamado OutDataSet contendo uma Tabela
chamada BuscaSMSMO com todas as mensagens SMS MO recebidas DENTRO DE UM
PERIODO como resposta a SMS enviados anteriormente. Retorna Nothing em caso de
erro.
Campos necessários:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
DataIni - Do tipo DATETIME, que deve ser preenchido no formato ANSI: “YYYY-
MM-DD HH:MM:SS”.
DataFim - Do tipo DATETIME, que deve ser preenchido no formato ANSI:
“YYYY-MM-DD HH:MM:SS”.
BuscaSMSMONaoLido - Retorna um DataSet chamado OutDataSet contendo uma Tabela
chamada SMSMO com no máximo 400 linhas, com as mensagens SMS MO não lidas, recebidas
nos últimos 4 dias como resposta a SMS enviados anteriormente, e marca esses MOs COMO
LIDOS. Se houverem 400 linhas na tabela, podem haver mais MOs não lidos, e estes devem ser
lidos usando chamadas subsequentes à função. Retorna Nothing em caso de erro.
Campos necessários:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
8
DelSMSAgenda - Deleta uma mensagem agendada. Retorna OK ou NOK.
Campos necessários:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
Agendamento - Do tipo DATETIME, que deve ser preenchido no formato ANSI:
“YYYY-MM-DD HH:MM:SS”.
SeuNum - Este campo é um número ou cadeia de caracteres alfanuméricos com
até 10 caracteres que é gerado pelo usuário e, armazenado junto com a
mensagem, para ser utilizado no retorno em pesquisas, sendo que pode ser
utilizado na busca de mensagens individuais. Não é obrigatoriamente seqüencial,
e pode ser repetido.
EnviaSMS : Para envio de mensagens individuais. Os campos necessários para o
envio individual são:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
SeuNum - Este campo é um número ou cadeia de caracteres alfanuméricos com
até 10 caracteres que é gerado pelo usuário e, armazenado junto com a
mensagem, para ser utilizado no retorno em pesquisas, sendo que pode ser
utilizado na busca de mensagens individuais. Não é obrigatoriamente seqüencial,
e pode ser repetido.
Celular – (55DDNNNNNNNN) – Número do celular de destino da mensagem,
onde D = Código de área e N = Número do celular
Mensagem – Texto ASCII com até 145 caracteres
Retornos possíveis:
OK – Mensagem aceita para transmissão
NOK – Mensagem não aceita para transmissão
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
9
Erro
NA (não disponível) – Sistema não disponível
EnviaSMS2SN - Envia uma mensagem para um celular, usando 2 campos de referência
NUMÉRICOS (SeuNum1 e SeuNum2) de no máximo 24 dígitos cada. Retorna OK, NOK, Erro ou
NA (não disponível).
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
SeuNum1 - Este campo é um campo numérico com até 24 posições que é
gerado pelo usuário e, armazenado junto com a mensagem, para ser utilizado
no retorno em pesquisas, sendo que pode ser utilizado na busca de
mensagens individuais. Não é obrigatoriamente seqüencial, e pode ser
repetido.
SeuNum2 - Este campo é um campo numérico com até 24 posições que é
gerado pelo usuário e, armazenado junto com a mensagem, para ser utilizado
no retorno em pesquisas, sendo que pode ser utilizado na busca de
mensagens individuais. Não é obrigatoriamente seqüencial, e pode ser
repetido.
Celular - (55DDNNNNNNNN) – Número do celular de destino da mensagem,
onde D = Código de área e N = Número do celular
Mensagem – Texto ASCII com até X caracteres
Agendamento - Do tipo DATETIME, que deve ser preenchido no formato
ANSI: “YYYY-MM-DD HH:MM:SS”.
EnviSMSAge – Envia uma mensagem para um celular com agendamento. Retorna
OK, NOK, Erro ou NA (não disponível)
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
10
SeuNum - Este campo é um número ou cadeia de caracteres alfanuméricos com
até 10 caracteres que é gerado pelo usuário e, armazenado junto com a mensagem,
para ser utilizado no retorno em pesquisas, sendo que pode ser utilizado na busca
de mensagens individuais. Não é obrigatoriamente seqüencial, e pode ser repetido.
Celular - (55DDNNNNNNNN) – Número do celular de destino da mensagem, onde
D = Código de área e N = Número do celular
Mensagem – Texto ASCII com até X caracteres
Agendamento - Do tipo DATETIME, que deve ser preenchido no formato ANSI:
“YYYY-MM-DD HH:MM:SS”.
EnviSMSAgeQuebra - Envia uma mensagem para um celular com agendamento. Se essa
mensagem for mais longa que 140 caracteres, ela será dividida em várias mensagens de até 140
caracteres, com "..." separando as mensagens. O tamanho máximo do texto é de 4096 caracteres.
Retorna OK n (n é o número de SMS enviados pela operação), NOK, Erro ou NA (não disponível).
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
SeuNum - Este campo é um número ou cadeia de caracteres alfanuméricos com até
10 caracteres que é gerado pelo usuário e, armazenado junto com a mensagem,
para ser utilizado no retorno em pesquisas, sendo que pode ser utilizado na busca
de mensagens individuais. Não é obrigatoriamente seqüencial, e pode ser repetido.
Celular - (55DDNNNNNNNN) – Número do celular de destino da mensagem, onde
D = Código de área e N = Número do celular
Mensagem – Texto ASCII. Se for maior do que 140 caracteres a mensagem será
dividida em várias mensagens de até 140 caracteres com "..." incluídos no fim e no
inicio de mensagens subsequentes. O tamanho máximo do texto é de 4096
caracteres.
Agendamento - Do tipo DATETIME, que deve ser preenchido no formato ANSI:
“YYYY-MM-DD HH:MM:SS”.
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
11
EnviaSMSConcatenadoComAcento - Envia uma mensagem de texto concatenado
com acento para um celular. O campo Serie deve conter um número entre 0 e 255 e deve ser
único para cada SMS concatenado enviado, sendo acrescido de 1 a cada envio, e quando atinge
255, comece com 0 (zero) novamente. Se essa mensagem for mais longa que 70 caracteres,
ela será dividida em várias mensagens de até 70 caracteres e enviada de forma a chegar
concatenada, em uma única mensagem, no celular de destino, desde que a operadora suporte
concatenação. Se não houver suporte da operadora, a mensagem será enviada separadamente
com + separando as mensagens. Tamanho máximo da mensagem = 4096 caracteres. Retorna
OK n (n é o número de SMS enviados pela operação), NOK (usuário ou senha inválidos, ou
mensagem maior que 2048 caracteres), Erro ou NA (não disponível).
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
SeuNum - Este campo é um número ou cadeia de caracteres alfanuméricos com
até 10 caracteres que é gerado pelo usuário e, armazenado junto com a
mensagem, para ser utilizado no retorno em pesquisas, sendo que pode ser
utilizado na busca de mensagens individuais. Não é obrigatoriamente seqüencial,
e pode ser repetido.
Série - O campo Serie deve conter um número entre 0 e 255 e deve ser único
para cada SMS concatenado enviado, sendo acrescido de 1 a cada envio, e
quando atinge 255, comece com 0 (zero) novamente.
Celular - (55DDNNNNNNNN) – Número do celular de destino da mensagem,
onde D = Código de área e N = Número do celular
Mensagem – Texto ASCII. Se for maior do que 70 caracteres a mensagem será
dividida em várias mensagens de até 70 caracteres com "..." incluídos no fim e
no início de mensagens subsequentes.
EnviaSMSConcatenadoSemAcento - Envia uma mensagem de texto
concatenado sem acento para um celular. O campo Serie deve conter um número entre
0 e 255 e deve ser único para cada SMS concatenado enviado, sendo acrescido de 1 a
cada envio, e quando atinge 255, comece com 0 (zero) novamente. Se essa mensagem
for mais longa que 140 caracteres, ela será dividida em várias mensagens de até 140
caracteres e enviada de forma a chegar concatenada, em uma única mensagem, no
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
12
celular de destino, desde que a operadora suporte concatenação. Se não houver
suporte da operadora, a mensagem será enviada separadamente com + separando as
mensagens. Tamanho máximo da mensagem = 4096 caracteres. Retorna OK n (n é o
número de SMS enviados pela operação), NOK (usuário ou senha inválidos, ou
mensagem maior que 4096 caracteres), Erro ou NA (não disponível).
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
SeuNum - - Este campo é um número ou cadeia de caracteres alfanuméricos com
até 10 caracteres que é gerado pelo usuário e, armazenado junto com a mensagem,
para ser utilizado no retorno em pesquisas, sendo que pode ser utilizado na busca
de mensagens individuais. Não é obrigatoriamente seqüencial, e pode ser repetido.
Série - O campo Serie deve conter um número entre 0 e 255 e deve ser único para
cada SMS concatenado enviado, sendo acrescido de 1 a cada envio, e quando
atinge 255, comece com 0 (zero) novamente.
Celular - (55DDNNNNNNNN) – Número do celular de destino da mensagem, onde
D = Código de área e N = Número do celular
Mensagem – Texto ASCII. Se for maior do que 140 caracteres a mensagem será
dividida em várias mensagens de até 140 caracteres com "..." incluídos no fim e no
inicio de mensagens subsequentes.
EnviaSMSDataSet : Para envio de mensagens em lote. Recebe um DataSet com
mensagens SMS a serem enviadas, com os seguintes campos:
seunum - Este campo é um número ou cadeia de caracteres akfanuméricos com
até 10 caracteres que é gerado pelo usuário e, armazenado junto com a
mensagem, para ser utilizado no retorno em pesquisas, sendo que pode ser
utilizado na busca de mensagens individuais. Não é obrigatóriamente seqëncial,
e pode ser repetido.
celular (55DDNNNNNNNN) – Número do celular de destino da mensagem, onde
D = Código de área e N = Número do celular
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
13
mensagem – Texto ASCII com até X caracteres. São aceitos caracteres ASCII
entre ASCII-32 e ASCII-126, os caracteres acetuados serão substituídos pelos
mesmos, sem acento.
agendamento - Do tipo DATETIME, que deve ser preenchido no formato ANSI:
“YYYY-MM-DD HH:MM:SS”.
Retorna uma string com um dos valores abaixo:
OK – Mensagem aceita para transmissão
NOK – Mensagem não aceita para transmissão
Erro
NA (não disponível) – Sistema não disponível
Exemplos do método SOAP e formato de preenchimento dos campos, na interface
web.
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos
EnviaSMSOta8Bit - Envia uma mensagem binária para um celular. Tanto o campo
Header como o Data devem estar no formato OTA 8 bit, com um número par de
caracteres hexadecimais. Retorna OK, NOK, Erro ou NA (não disponível).
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
SeuNum - Este campo é um número ou cadeia de caracteres alfanuméricos com
até 10 caracteres que é gerado pelo usuário e, armazenado junto com a
mensagem, para ser utilizado no retorno em pesquisas, sendo que pode ser
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
14
utilizado na busca de mensagens individuais. Não é obrigatoriamente seqüencial,
e pode ser repetido.
Celular - (55DDNNNNNNNN) – Número do celular de destino da mensagem,
onde D = Código de área e N = Número do celular
Header – Neste campo são passadas as informações de significado do SMS,
como envio para diferentes portas lógicas do celular, quebra de texto longo em
múltiplos SMSs entre outras funções. ( Para maiores detalhes consulte o
documento 3GPP TS 23.040 V6.5.0 (2004-09) ). Se a necessidade é de somente
transportar dados binários, deixar o header em branco.
Data – Conteúdo dos dados binários úteis a serem transmitidos.
Tanto no campo Header como no Data, cada byte a ser transmitido deve ser transformado
em 2 caracteres representando o código hexadecimal do byte. De 00 à FF.
Como cada byte se transforma em 2 caracteres, o texto do campo Header mais o campo
Data não podem ser maiores que 280 caracteres.
EnviaSMSQuebra - Envia uma mensagem de texto para um celular. Se essa
mensagem for mais longa que 140 caracteres, ela será dividida em várias mensagens
de até 140 caracteres, com ... separando as mensagens. Tamanho máximo da
mensagem = 4096 caracteres. Retorna OK n (n é o número de SMS enviados pela
operação), NOK (usuário ou senha inválidos, ou mensagem maior que 4096 caracteres),
Erro ou NA (não disponível).
NumUsu – Login ( ID ), com até 10 caracteres alfanuméricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
SeuNum - Este campo é um número ou cadeia de caracteres alfanuméricos com até
10 caracteres que é gerado pelo usuário e, armazenado junto com a mensagem,
para ser utilizado no retorno em pesquisas, sendo que pode ser utilizado na busca
de mensagens individuais. Não é obrigatoriamente sequencial, e pode ser repetido.
Celular - (55DDNNNNNNNN) – Número do celular de destino da mensagem, onde
D = Código de área e N = Número do celular
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
15
Mensagem – Texto ASCII. Se for maior do que 140 caracteres a mensagem será
dividida em várias mensagens de até 140 caracteres com "..." incluídos no fim e no
inicio de mensagens subsequentes. O tamanho máximo do texto é de 4096
caracteres.
EnviaSMSTIM - Recebe uma String com um XML no mesmo formato usado para
enviar SMS a operadora TIMSUL, para facilitar a integração com sistemas já
desenvolvidos.
EnviaSMSXML - Recebe um XML com mensagens SMS a serem enviadas, com os
seguintes campos:
seunum - Este campo é um número ou cadeia de caracteres akfanuméricos
com até 10 caracteres que é gerado pelo usuário e, armazenado junto com a
mensagem, para ser utilizado no retorno em pesquisas, sendo que pode ser
utilizado na busca de mensagens individuais. Não é obrigatóriamente
seqëncial, e pode ser repetido.
celular (55DDNNNNNNNN) – Número do celular de destino da mensagem,
onde D = Código de área e N = Número do celular
mensagem – Texto ASCII com até X caracteres. São aceitos caracteres
ASCII entre ASCII-32 e ASCII-126, os caracteres acetuados serão
substituídos pelos mesmos, sem acento.
agendamento - Do tipo DATETIME, que deve ser preenchido no formato
ANSI: “YYYY-MM-DD HH:MM:SS”.
Retorna uma string com um dos valores abaixo:
OK – Mensagem aceita para transmissão
NOK – Mensagem não aceita para transmissão
Erro
NA (não disponível) – Sistema não disponível
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
16
InsBL - Insere um número de celular na black list. Retorna 1 em caso de sucesso, 0 caso
o celular já esteja na black list, -1 em caso de erro.
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
Celular - (55DDNNNNNNNN) – Número do celular de destino da mensagem,
onde D = Código de área e N = Número do celular
ResetaMOLido - Reseta o status de LIDO dos SMS MO desde 1 dia atrás até o momento
atual. Retorna OK ou NOK em caso de erro.
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
ResetaStatusLido - Reseta o status de LIDO dos SMS MO desde 1 dia atrás até o
momento atual. Retorna OK ou NOK em caso de erro.
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
StatusSMS - Retorna um DataSet chamado OutDataSet contendo a tabela StatusSMS
com o status de uma mensagem SMS já transmitida. Retorna Nothing em caso de erro.
Campos necessários:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
17
SeuNum - Este campo é um número ou cadeia de caracteres alfanuméricos
com até 10 caracteres que é gerado pelo usuário e, armazenado junto com a
mensagem, para ser utilizado no retorno em pesquisas, sendo que pode ser
utilizado na busca de mensagens individuais. Não é obrigatoriamente
seqüencial, e pode ser repetido.
StatusSMS2SN - Retorna um DataSet chamado OutDataSet contendo a tabela
StatusSMS com o status de uma mensagem SMS já transmitida através do método
EnviaSMS2SN, que utiliza dois identificadores. Retorna Nothing em caso de erro.
Campos necessários:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
SeuNum1 - Este campo é um campo numérico com até 24 posições que é
gerado pelo usuário e, armazenado junto com a mensagem, para ser utilizado
no retorno em pesquisas, sendo que pode ser utilizado na busca de
mensagens individuais. Não é obrigatoriamente seqüencial, e pode ser
repetido.
SeuNum2 - Este campo é um campo numérico com até 24 posições que é
gerado pelo usuário e, armazenado junto com a mensagem, para ser utilizado
no retorno em pesquisas, sendo que pode ser utilizado na busca de
mensagens individuais. Não é obrigatoriamente seqüencial, e pode ser
repetido.
StatusSMSDataset - Recebe um DataSet com os campos: SeuNum, e retorna um
DataSet chamado OutDataSet contendo a tabela StatusSMSDS com várias mensagens
já transmitidas. Retorna Nothing em caso de erro.
Exemplos do método SOAP na interface web.
Campos necessários:
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
18
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
SeuNum - Este campo é um número ou cadeia de caracteres alfanuméricos
com até 10 caracteres que é gerado pelo usuário e, armazenado junto com a
mensagem, para ser utilizado no retorno em pesquisas, sendo que pode ser
utilizado na busca de mensagens individuais. Não é obrigatoriamente
seqüencial, e pode ser repetido.
StatusSMSNaoLido - Retorna um DataSet chamado OutDataSet contendo a tabela
StatusSMS com no máximo 400 linhas, contendo somente os status de SMS dos últimos
4 dias que ainda não tenham sido lidos, e os MARCA COMO LIDOS. Se houverem 400
linhas na tabela, podem haver mais status não lidos, e estes devem ser lidos usando
chamadas subsequentes à função. Retorna Nothing em caso de erro.
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
VerBL - Retorna um DataSet com os celulares incluidos na black list. Retorna Nothing
em caso de erro.
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
VerCredito - Verifica os créditos de um Usuário Pré-Pago. Utiliza os seguintes
campos:
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
19
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
Retorna o número de créditos ou -1 se o Usuário não for do tipo Pré-Pago ou -2 em caso
de erro nos parâmetros
VerValidade - Retorna a data de validade dos créditos de um Usuário Pré-Pago.
Retorna NOTHING se o Usuário não for do tipo Pré-Pago ou caso haja erro nos
parâmetros.
Campos necessários:
NumUsu – Login ( ID ), com até 10 caracteres alfa-numéricos, no sistema
Unimessage, fornecido pela TWW.
Senha – Com até 18 caracteres alfanuméricos.
--------------------------------------------------------------------------------------------------------------
Integração para retorno automático Unimessage
Além da comunicação através de webservices, onde é possível efetuar todas as transações
de envio de mensagens e consultas de status e relatórios, é possível também automatizar
a atualização de status e recebimento de Mos, através dos métodos HTTP GET, HTTP
POST e, SMTP.
Nesse caso, assim que acontece a atualização do status para uma mensagem enviada pelo
cliente, o sistema Unimessage o envia para uma URL pré estabelecida, através do método
GET ou POST, ou através de SMTP para um endereço de email pré cadastrado.
O mesmo acontece para o recebimento de mensagens de resposta ( Mos ) a mensangens
enviadas pelo cliente através dos UNIMESSAGE Web Services.
Para os Mos o caminho de retorno permanece ativo durante um período de 4 dias.
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
20
Após esse período, as mensagens de resposta são descartadas.
O servidor deve ser configurado para receber os eventos onde serão passados os
parâmetros necessários.
O formato da URL, para o método GET é a seguinte:
Exemplo:
www.urldocliente.com.br/?SeuNum=Teste123&Celular=551181231234&status=CL
Parâmetros disponíveis:
Parâmetros de STATUS:
SeuNum (número do cliente)
Celular
Status (2 letras, como CL)
TextoStatus (descrição do status, veja abaixo*)
Data do status
*Textos de status
Caso "CL"
textoStatus = "SMS entregue ao celular de destino"
Caso "E0"
textoStatus = "Numero de celular invalido/sem operadora"
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
21
Caso "E1"
textoStatus = "Blacklist" ( Celular no blacklist )
Case "E3"
textoStatus = "Duplicada" ( Mensagem rejeitada por excessivas repetições )
Caso "E4"
textoStatus = "SMS recusado pela operadora"
Caso "E5"
textoStatus = "SMS expirado sem informe da operadora"
Caso "E6"
textoStatus = "SMS expirado conforme informe da operadora"
Caso "E7"
textoStatus="SMS rejeitado por falta de créditos ou conta bloqueada"
Parâmetros disponíveis para SMS MO:
Operadora - Operadora (nosso código numérico, 1 - Claro, 2 - TIM, 3 - Vivo, etc.)
Mensagem - Texto do SMS MO
Celular - Número do celular originador do SMS MO
Shnum - Short number de destino do SMS MO
SeuNum - Número identificador da mensagem MT gerado pelo cliente, ao qual esse
SMS MO responde
Data - Data do SMS MO
Para a habilitação desse serviço é necessário também liberar o acesso aos Ips de nossos
servidores à essa URL.
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
22
Tabela de Status de mensagens
Status de SMS:
OK: mensagem recebida, na fila para envio à operadora
OP: mensagem enviada à operadora
CL: Celular confirmou o recebimento
ER: Erro de processamento
E0: Celular não pertence a nenhuma operadora
E1: Mensagem rejeitada, celular no blacklist
E3: Mensagem rejeitada devido a excessivas repetições
E4: mensagem rejeitada pela operadora antes de transmitir. (Número cancelado ou com
restrições)
E6: mensagem expirada conforme informação da operadora (expirada após sequência de
tentativas)
E7: mensagem rejeitada por falta de crédito.
Quanto ao campo OP, corresponde à operadora de celular:
0 - Nenhuma operadora (mensagem sem número de celular ou com número incorreto)
1 - Claro
2 - TIM
3 - Vivo
4 - TeleMig
5 - Oi
6 - Nextel
7 - Brasil Telecom
TWW.COM. BR
Rua do Rocio, 220 - 6º andar. Vila Olímpia - São Paulo, SP CEP 04552-000 - Brasil relacionamento@tww.com.br
+55 11 3444 5010
23
8 - Sercomtel
9 - CTBC
10 - Porto Conecta
257 - Outras
OBS: Os status podem ser alterados em até 48 horas após a postagem nos sistemas das
operadoras.
--------------------------------------------------------------------------------------------------------------
Para maiores informações, comandos não descritos e solucionar quaisquer dúvidas
por favor entre em contato com:
+55 (11) 3444 5010 (atendimento – horário comercial)
+55 (11) 3444 5022 (fax)
relacionamento@tww.com.br (atendimento – horário comercial)
camoura@tww.com.br (atendimento técnico – plantão)
Recommended