| Serviço | Operação | Descrição |
|---|---|---|
| MessageNotification | notifyMessageDeliveryReceipt | Usada quando uma mensagem MMS previamente enviada (com sendMessage ou sendMessageWithInlineAttachments) tiver mudado o estado. |
| SendMessage | getMessageDeliveryStatus | Obtém o estado de entrega de uma mensagem MMS enviada. Esta operação pode ser usada em alternativa à interface notification. |
| sendMessage | Usada para enviar uma mensagem MMS para um ou mais destinatários. Opcionalmente, pode notificar um endpoint quando há uma mudança de estado de entrega. Esta API usa SwA; para uma interface não SwA use o serviço SendMessageInlineAttachments. |
|
| SendMessageInlineAttachments | sendMessageWithInlineAttachments | Envia uma mensagem MMS para um ou mais destinatários. Opcionalmente, pode notificar um endpoint aquando da mudança de estado na entrega de uma mensagem. |
Serviço MessageNotification
notifyMessageDeliveryReceipt
Usada quando uma mensagem MMS previamente enviada (com sendMessage ou sendMessageWithInlineAttachments) tiver mudado o estado.
Parâmetros do pedido
- correlator : string (mandatório)
Usada para informar o estado de entrega de uma mensagem MMS previamente enviada (com a operação sendMessage do serviço OneAPI/MMS/SendMessage).
- deliveryStatus : DeliveryInformation (mandatório)
Indica o estado de entrega para um endereço de destino.
Serviço SendMessage
getMessageDeliveryStatus
Obtém o estado de entrega de uma mensagem MMS enviada.
Esta operação pode ser usada em alternativa à interface notification.
Parâmetros do pedido
- requestIdentifier : string (mandatório)
O identificador da mensagem MMS enviada.
Este é o valor do resultado retornado pela operação sendMessage.
Parâmetros de resposta
- result : DeliveryInformation (opcional)
O estado de entrega.
Estado de entrega de uma mensagem MMS enviada
O seguinte exemplo mostra como obter o estado de entrega de uma mensagem MMS enviada.
E a correspondente resposta, de sucesso:
sendMessage
Usada para enviar uma mensagem MMS para um ou mais destinatários. Opcionalmente, pode notificar um endpoint quando há uma mudança de estado de entrega.
Esta API usa SwA; para uma interface não SwA use o serviço SendMessageInlineAttachments.
Parâmetros do pedido
- addresses : anyURI (mandatório)
Uma lista de um ou mais endereços de telefone de destino.
Um endereço de telefone tem o formato
tel:número, ondenúmeroé o número de telefone (incluindo o código do país) internacional, ex.tel:+351213456789(formato E.164).- senderAddress : string (opcional)
O nome do remetente.
Este nome deverá ter o formato
[UMA LETRA][UM ou MAIS: LETRA ou DIGITO], eg.Neo.A OneAPI define este parâmetro como opcional, no entanto, na nossa implementação este parâmetro é mandatório.
- subject : string (opcional)
O assunto do MMS.
- priority : MessagePriority (opcional)
A prioridade da mensagem.
- charging : ChargingInformation (opcional)
Não use este parâmetro. Não é usado pela nossa implementação.
- receiptRequest : SimpleReference (opcional)
Define o endpoint que deve ser notificado quando o estado de entrega foi alterado, ex. quando a mensagem foi entregue no terminal.
- format : MessageFormat (opcional)
O formato da mensagem.
Actualmente apenas é suportado o
MMS.
Parâmetros de resposta
- result : string (mandatório)
O identificador da mensagem MMS enviada.
Enviar MMS com notificação de recepção
O seguinte exemplo mostra como enviar um MMS e receber a notificação de entrega quando o seu estado de entrega muda (ex. quando é entregue no terminal móvel).
E a correspondente resposta, de sucesso:
Quando o MMS é entregue no terminal, a aplicação irá receber a seguinte mensagem de notificação:
Serviço SendMessageInlineAttachments
sendMessageWithInlineAttachments
Envia uma mensagem MMS para um ou mais destinatários. Opcionalmente, pode notificar um endpoint aquando da mudança de estado na entrega de uma mensagem.
Parâmetros do pedido
- addresses : anyURI (mandatório)
Uma lista de um ou mais endereços de telefone de destino.
Um endereço é um URL no formato
tel:endereço-completo, ondeendereçoé um número de telefone internacional (incluí o código do país), ex.tel:+351213456789(formato E.164).- senderAddress : string (opcional)
O nome do remetente.
Este nome deverá ter o formato
[UMA LETRA][UM ou MAIS: LETRA ou DIGITO], eg.Neo.A OneAPI define este parâmetro como opcional, no entanto, na nossa implementação este parâmetro é mandatório.
- subject : string (opcional)
O assunto do MMS.
- priority : MessagePriority (opcional)
A prioridade da mensagem.
- charging : ChargingInformation (opcional)
Não use este parâmetro. Não é usado pela nossa implementação.
- receiptRequest : SimpleReference (opcional)
Define o endpoint que deve ser notificado quando o estado de entrega foi alterado, ex. quando a mensagem foi entregue no terminal.
- format : MessageFormat (opcional)
O formato da mensagem.
Actualmente apenas é suportado o
MMS.- attachments : Attachments (mandatório)
Uma lista de anexos.
Parâmetros de resposta
- result : string (mandatório)
Enviar MMS com anexos
O seguinte exemplo mostra como enviar um MMS e receber notificação de entrega quando o seu estado de entrega muda (ex. quando a mensagem é entregue no terminal móvel).
E a correspondente resposta, de sucesso:
MessageNotification Entidades
DeliveryInformation
Estado de entrega da mensagem enviada a um determinado endereço de destino.
| Nome do atributo | Descrição |
|---|---|
| address : anyURI | Endereço de destino. ex. tel:+351213456789. |
| deliveryStatus : DeliveryStatus | O estado da entrega. |
| description : string (opcional) | Descrição do estado de entrega. |
DeliveryStatus
O estado de entrega de uma mensagem.
| Valor | Descrição |
|---|---|
| DeliveredToTerminal | Entregue com sucesso no Terminal. |
| DeliveryUncertain | Estado de entrega desconhecido. ex. porque foi entregue a outra rede. |
| DeliveryImpossible | Entrega sem sucesso. Não se conseguiu entregar a mensagem antes da sua expiração. |
| MessageWaiting | A mensagem ainda está na fila para ser entregue. É um estado temporário, aguardando transição para um dos estados precendentes. |
| DeliveredToNetwork | Entregue com sucesso no serviço de rede responsável pelo encaminhamento de mensagens. |
| DeliveryNotificationNotSupported | Não é possivel fornecer notificação de aviso de entrega. |
SendMessage Entidades
ChargingInformation
| Nome do atributo | Descrição |
|---|---|
| Lista de description : string | |
| currency : string (opcional) | |
| amount : decimal (opcional) | |
| code : string (opcional) |
DeliveryInformation
Estado de entrega da mensagem enviada a um determinado endereço de destino.
| Nome do atributo | Descrição |
|---|---|
| address : anyURI | Endereço de destino. ex. tel:+351213456789. |
| deliveryStatus : DeliveryStatus | O estado da entrega. |
| description : string (opcional) | Descrição do estado de entrega. |
DeliveryStatus
O estado de entrega de uma mensagem.
| Valor | Descrição |
|---|---|
| DeliveredToTerminal | Entregue com sucesso no Terminal. |
| DeliveryUncertain | Estado de entrega desconhecido. ex. porque foi entregue a outra rede. |
| DeliveryImpossible | Entrega sem sucesso. Não se conseguiu entregar a mensagem antes da sua expiração. |
| MessageWaiting | A mensagem ainda está na fila para ser entregue. É um estado temporário, aguardando transição para um dos estados precendentes. |
| DeliveredToNetwork | Entregue com sucesso no serviço de rede responsável pelo encaminhamento de mensagens. |
| DeliveryNotificationNotSupported | Não é possivel fornecer notificação de aviso de entrega. |
MessageFormat
Formato da mensagem.
Actualmente apenas é suportado o MMS.
| Valor | Descrição |
|---|---|
| MMS | A mensagem é uma mensagem MMS. Actualmente apenas é suportado o |
| WapPush | |
| SMS | |
| EMS | |
| SmartMessaging | |
| IM | |
| IMPagerMode | |
| IMLargeMessage | |
| IMFileTransfer | |
MessagePriority
Prioridade da mensagem. Deve ser usado o valor Default
| Valor | Descrição |
|---|---|
| Default | Padrão |
| Low | Baixa |
| Normal | Normal |
| High | Alta |
SimpleReference
| Nome do atributo | Descrição |
|---|---|
| endpoint : anyURI | |
| interfaceName : string | |
| correlator : string |
SendMessageInlineAttachments Entidades
Attachment
Lista de anexos.
| Nome do atributo | Descrição | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| id : string | O identificador deste anexo. |
|||||||||||||||
| type : string |
Tipo de média do anexo (texto, imagem, áudio ou video). Como existem inúmeros tipos de dispositivos móveis no mercado, recomenda-se o uso do seguinte subconjunto de médias:
|
|||||||||||||||
| body : base64Binary | Os conteúdos do anexo (codificado em base64). |
Attachments
Lista de anexos.| Nome do atributo | Descrição |
|---|---|
| Lista de attachment : Attachment (opcional) |
ChargingInformation
| Nome do atributo | Descrição |
|---|---|
| Lista de description : string | |
| currency : string (opcional) | |
| amount : decimal (opcional) | |
| code : string (opcional) |
MessageFormat
Formato da mensagem.
Actualmente apenas é suportado o MMS.
| Valor | Descrição |
|---|---|
| MMS | A mensagem é uma mensagem MMS. Actualmente apenas é suportado o |
| WapPush | |
| SMS | |
| EMS | |
| SmartMessaging | |
| IM | |
| IMPagerMode | |
| IMLargeMessage | |
| IMFileTransfer | |
MessagePriority
Prioridade da mensagem. Deve ser usado o valor Default
| Valor | Descrição |
|---|---|
| Default | Padrão |
| Low | Baixa |
| Normal | Normal |
| High | Alta |
SimpleReference
| Nome do atributo | Descrição |
|---|---|
| endpoint : anyURI | |
| interfaceName : string | |
| correlator : string |