SMSExpressWebServices 1

SMS Express Web Services
_______________________________________________
versão 1.8
23 de Julho de 2008
_____________________________________________________________________________________________
Índice
1. SubmissionManager2 ........................................................................................................................................... 3
Acesso ..................................................................................................................................................................... 3
Métodos disponíveis ................................................................................................................................................ 3
sendSmsSubmission ....................................................................................................................................... 4
sendSmsPullSubmission ................................................................................................................................. 7
getSmsPullSubmissionResponses ................................................................................................................ 10
getSubmissionStatus ..................................................................................................................................... 12
getSubmissionDetails .................................................................................................................................... 14
cancelSubmission.......................................................................................................................................... 17
2. MessageManager ............................................................................................................................................... 19
Acesso ................................................................................................................................................................... 19
Métodos disponíveis .............................................................................................................................................. 19
createMessage .............................................................................................................................................. 19
deleteMessage .............................................................................................................................................. 22
getMessage ................................................................................................................................................... 24
getMessages ................................................................................................................................................. 26
3. ContactListManager ............................................................................................................................................ 28
Acesso ................................................................................................................................................................... 28
createContactList........................................................................................................................................... 28
deleteContactList ........................................................................................................................................... 31
getContactList ............................................................................................................................................... 33
getContactLists .............................................................................................................................................. 35
getContacts ................................................................................................................................................... 37
4. SubmissionManager ........................................................................................................................................... 39
Acesso ................................................................................................................................................................... 39
sendMultiSms ................................................................................................................................................ 39
Anexo A – Exemplos de utilização .............................................................................................................................. 42
SubmissionManager2 .................................................................................................................................................. 43
sendSmsSubmission ..................................................................................................................................... 43
sendSmsPullSubmission ............................................................................................................................... 44
getSmsPullSubmissionResponses ................................................................................................................ 45
getSubmissionStatus ..................................................................................................................................... 46
getSubmissionDetails .................................................................................................................................... 47
cancelSubmission.......................................................................................................................................... 49
MessageManager ........................................................................................................................................................ 50
createMessage .............................................................................................................................................. 50
deleteMessage .............................................................................................................................................. 51
getMessage ................................................................................................................................................... 51
getMessages ................................................................................................................................................. 52
ContactListManager .................................................................................................................................................... 54
createContactList........................................................................................................................................... 54
deleteContactList ........................................................................................................................................... 55
getContactList ............................................................................................................................................... 55
getContactLists .............................................................................................................................................. 56
getContacts ................................................................................................................................................... 57
SubmissionManager .................................................................................................................................................... 59
sendMultiSms ................................................................................................................................................ 59
WWW.MOBICOMP.COM 2
CDP.TSD.00
_____________________________________________________________________________________________
1. SubmissionManager2
A API disponibilizada é suportada por WebServices sobre HTTP/HTTPS e necessita de autenticação.
Esta API (SubmissionManager2) substituiu, a partir de 21 de Janeiro de 2008, a API SubmissionManager. No

entanto, aplicações desenvolvidas antes desta data, podem continuar a utilizar a antiga API.
Acesso
WSDL
O WSDL referente a este WebService pode ser obtido no seguinte endereço:
https://smsexpress.tmn.pt/smsexpress-webservices/SubmissionManager2?wsdl
URL de acesso:
O seguinte URL deverá ser utilizado para o acesso ao WebService:
https://smsexpress.tmn.pt/smsexpress-webservices/SubmissionManager2
Métodos disponíveis
WWW.MOBICOMP.COM 3
CDP.TSD.00
_____________________________________________________________________________________________
sendSmsSubmission
Este método permite o envio de uma submissão SMS. Recebe a informação relativa à submissão que se deseja
enviar e devolve o identificador e estado da submissão no SMS Express.
A tabela seguinte especifica os parâmetros de entrada e de saída do WebService.
sendSmsSubmission
Campo Tipo de dados Utilização
Input
AuthenticationInfo
application * String A preencher com texto livre. Este campo é meramente
informativo.
username * String Identificação do utilizador que está a efectuar o envio.
password * String Palavra-chave do utilizador que está a efectuar o envio.
SmsSubmission
message * String Texto da mensagem a enviar (alfabeto 7bits GSM)
alphabet 2 String Alfabeto da mensagem.
useSubstitutions 2 Boolean Indica se se deve fazer substituição de palavras chave na
mensagem.
substitutions 2 String[][] Array bidimensional com as substituições que deverão ser
feitas. Cada elemento do array é um array com dois
elementos, o primeiro identifica a chave a substituir e o
segundo identifica o valor.
contactLists 1 String Array Listas de contactos do SMS Express a que serão utilizadas
como destinatários. Cada item deverá ser o identificador da
lista de contactos.
recipients 1 String Array Lista de destinatários individuais.
sender * String Originador da mensagem (um dos configurados para o
utilizador autenticado)
validity * Integer Validade da mensagem (em horas) (um dos valores obtidos
no WebService getUserData)
notification Boolean Envio com notificação ou não.
Por omissão é assumido o valor “false”, ou seja, sem
notificação.
notificationType 2 String Tipo de notificação utilizada.
notificationRecipient 2 String Destinatário da notificação.
deliveryDate Date Data de início de envio da submissão.
Caso não seja indicada uma data para envio ou a data
indicada seja inferior à data/hora actual, o envio fica
agendado para processamento na data/hora actual.
Output
SubmissionStatus
id String Identificador da submissão criada
status Integer Estado da submissão no SMS Express
message String Texto informativo do resultado da submissão
(*) Campos obrigatórios
(1) Pelos menos um dos campos assinalados tem de estar preenchido
(2) Estes campos ainda não estão em uso.
Campo AuthenticationInfo:
Este objecto é utilizado para passar a informação de autenticação à plataforma.
Campo SmsSubmission:
Este objecto é utilizado para passar a informação relativa à submissão em que os destinatários são passados como
um array de strings ou como uma lista de contactos.
WWW.MOBICOMP.COM 4
CDP.TSD.00
_____________________________________________________________________________________________
Campo SubmissionStatus:
Este objecto é utilizado para devolver a informação relativa ao resultado do envio da submissão para o SMS
Express.
O campo status deste objecto indica qual é o estado com que a submissão ficou e pode ter os valores:
 0 - O envio foi submetido com sucesso e irá ser enviado na data escolhida.
Tratamento de anomalias e situações de erro
No caso de acontecer um erro no processamento de um pedido, o WebService responderá com uma SOAP Fault.
As SOAP Faults deste Web Service seguem o seguinte formato:
<?xml version="1.0" encoding="utf-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance">
<soapenv:Body>
<soapenv:Fault>
<faultcode xmlns:ns1="http://xml.apache.org/axis/">ns1:0002</faultcode>
<faultstring>Username ou password inválidos. Tente novamente</faultstring>
<detail>
<ns2:exceptionName
xmlns:ns2="http://xml.apache.org/axis/">com.mobicomp.smsexpress.webservice.server.common.Authenti
cationException</ns2:exceptionName>
<ns3:hostname xmlns:ns3="http://xml.apache.org/axis/">sx-pre.tmn.pt</ns3:hostname>
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
O código de erro e a descrição podem ser obtidos nos campos faultcode e faultstring da Soap Fault. A aplicação
cliente deverá utilizar estes campos para obter informação mais detalhada sobre o erro que deu origem à SOAP
Fault.
Estes são os códigos de erro genéricos que podem acontecer.
Código Criticidade Significado

0001 ERROR Aplicação inválida.
0002 ERROR Erro de autenticação
0003 Campo com formato inválido. O nome do campo vem na
ERROR
descrição textual do erro
0004 ERROR Erro desconhecido.
Caso o SOAP Fault seja o 0002, a descrição indicará a causa do erro. Estas poderão ser:
 0002:Password has expired

 0002:A sua conta encontra-se bloqueada
 0002:O acesso à sua conta não está disponível. Para mais informações contacte o seu Gestor de Conta ou
a Linha TMN Empresas, ligando 96 800 86 63 da Rede TMN ou 800 21 86 63 de outras redes nacionais.
 0002:Username ou password inválidos. Tente novamente
WWW.MOBICOMP.COM 5
CDP.TSD.00
_____________________________________________________________________________________________
Caso o Soap Fault seja o 0003, a descrição indicará a causa do erro. Estas poderão ser:
 0003:Tem de escolher pelo menos uma lista de contactos SMSExpress ou um contacto

 0003:Por favor indique a Mensagem a enviar
 0003:A mensagem não pode ter mais de 304 caracteres
 0003:Invalid originator: <originador>
 0003: Não tem destinatários válidos
 0003: Foi excedido o número máximo de sms diário
WWW.MOBICOMP.COM 6
CDP.TSD.00
_____________________________________________________________________________________________
sendSmsPullSubmission
Este método permite o envio de uma submissão SMS Pull. Recebe a informação relativa à submissão que se deseja
enviar e devolve o identificador e estado da submissão no SMS Express.
Input
AuthenticationInfo
informativo.
SmsPullSubmission
message * String Texto da mensagem a enviar (alfabeto 7bits GSM)
alphabet 2 String Alfabeto da mensagem.
useSubstitutions 2 Boolean Indica se se deve fazer substituição de palavras chave
na mensagem.
substitutions 2 String[][] Array bidimensional com as substituições que deverão
ser feitas. Cada elemento do array é um array com dois
elementos, o primeiro identifica a chave a substituir e o
segundo identifica o valor.
validUntil* Date Data/Hora limite para recepção de mensagens de
resposta.
billingId* String Tipo de biiling que será utilizado. Actualmente pode ter
os valores:
1 - Pago por quem envia
2 - Grátis para quem envia
3 - Valor acrescentado
acceptNonAdresseesResponses* Boolean Este campo indica se é possível receber respostas de
utilizadores que não estavam na lista de destinatários
da submissão.
submissionCode* String Código do SMS. Este campo tem de conter 3 números.
responseAcceptedMessage* String Mensagem de confirmação de resposta.
contactLists 1 String Array Listas de contactos do SMS Express a que serão
utilizadas como destinatários. Cada item deverá ser o
identificador da lista de contactos.
1
recipients String Array Lista de destinatários individuais.
sender * String Originador da mensagem (um dos configurados para o
utilizador autenticado)
validity * Integer Validade da mensagem (em horas) (um dos valores
obtidos no WebService getUserData)
notification Boolean Envio com notificação ou não.
Por omissão é assumido o valor “false”, ou seja, sem
notificação.
notificationType 2 String Tipo de notificação utilizada.
notificationRecipient 2 String Destinatário da notificação.
deliveryDate Date Data de início de envio da submissão.
Caso não seja indicada uma data para envio ou a data
indicada seja inferior à data/hora actual, o envio fica
agendado para processamento na data/hora actual.
Output
SubmissionStatus
status Integer Estado da submissão no SMS Express
message String Texto informativo do resultado da submissão
WWW.MOBICOMP.COM 7
CDP.TSD.00
_____________________________________________________________________________________________
Campo SmsPullSubmission:
Este objecto é utilizado para passar a informação relativa à submissão em que os destinatários são passados como
Campo SubmissionStatus:
Este objecto é utilizado para devolver a informação relativa ao resultado do envio da submissão para o SMS
Express.
O campo status deste objecto indica qual é o estado com que a submissão ficou e pode ter os valores:
 0 - O envio foi submetido com sucesso e irá ser enviado na data escolhida.
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.

0003 ERROR Campo com formato inválido. O nome do campo vem na
WWW.MOBICOMP.COM 8
CDP.TSD.00
_____________________________________________________________________________________________


 0003: Operation not allowed – Esta mensagem é enviada quando o utilizador não tem o SMS Pull
configurado.
 0003: Por favor indique a mensagem de confirmação de resposta
 0003: A mensagem de confirmação de resposta não pode ter mais de 304 caracteres
 0003: A Data/Hora limite para recepção de mensagens não pode ultrapassar os 31 dias
 0003: Por favor indique o código do SMS (submissionCode)
 0003: O código do SMS (submissionCode) tem de conter 3 dígitos
 0003: O Código de SMS (submissionCode) tem de ser um valor numérico
 0003: Invalid billingId
 0003: O Código de SMS (submissionCode) indicado já esta a ser usado. Códigos em uso: <lista de códigos
em uso>
WWW.MOBICOMP.COM 9
CDP.TSD.00
_____________________________________________________________________________________________
getSmsPullSubmissionResponses
Este método permite consultar as respostas recebidas por submissões com pedido de resposta
(SmsPullSubmission). Recebe o identificador da submissão e devolve as respostas recebidas. Se não houver
nenhuma submissão com este identificador é devolvida uma lista vazia.
Input
AuthenticationInfo
informativo.
submissionId * String Identificador da submissão

Output
SmsPullSubmissionResponse[]
message String Mensagem recebida
date Date Data de recepção da mensagem
originator String Originador da mensagem (msisdn)
endDate Date Data de fim de envio da submissão
nonAddressee Boolean Indica se o originador fazia parte da lista de
destinatários da submissão.
Campo SmsPullSubmissionResponse:
Este objecto representa uma resposta recebida.
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
WWW.MOBICOMP.COM 10
CDP.TSD.00
_____________________________________________________________________________________________
</soapenv:Body>
</soapenv:Envelope>
Fault.

ERROR

WWW.MOBICOMP.COM 11
CDP.TSD.00
_____________________________________________________________________________________________
getSubmissionStatus
Este método permite consultar o estado de uma submissão. Recebe o identificador da submissão e devolve o seu
estado. Se não houver nenhuma submissão com este identificador é devolvido o valor nulo.
getSubmissionStatus
Input
AuthenticationInfo
informativo.

Output
SubmissionStatus2
submissionId String Identificador da submissão
messageType Integer Tipo da mensagem, valores possíveis:
2 - SMS
3 - SMS_PULL
4 - MMS
7 - EMAIL
8 - WAP_PUSH
startDate Date Data de início de envio da submsissão
endDate Date Data de fim de envio da submsissão
waitMessages Integer Mensagens em espera
sentMessages Integer Mensagens enviadas
failedMessages Integer Mensagens falhadas
notifWaitMessages Integer Mensagens à espera de notificação
canceledMessages Integer Mensagens canceladas
totalMessages Integer Total de mensagens a enviar
status Integer Estado da submissão, valores possíveis:
0 - NOT_STARTED
1 - STARTED
2 - FINISHED
processStatus Integer Sub-estado da submissão, valores possíveis:
0 - OK
1 - TOCONFIRM
2 - CANCEL_STARTED
3 - CANCELED
4 - TOCONFIRM_EXPIRED
5 - CONFIRMED
Campo SubmissionStatus2:
Este objecto representa o estado da submissão.
WWW.MOBICOMP.COM 12
CDP.TSD.00
_____________________________________________________________________________________________
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.

ERROR

WWW.MOBICOMP.COM 13
CDP.TSD.00
_____________________________________________________________________________________________
getSubmissionDetails
Este método permite consultar toda a informação relacionada com uma submissão. Recebe o identificador da
submissão e devolve o seu estado. Se não houver nenhuma submissão com este identificador é devolvido o valor
nulo.
Input
AuthenticationInfo
informativo.

getRecipientsStatus * Boolean Indica se deve consultar os destinatários e respectivo
estado. A consulta dos destinatários causa carga no
SMS Express e deve utilizada com cautela.
Output
SubmissionDetails
submissionId String Identificador da submissão
messageType Integer Tipo da mensagem, valores possíveis:
2 - SMS
3 - SMS_PULL
4 - MMS
7 - EMAIL
8 - WAP_PUSH
startDate Date Data de início de envio da submsissão
endDate Date Data de fim de envio da submsissão
waitMessages Integer Mensagens em espera
sentMessages Integer Mensagens enviadas
failedMessages Integer Mensagens falhadas
notifWaitMessages Integer Mensagens à espera de notificação
canceledMessages Integer Mensagens canceladas
totalMessages Integer Total de mensagens a enviar
status Integer Estado da submissão, valores possíveis:
0 - NOT_STARTED
1 - STARTED
2 - FINISHED
processStatus Integer Sub-estado da submissão, valores possíveis:
0 - OK
1 - TOCONFIRM
2 - CANCEL_STARTED
3 - CANCELED
4 - TOCONFIRM_EXPIRED
5 - CONFIRMED
sender String Nome do utilizador SMS Express que criou a
submissão.
originator String Originador da mensagem.
message String Texto da mensagem.
link String Link da mensagem, se se tratar de uma submissão
WapPush.
notificationRequested Boolean Indica se foi pedido notificação.
creationDate Date Data de criação.
recipientsStatus RecipientsStatus Estado dos destinatários da submissão. Este objecto
tem 5 listas, uma para cada estado, que são:
WWW.MOBICOMP.COM 14
CDP.TSD.00
_____________________________________________________________________________________________
- String[] sent; // Entregues ao SMSC

- String[] waiting; // À espera de ser enviada
- String[] delivered; // Entregues ao destinatário
- String[] canceled; // Canceladas
- String[] failed; // Não enviados devido a erro
Campo SubmissionDetails:
Este objecto com toda a informação acerca da submissão.
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.

ERROR
WWW.MOBICOMP.COM 15
CDP.TSD.00
_____________________________________________________________________________________________

WWW.MOBICOMP.COM 16
CDP.TSD.00
_____________________________________________________________________________________________
cancelSubmission
Este método permite cancelar uma submissão. Se não houver nenhuma submissão com o identificador passado não
é feito nada.
cancelSubmission
Input
AuthenticationInfo
informativo.

Output
void
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.

WWW.MOBICOMP.COM 17
CDP.TSD.00
_____________________________________________________________________________________________

ERROR

WWW.MOBICOMP.COM 18
CDP.TSD.00
_____________________________________________________________________________________________
2. MessageManager
Acesso
WSDL
O WSDL referente a este WebService pode ser obtido nos seguintes endereços:
Ambiente de produção
https://smsexpress.tmn.pt/smsexpress-webservices/MessageManager?wsdl
Ambiente de pré-produção
http://sx-pre.tmn.pt/smsexpress-webservices/MessageManager?wsdl
URL de acesso:
https://smsexpress.tmn.pt/smsexpress-webservices/MessageManager
http://sx-pre.tmn.pt/smsexpress-webservices/MessageManager
createMessage
Este método permite criar mensagens pré-definidas. Recebe a informação relativa à mensagem que se deseja criar
e devolve um objecto com o identificador da mensagem criada.
createMessage
Input
AuthenticationInfo
informativo.
Message
type * String Tipo da mensagem. Valores possíveis:
- SMS (SMS)
WWW.MOBICOMP.COM 19
CDP.TSD.00
_____________________________________________________________________________________________
- WP (Wap Push)
message * String Texto da mensagem
link String Utilizado apenas em mensagens do tipo Wap Push.
Output
Message
id String Identificador da mensagem
type Integer Tipo da mensagem
message String Texto da mensagem
link String Link da mensagem
Campo Message (entrada):
Este objecto é utilizado para passar a informação relativa à mensagem a criar.
Campo Message (saída):
Este objecto é utilizado para devolver a informação relativa ao resultado da criação da mensagem no SMS Express.
O campo id deste objecto indica qual é o id com que a mensagem ficou.
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.
WWW.MOBICOMP.COM 20
CDP.TSD.00
_____________________________________________________________________________________________

ERROR

 0003: Operation not allowed

 0003: Message text can't be null
 0003: Invalid message type
 0003: Link can't be null
 0003: Link is not a valid URL
WWW.MOBICOMP.COM 21
CDP.TSD.00
_____________________________________________________________________________________________
deleteMessage
Este método permite apagar mensagens pré-definidas. Recebe o identificador da mensagem que se deseja apagar.
deleteMessage
Input
AuthenticationInfo
informativo.
id * String Id da mensagem a apagar

Output
Void
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.

WWW.MOBICOMP.COM 22
CDP.TSD.00
_____________________________________________________________________________________________


WWW.MOBICOMP.COM 23
CDP.TSD.00
_____________________________________________________________________________________________
getMessage
Este método permite consultar mensagens pré-definidas. Recebe o identificador da mensagem que se deseja
consultar.
getMessage
Input
AuthenticationInfo
informativo.
id * String Id da mensagem a consultar

Output
Message
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.
WWW.MOBICOMP.COM 24
CDP.TSD.00
_____________________________________________________________________________________________

ERROR

WWW.MOBICOMP.COM 25
CDP.TSD.00
_____________________________________________________________________________________________
getMessages
Este método permite consultar todas as mensagens pré-definidas do utilizador.
getMessages
Input
AuthenticationInfo
informativo.
id * String Identificador da mensagem a consultar

Output
Message[]
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.
WWW.MOBICOMP.COM 26
CDP.TSD.00
_____________________________________________________________________________________________

ERROR

WWW.MOBICOMP.COM 27
CDP.TSD.00
_____________________________________________________________________________________________
3. ContactListManager
Acesso
WSDL
https://smsexpress.tmn.pt/smsexpress-webservices/ContactListManager?wsdl
http://sx-pre.tmn.pt/smsexpress-webservices/ContactListManager?wsdl
URL de acesso:
https://smsexpress.tmn.pt/smsexpress-webservices/ContactListManager
http://sx-pre.tmn.pt/smsexpress-webservices/ContactListManager
createContactList
Este método permite criar listas de contactos pré-definidas. Recebe a informação relativa à lista que se deseja criar
e devolve um objecto com o identificador da lista criada.
createContactList
Input
AuthenticationInfo
informativo.
ContactList
name * String Nome da lista de contactos
description String Descrição da lista de contactos
WWW.MOBICOMP.COM 28
CDP.TSD.00
_____________________________________________________________________________________________
Contact[]
name String Nome do contacto
company String Empresa
msisdn * String Número de telemóvel do contacto
Output
ContactList
id String Identificador da lista de contactos
name String Nome da lista de contactos
Campo ContactList (entrada):
Este objecto é utilizado para passar a informação relativa à lista de contactos a criar.
Campo Contact[] (entrada):
Array com os contactos a criar.
Campo ContactList (saída):
Este objecto é utilizado para devolver a informação relativa ao resultado da criação da mensagem no SMS Express.
O campo id deste objecto indica qual é o id com que a mensagem ficou.
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
WWW.MOBICOMP.COM 29
CDP.TSD.00
_____________________________________________________________________________________________
Fault.

ERROR


 0003: Name can't be null
WWW.MOBICOMP.COM 30
CDP.TSD.00
_____________________________________________________________________________________________
deleteContactList
Este método permite apagar listas de contacto pré-definidas. Recebe o identificador da lista que se deseja apagar.
deleteContactList
Input
AuthenticationInfo
informativo.
id * String Id da lista de contactos a apagar

Output
Void
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.

WWW.MOBICOMP.COM 31
CDP.TSD.00
_____________________________________________________________________________________________


WWW.MOBICOMP.COM 32
CDP.TSD.00
_____________________________________________________________________________________________
getContactList
Este método permite consultar listas de contactos pré-definidas. Recebe o identificador da lista que se deseja
consultar.
getContactList
Input
AuthenticationInfo
informativo.
id * String Id da lista de contactos a consultar

Output
ContactList
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.
WWW.MOBICOMP.COM 33
CDP.TSD.00
_____________________________________________________________________________________________

ERROR

WWW.MOBICOMP.COM 34
CDP.TSD.00
_____________________________________________________________________________________________
getContactLists
Este método permite consultar todas as listas de contactos pré-definidas do utilizador.
getContactLists
Input
AuthenticationInfo
informativo.
Output
ContactList[]
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.

WWW.MOBICOMP.COM 35
CDP.TSD.00
_____________________________________________________________________________________________

ERROR

WWW.MOBICOMP.COM 36
CDP.TSD.00
_____________________________________________________________________________________________
getContacts
Este método permite consultar todos os contactos de uma lista de contactos pré-definida.
getContacts
Input
AuthenticationInfo
informativo.
contactListId * String Id da lista de contactos a consultar

Output
Contact[]
id String Identificador do contacto
name String Nome do contacto
company String Empresa
msisdn String Número de telemóvel do contacto
instance">
<soapenv:Body>
<soapenv:Fault>
<detail>
<ns2:exceptionName
</detail>
</soapenv:Fault>
</soapenv:Body>
</soapenv:Envelope>
Fault.
WWW.MOBICOMP.COM 37
CDP.TSD.00
_____________________________________________________________________________________________

ERROR

 0003: Contact list not found
WWW.MOBICOMP.COM 38
CDP.TSD.00
_____________________________________________________________________________________________
4. SubmissionManager
As aplicações desenvolvidas em data posterior a 21 de Janeiro de 2008, deverão utilizar a nova API
SubmissionManager2 em substituição desta API (SubmissionManager).
Acesso
WSDL
https://smsexpress.tmn.pt/smsexpress-webservices/SubmissionManager?wsdl
http://sx-pre.tmn.pt/smsexpress-webservices/SubmissionManager?wsdl
URL de acesso:
https://smsexpress.tmn.pt/smsexpress-webservices/SubmissionManager
http://sx-pre.tmn.pt/smsexpress-webservices/SubmissionManager
sendMultiSms
É disponibilizado um WebService que permite o envio de uma submissão mediante autenticação. Recebe a
informação relativa à submissão que se deseja enviar e devolve o identificador e estado da submissão no
SMSExpress.
sendMultiSms
Input
AuthInfoWS
application String A preencher com o valor ‘SMSExpress’
login String Login do utilizador que está a efectuar o
envio.
password String Password do utilizador que está a
efectuar o envio.
Submission
message String Texto da mensagem a enviar (alfabeto
7bits GSM)
WWW.MOBICOMP.COM 39
CDP.TSD.00
_____________________________________________________________________________________________
contactLists String Array Listas de contactos do SMSExpress a

utilizar como destinatários. Cada item
deverá ser o identificador da lista de
contactos.
recipients String Array Lista de destinatários individuais.
sender String Originador da mensagem (um dos
configurados para o utilizador
autenticado)
validity Inteiro Validade da mensagem (em horas) (um
dos valores obtidos no WebService
getUserData)
notification Boleano Envio com notificação ou não.
deliveryDate Data Data de início de envio da submissão
Output
Status
status Inteiro Estado da submissão no SMSExpress
message String Texto informativo do resultado da
submissão
Campo AuthInfoWS:
Campo Submission:
Este objecto é utilizado para passar a informação relativa a submissão em que os destinatários são passados como
Campo Status:
Este objecto é utilizado para devolver a informação relativa ao resultado do envio da submissão para o SMSExpress.
O campo status deste objecto indica qual é o estado com que a submissão criada no SMSExpress ficou.
Os valores possíveis para este campo são:
1 - O envio foi submetido com sucesso e irá ser enviado na data escolhida.
<soap:Body>
<soap:Fault>
<faultcode>soap:Server</faultcode>
<faultstring>0001:Invalid application</faultstring>
<detail>
<code>0000</code>
<message> Invalid application </message>
</detail>
</soap:Fault>
WWW.MOBICOMP.COM 40
CDP.TSD.00
_____________________________________________________________________________________________
</soap:Body>
Esta informação pode ser obtida no campo faultstring da Soap Fault, ou no elemento details¸onde existem os
elementos code e message com informação sobre o problema detectado. Um exemplo de um valor transportado
dentro de faultstring é: “0001: Invalid application”.
A aplicação cliente deverá utilizar um destes campos para obter informação mais detalhada sobre o erro que deu
origem à SOAP Fault.
Estes são os códigos de erro genéricos que podem acontecer em qualquer dos serviços disponibilizados.

ERROR


WWW.MOBICOMP.COM 41
CDP.TSD.00
_____________________________________________________________________________________________
Anexo A – Exemplos de utilização
WWW.MOBICOMP.COM 42
CDP.TSD.00
_____________________________________________________________________________________________
SubmissionManager2
sendSmsSubmission
Pedido
<?xml version="1.0" encoding="UTF-8"?>
instance">
<soapenv:Body>
<ns1:sendSmsSubmission soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:ns1="http://mobicomp.com/smsexpress/webservice/server/message">
<authentication href="#id0"/>
<submission href="#id1"/>
</ns1:sendSmsSubmission>
<multiRef id="id0" soapenc:root="0"
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xsi:type="ns2:AuthenticationInfo" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:ns2="http://common.server.webservice.smsexpress.mobicomp.com">
<application xsi:type="soapenc:string">Teste</application>
<password xsi:type="soapenc:string">fJ2ewkHj</password>
<username xsi:type="soapenc:string">1234321</username>
</multiRef>
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns3:SmsSubmission"
xmlns:ns3="http://mobicomp.com/smsexpress/webservice/server/message"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<contactLists xsi:type="soapenc:string" xsi:nil="true"/>
<deliveryDate xsi:type="xsd:dateTime">2008-07-18T15:51:09.610Z</deliveryDate>
<notification href="#id2"/>
<notificationRecipient xsi:type="soapenc:string" xsi:nil="true"/>
<notificationType xsi:type="soapenc:string" xsi:nil="true"/>
<recipients soapenc:arrayType="soapenc:string[2]" xsi:type="soapenc:Array">
<recipients xsi:type="soapenc:string">968690227</recipients>
</recipients>
<sender xsi:type="soapenc:string">MC</sender>
<validity href="#id3"/>
<alphabet xsi:type="soapenc:string" xsi:nil="true"/>
<message xsi:type="soapenc:string">Envio de mensagem através de web
service</message>
<substitutions xsi:type="soapenc:string" xsi:nil="true"/>
<useSubstitutions href="#id4"/>
</multiRef>
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:boolean"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">false</multiRef>
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="xsd:int"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">30</multiRef>
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">true</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:sendSmsSubmissionResponse
<sendSmsSubmissionReturn href="#id0"/>
</ns1:sendSmsSubmissionResponse>
WWW.MOBICOMP.COM 43
CDP.TSD.00
_____________________________________________________________________________________________

soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:SubmissionStatus"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
<id xsi:type="soapenc:string">25680122</id>
<message xsi:type="soapenc:string">Submissão enviada para processamento.
</message>
<status href="#id1"/>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Pedido
instance">
<soapenv:Body>
<ns1:sendSmsPullSubmission
<submission href="#id1"/>
</ns1:sendSmsPullSubmission>
</multiRef>
xsi:type="ns3:SmsPullSubmission"
<contactLists xsi:type="soapenc:string" xsi:nil="true"/>
<notification href="#id2"/>
<notificationRecipient xsi:type="soapenc:string" xsi:nil="true"/>
<notificationType xsi:type="soapenc:string" xsi:nil="true"/>
<recipients soapenc:arrayType="soapenc:string[1]" xsi:type="soapenc:Array">
</recipients>
<sender xsi:type="soapenc:string">MC</sender>
<validity href="#id3"/>
<alphabet xsi:type="soapenc:string" xsi:nil="true"/>
<message xsi:type="soapenc:string">flashtmn</message>
<substitutions xsi:type="soapenc:string" xsi:nil="true"/>
<useSubstitutions href="#id4"/>
<acceptNonAddresseesResponses href="#id5"/>
<billingId xsi:type="soapenc:string">1</billingId>
<responseAcceptedMessage xsi:type="soapenc:string">resposta
aceite</responseAcceptedMessage>
<submissionCode xsi:type="soapenc:string">111</submissionCode>
<validUntil xsi:type="xsd:dateTime">2007-09-30T23:00:00.000Z</validUntil>
</multiRef>
WWW.MOBICOMP.COM 44
CDP.TSD.00
_____________________________________________________________________________________________

</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:sendSmsPullSubmissionResponse
<sendSmsPullSubmissionReturn href="#id0"/>
</ns1:sendSmsPullSubmissionResponse>
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:SubmissionStatus"
<message xsi:type="soapenc:string">Submissão enviada para processamento.
</message>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Pedido
instance">
<soapenv:Body>
<ns1:getSmsPullSubmissionResponses
<submissionId xsi:type="soapenc:string"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">25680129</submissionId>
</ns1:getSmsPullSubmissionResponses>
</multiRef>
WWW.MOBICOMP.COM 45
CDP.TSD.00
_____________________________________________________________________________________________
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:getSmsPullSubmissionResponsesResponse
<getSmsPullSubmissionResponsesReturn
soapenc:arrayType="ns1:SmsPullSubmissionResponse[0]" xsi:type="soapenc:Array"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"/>
</ns1:getSmsPullSubmissionResponsesResponse>
</soapenv:Body>
</soapenv:Envelope>
getSubmissionStatus
Pedido
instance">
<soapenv:Body>
<ns1:getSubmissionStatus
</ns1:getSubmissionStatus>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:getSubmissionStatusResponse
<getSubmissionStatusReturn href="#id0"/>
</ns1:getSubmissionStatusResponse>
xsi:type="ns2:SubmissionStatus2" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
<canceledMessages href="#id1"/>
<endDate xsi:type="xsd:dateTime">2008-07-18T15:55:15.663Z</endDate>
<failedMessages href="#id2"/>
WWW.MOBICOMP.COM 46
CDP.TSD.00
_____________________________________________________________________________________________
<messageType href="#id3"/>
<notifWaitMessages href="#id4"/>
<processStatus href="#id5"/>
<sentMessages href="#id6"/>
<startDate xsi:type="xsd:dateTime">2008-07-18T15:55:15.663Z</startDate>
<submissionId xsi:type="soapenc:string">25680129</submissionId>
<totalMessages href="#id8"/>
<waitMessages href="#id9"/>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Pedido
instance">
<soapenv:Body>
<ns1:getSubmissionDetails
<getRecipientsStatus href="#id1"/>
</ns1:getSubmissionDetails>
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">true</multiRef>
xsi:type="ns2:AuthenticationInfo"
xmlns:ns2="http://common.server.webservice.smsexpress.mobicomp.com"
WWW.MOBICOMP.COM 47
CDP.TSD.00
_____________________________________________________________________________________________
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:getSubmissionDetailsResponse
<getSubmissionDetailsReturn href="#id0"/>
</ns1:getSubmissionDetailsResponse>
xsi:type="ns2:SubmissionDetails" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/"
<canceledMessages href="#id1"/>
<creationDate xsi:type="xsd:dateTime">2008-07-18T15:55:15.944Z</creationDate>
<endDate xsi:type="xsd:dateTime" xsi:nil="true"/>
<failedMessages href="#id2"/>
<link xsi:type="soapenc:string" xsi:nil="true"/>
<message xsi:type="soapenc:string">flashtmn</message>
<messageType href="#id3"/>
<notifWaitMessages href="#id4"/>
<notificationRequested href="#id5"/>
<originator xsi:type="soapenc:string">MC</originator>
<processStatus href="#id6"/>
<recipientsStatus href="#id7"/>
<sender xsi:type="soapenc:string">MC MS</sender>
<sentMessages href="#id8"/>
<startDate xsi:type="xsd:dateTime">2008-07-18T15:55:15.663Z</startDate>
<submissionId xsi:type="soapenc:string">25680129</submissionId>
<totalMessages href="#id10"/>
<waitMessages href="#id11"/>
</multiRef>
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns3:RecipientsStatus"
<canceled soapenc:arrayType="soapenc:string[0]" xsi:type="soapenc:Array"/>
<delivered soapenc:arrayType="soapenc:string[0]" xsi:type="soapenc:Array"/>
<failed soapenc:arrayType="soapenc:string[0]" xsi:type="soapenc:Array"/>
<sent soapenc:arrayType="soapenc:string[0]" xsi:type="soapenc:Array"/>
<waiting soapenc:arrayType="soapenc:string[1]" xsi:type="soapenc:Array">
<waiting xsi:type="soapenc:string">968690225</waiting>
</waiting>
</multiRef>
WWW.MOBICOMP.COM 48
CDP.TSD.00
_____________________________________________________________________________________________

</soapenv:Body>
</soapenv:Envelope>
cancelSubmission
Pedido
instance">
<soapenv:Body>
<ns1:cancelSubmission soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
</ns1:cancelSubmission>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:cancelSubmissionResponse
xmlns:ns1="http://mobicomp.com/smsexpress/webservice/server/message"/>
</soapenv:Body>
</soapenv:Envelope>
WWW.MOBICOMP.COM 49
CDP.TSD.00
_____________________________________________________________________________________________
MessageManager
createMessage
Pedido
instance">
<soapenv:Body>
<ns1:createMessage soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
<message href="#id1"/>
</ns1:createMessage>
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns2:Message"
<id xsi:type="soapenc:string" xsi:nil="true"/>
<message xsi:type="soapenc:string">Teste de criação de mensagem SMS
através de web service</message>
<type xsi:type="soapenc:string">SMS</type>
</multiRef>
xsi:type="ns3:AuthenticationInfo"
xmlns:ns3="http://common.server.webservice.smsexpress.mobicomp.com"
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:createMessageResponse
<createMessageReturn href="#id0"/>
</ns1:createMessageResponse>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
WWW.MOBICOMP.COM 50
CDP.TSD.00
_____________________________________________________________________________________________
deleteMessage
Pedido
instance">
<soapenv:Body>
<ns1:deleteMessage soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
<id xsi:type="soapenc:string"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">55101400</id>
</ns1:deleteMessage>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:deleteMessageResponse
xmlns:ns1="http://mobicomp.com/smsexpress/webservice/server/message"/>
</soapenv:Body>
</soapenv:Envelope>
getMessage
Pedido
instance">
<soapenv:Body>
<ns1:getMessage soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
</ns1:getMessage>
</multiRef>
WWW.MOBICOMP.COM 51
CDP.TSD.00
_____________________________________________________________________________________________
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:getMessageResponse
<getMessageReturn href="#id0"/>
</ns1:getMessageResponse>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
getMessages
Pedido
instance">
<soapenv:Body>
<ns1:getMessages soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
</ns1:getMessages>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:getMessagesResponse
<getMessagesReturn soapenc:arrayType="ns1:Message[2]" xsi:type="soapenc:Array"
<getMessagesReturn href="#id0"/>
<getMessagesReturn href="#id1"/>
WWW.MOBICOMP.COM 52
CDP.TSD.00
_____________________________________________________________________________________________
</getMessagesReturn>
</ns1:getMessagesResponse>
<link xsi:type="soapenc:string">http://</link>
<message xsi:type="soapenc:string">Teste de criação de mensagem Wap Push
<type xsi:type="soapenc:string">WP</type>
</multiRef>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
WWW.MOBICOMP.COM 53
CDP.TSD.00
_____________________________________________________________________________________________
ContactListManager
createContactList
Pedido
instance">
<soapenv:Body>
<ns1:createContactList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:ns1="http://mobicomp.com/smsexpress/webservice/server/contactlist">
<contactList href="#id1"/>
<contacts soapenc:arrayType="ns1:Contact[2]" xsi:type="soapenc:Array"
<contacts href="#id2"/>
<contacts href="#id3"/>
</contacts>
</ns1:createContactList>
</multiRef>
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns3:Contact"
xmlns:ns3="http://mobicomp.com/smsexpress/webservice/server/contactlist"
<company xsi:type="soapenc:string">MobiComp</company>
<msisdn xsi:type="soapenc:string">253305251</msisdn>
<name xsi:type="soapenc:string">JP</name>
</multiRef>
soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xsi:type="ns4:ContactList"
<description xsi:type="soapenc:string">Contactos de Braga</description>
<name xsi:type="soapenc:string">Braga</name>
</multiRef>
<name xsi:type="soapenc:string">GC</name>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
WWW.MOBICOMP.COM 54
CDP.TSD.00
_____________________________________________________________________________________________
<ns1:createContactListResponse
<createContactListReturn href="#id0"/>
</ns1:createContactListResponse>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
deleteContactList
Pedido
instance">
<soapenv:Body>
<ns1:deleteContactList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
</ns1:deleteContactList>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:deleteContactListResponse
xmlns:ns1="http://mobicomp.com/smsexpress/webservice/server/contactlist"/>
</soapenv:Body>
</soapenv:Envelope>
getContactList
Pedido
WWW.MOBICOMP.COM 55
CDP.TSD.00
_____________________________________________________________________________________________
instance">
<soapenv:Body>
<ns1:getContactList soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
</ns1:getContactList>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:getContactListResponse
<getContactListReturn href="#id0"/>
</ns1:getContactListResponse>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
getContactLists
Pedido
instance">
<soapenv:Body>
<ns1:getContactLists soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
</ns1:getContactLists>
</multiRef>
</soapenv:Body>
WWW.MOBICOMP.COM 56
CDP.TSD.00
_____________________________________________________________________________________________
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:getContactListsResponse
<getContactListsReturn soapenc:arrayType="ns1:ContactList[1]"
xsi:type="soapenc:Array" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">
<getContactListsReturn href="#id0"/>
</getContactListsReturn>
</ns1:getContactListsResponse>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
getContacts
Pedido
instance">
<soapenv:Body>
<ns1:getContacts soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
<contactListId xsi:type="soapenc:string"
xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/">55101415</contactListId>
</ns1:getContacts>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
Resposta
instance">
<soapenv:Body>
<ns1:getContactsResponse
<getContactsReturn soapenc:arrayType="ns1:Contact[2]" xsi:type="soapenc:Array"
WWW.MOBICOMP.COM 57
CDP.TSD.00
_____________________________________________________________________________________________
<getContactsReturn href="#id0"/>
<getContactsReturn href="#id1"/>
</getContactsReturn>
</ns1:getContactsResponse>
<name xsi:type="soapenc:string">JP</name>
</multiRef>
<name xsi:type="soapenc:string">GC</name>
</multiRef>
</soapenv:Body>
</soapenv:Envelope>
WWW.MOBICOMP.COM 58
CDP.TSD.00
_____________________________________________________________________________________________
SubmissionManager
sendMultiSms
Pedido
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:sms="http://www.mobicomp.com/smsexpress"
<soapenv:Header/>
<soapenv:Body>
<sms:sendMultiSms soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<auth xsi:type="com:AuthInfoWS"
xmlns:com="http://www.themindelectric.com/package/com.mobicomp.mmh.sms.webservice.server/">
<application xsi:type="xsd:string">Teste</application>
<login xsi:type="xsd:string">1234321</login>
<password xsi:type="xsd:string">fJ2ewkHj</password>
</auth>
<multiSms xsi:type="com:Submission"
xmlns:com="http://www.themindelectric.com/package/com.mobicomp.smsexpress.webservice.server.submi
ssion/">
<message xsi:type="xsd:string">Envio de teste</message>
<contactLists xsi:type="java:ArrayOfstring" soapenc:arrayType="xsd:string[]"
xmlns:java="http://www.themindelectric.com/package/java.lang/"/>
<recipients xsi:type="java:ArrayOfstring" soapenc:arrayType="xsd:string[]"
xmlns:java="http://www.themindelectric.com/package/java.lang/">
<recipients
xsi:type="soapenc:string">968690225</recipients>
</recipients>
<sender xsi:type="xsd:string">MC</sender>
<validity xsi:type="xsd:int">48</validity>
<notification xsi:type="xsd:boolean">true</notification>
</multiSms>
</sms:sendMultiSms>
</soapenv:Body>
</soapenv:Envelope>
Resposta
<soap:Envelope soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns5="http://www.themindelectric.com/package/com.mobicomp.smsexpress.webservice.server.submi
ssion/">
<soap:Body>
<n:sendMultiSmsResponse xmlns:n="http://www.mobicomp.com/smsexpress">
<Result href="#id0"/>
</n:sendMultiSmsResponse>
<id0 id="id0" soapenc:root="0" xsi:type="ns5:Status">
<id xsi:type="xsd:string">55121400</id>
<status xsi:type="xsd:int">1</status>
<message xsi:type="xsd:string">Submissão enviada para processamento.</message>
</id0>
</soap:Body>
</soap:Envelope>
WWW.MOBICOMP.COM 59
CDP.TSD.00

SMSExpressWebServices 1

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

SMSExpressWebServices 1

Uploaded by

Copyright:

Available Formats

SMS Express Web Services

A API disponibilizada é suportada por WebServices sobre HTTP/HTTPS e necessita de autenticação.

Esta API (SubmissionManager2) substituiu, a partir de 21 de Janeiro de 2008, a API SubmissionManager. No

O WSDL referente a este WebService pode ser obtido no seguinte endereço:

O seguinte URL deverá ser utilizado para o acesso ao WebService:

A tabela seguinte especifica os parâmetros de entrada e de saída do WebService.

Este objecto é utilizado para passar a informação de autenticação à plataforma.

Tratamento de anomalias e situações de erro

Estes são os códigos de erro genéricos que podem acontecer.

Código Criticidade Significado

 0002:Password has expired

 0003:Tem de escolher pelo menos uma lista de contactos SMSExpress ou um contacto

A tabela seguinte especifica os parâmetros de entrada e de saída do WebService.

(2) Estes campos ainda não estão em uso.

Este objecto é utilizado para passar a informação de autenticação à plataforma.

Tratamento de anomalias e situações de erro

Estes são os códigos de erro genéricos que podem acontecer.

Código Criticidade Significado

descrição textual do erro

 0002:Password has expired

A tabela seguinte especifica os parâmetros de entrada e de saída do WebService.

submissionId * String Identificador da submissão

Este objecto é utilizado para passar a informação de autenticação à plataforma.

Este objecto representa uma resposta recebida.

Tratamento de anomalias e situações de erro

Estes são os códigos de erro genéricos que podem acontecer.

Código Criticidade Significado

 0002:Password has expired

A tabela seguinte especifica os parâmetros de entrada e de saída do WebService.

submissionId * String Identificador da submissão

Este objecto é utilizado para passar a informação de autenticação à plataforma.

Este objecto representa o estado da submissão.

Tratamento de anomalias e situações de erro

Estes são os códigos de erro genéricos que podem acontecer.

Código Criticidade Significado

 0002:Password has expired

A tabela seguinte especifica os parâmetros de entrada e de saída do WebService.

submissionId * String Identificador da submissão

- String[] sent; // Entregues ao SMSC

Este objecto é utilizado para passar a informação de autenticação à plataforma.

Este objecto com toda a informação acerca da submissão.

Tratamento de anomalias e situações de erro

Estes são os códigos de erro genéricos que podem acontecer.

Código Criticidade Significado

 0002:Password has expired

A tabela seguinte especifica os parâmetros de entrada e de saída do WebService.

submissionId * String Identificador da submissão

Este objecto é utilizado para passar a informação de autenticação à plataforma.

Tratamento de anomalias e situações de erro

Estes são os códigos de erro genéricos que podem acontecer.

Código Criticidade Significado

0002 ERROR Erro de autenticação

 0002:Password has expired

A API disponibilizada é suportada por WebServices sobre HTTP/HTTPS e necessita de autenticação.

O seguinte URL deverá ser utilizado para o acesso ao WebService:

A tabela seguinte especifica os parâmetros de entrada e de saída do WebService.

Este objecto é utilizado para passar a informação de autenticação à plataforma.

Campo Message (entrada):

Este objecto é utilizado para passar a informação relativa à mensagem a criar.

Campo Message (saída):

O campo id deste objecto indica qual é o id com que a mensagem ficou.

Tratamento de anomalias e situações de erro

Estes são os códigos de erro genéricos que podem acontecer.