MiddlewareSmsExpress
Integração com SMSExpress
Como activar um cliente
- Criar conta na E-goi
- Criar um remetente de SMS
- Activar a Transacional (Slingshot)
- Alterar o endpoint para o do metodo desejado
- Alterar a password para a APIKEY da E-goi
Personalizar tipo de codificação (campo não obrigatório - 'codification')
- Usar apenas os seguintes tipos de codificação na construção do xml: "gsm" ou "unicode"
Usar group (campo não obrigatório - 'group')
- Criar o group "SmsExpress" na conta E-goi
- Usar apenas este group específico na construção do xml
Índice
sendSmsSubmission \
sendMultiSms \
Códigos de erro \
Exemplos de pedidos\
Exemplos de respostas
Endpoints
sendSmsSubmission
Request
Campos |
Tipo |
Obrigatorios |
Exemplos |
username |
String |
SIM |
"546849" |
password |
String |
SIM |
"****" |
message |
String |
SIM |
"Mensagem de teste" |
sender |
String |
SIM |
"MEO" |
recipients |
Array(String) |
SIM |
900000000 |
deliveryDate |
Data |
NAO |
2010-12-28T12:40:06.002Z |
group |
String |
NAO |
"SmsExpress" |
codification |
String |
NAO |
"gsm" ou "unicode" |
notification |
boolean |
NAO |
true/false |
notificationType |
String |
NAO |
HTTPPOST/HTTPGET |
notificationRecipient |
String |
NAO |
https://oseusite.com/notification |
useSubstitutions |
boolean |
NAO |
Não implementado |
substitutions |
String[][] |
NAO |
Não implementado |
Response
Campos |
Tipo |
Exemplos |
id |
String |
Identificador |
status |
Integer |
0 |
message |
String |
Submissão enviada para processamento |
sendMultiSms
Request
Campos |
Tipo |
Obrigatorios |
Exemplos |
application |
String |
NÃO |
"546849" |
username |
String |
SIM |
"546849" |
password |
String |
SIM |
"****" |
message |
String |
SIM |
"Mensagem de teste" |
sender |
String |
SIM |
"MEO" |
recipients |
Array(String) |
SIM |
900000000 |
deliveryDate |
Data |
NAO |
2010-12-28T12:40:06.002Z |
group |
String |
NAO |
"SmsExpress" |
codification |
String |
NAO |
"gsm" ou "unicode" |
Response
Campos |
Tipo |
Exemplos |
id |
String |
Identificador |
status |
Integer |
0 |
message |
String |
Submissão enviada para processamento |
Códigos de Erro
code
- 0001 - Aplicação Inválida.
- 0002 - Erro de autenticação.
- 0003 - Campo com formato inválido. O nome do campo vem na descrição textual do erro.
- 0004 - Namespace inválido. Use 'soapenv', 'soap-env' ou 's'.
- 0005 - Group inválido. Use 'SmsExpress'.
- 0006 - Codificação inválida. Use 'gsm' ou 'unicode'.
- 0007 - Formato de dados inválido.
faultString
Valores possíveis (em função do code):
Se code = 0002
- A sua conta encontra-se bloqueada.
- O acesso à sua conta não está disponível. Para mais informações contacte o seu Gestor de Conta ou a Linha Altice Empresas, ligando 808 20 50 20.
- Username ou password inválidos. Tente novamente.
Se code = 0003
- Operação não permitida.
- Lista de contactos não existe
- Campo com formato inválido
- Tem de escolher pelo menos uma lista de contactos SMS Express ou um contacto
- Por favor indique a Mensagem a enviar
A mensagem não pode ter mais de 1530
carateres
- Invalid originator:
- Não tem destinatários válidos
- Não tem destinatários válidos. Para enviar mensagens para destinos internacionais deverá escolher, por favor, um originador numérico. Caso não tenha disponível este originador deverá pedir a sua criação antes de efetuar o envio.
- Horário de envio inválido
- Foi excedido o número máximo de SMS diário
- Foi excedido o número máximo de SMS mensal
- Mensagens binárias não são válidas para esta campanha
- Notificações do tipo HTTPPOST/HTTPGET não são válidas para esta campanha
- NotificationRecipient: o link não é um URL válido
Exemplos de Pedidos
sendSmsSubmission:
<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>
<sendSmsSubmission xmlns="http://mobicomp.com/smsexpress/webservice/server/message">
<authentication xmlns="">
<application xsi:nil="true"/>
<password>apikeydoegoi</password>
<username>smsexpress</username>
</authentication>
<submission xmlns="">
<contactLists xsi:nil="true"/>
<deliveryDate xsi:nil="true"/>
<group xsi:nil="true"/>
<codification xsi:nil="true"/>
<notification>true</notification>
<notificationRecipient>http://oseusite.pt/notification.php</notificationRecipient>
<notificationType>HTTPGET</notificationType>
<recipients>
<item>900000000</item>
<item>900000001</item>
<item>900000002</item>
</recipients>
<sender>MEO</sender>
<validity>6</validity>
<alphabet xsi:nil="true"/>
<message>É uma mensagem de teste! çç!</message>
<substitutions xsi:nil="true"/>
<useSubstitutions>false</useSubstitutions>
</submission>
</sendSmsSubmission>
</soapenv:Body>
</soapenv:Envelope>
sendMultiSms:
<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>
<sendMultiSms xmlns="http://www.mobicomp.com/smsexpress">
<auth xmlns="">
<application xsi:nil="true"/>
<login>smsexpress</login>
<password>e20272f0238fa96e52fdddebef8a0062c57f207b</password>
</auth>
<multiSms xmlns="">
<contactList xsi:nil="true"/>
<contactLists xsi:nil="true"/>
<deliveryDate xsi:nil="true"/>
<group xsi:nil="true"/>
<codification xsi:nil="true"/>
<message>teste de envio multisms</message>
<notification>false</notification>
<recipients>
<recipients>900000000</recipients>
<recipients>900000001</recipients>
</recipients>
<sender>MEO</sender>
<validity>0</validity>
</multiSms>
</sendMultiSms>
</soapenv:Body>
</soapenv:Envelope>
Exemplos de Respostas
Resposta de sucesso:
<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
<env:Header></env:Header>
<env:Body>
<ns1:sendSmsSubmissionResponse xmlns:ns1='http://mobicomp.com/smsexpress/webservice/server/message'>
<sendSmsSubmissionReturn>
<id>40560</id>
<message>Submissão enviada para processamento.</message>
<status>0</status>
</sendSmsSubmissionReturn>
</ns1:sendSmsSubmissionResponse>
</env:Body>
</env:Envelope>
Resposta de erro:
<env:Envelope xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
<env:Header></env:Header>
<env:Body>
<env:Fault xmlns:env='http://schemas.xmlsoap.org/soap/envelope/'>
<code xmlns:codeNS='http://schemas.xmlsoap.org/soap/envelope/'>codeNS:0003 </code>
<faultstring>O destinatário não é válido</faultstring>
<detail><code>0003</code>
<message>O destinatário não é válido</message>
</detail>
</env:Fault>
</env:Body>
</env:Envelope>