| Serviço | Operação | Descrição |
|---|---|---|
| VoiceSMS | GetSubmissionDetails | Consulta o estado de uma submissão. Se não houver nenhuma submissão com o identificador passado então não é feito nada. Se o utilizador usado na autenticação for Administrador apenas as submissões feitas na sua conta serão retornadas. |
| GetSubmissionStatus | Consulta o estado de uma submissão. Se não houver nenhuma submissão com o identificador passado então não é feito nada. | |
| SendVoiceSmsSubmission | Envia uma submissão de mensagem de voz. |
Serviço VoiceSMS
GetSubmissionDetails
Consulta o estado de uma submissão. Se não houver nenhuma submissão com o identificador passado então não é feito nada. Se o utilizador usado na autenticação for Administrador apenas as submissões feitas na sua conta serão retornadas.Parâmetros do pedido
- id : long (mandatório)
- Identificador da submissão (MessageAggregatorId).
- getRecipientsStatus : boolean (mandatório)
- Indica se deve consultar os destinatários e respectivo estado. A consulta dos destinatários causa carga no Global Channel e deve ser utilizada com cautela.
Parâmetros de resposta
- SubmissionDetails : SubmissionDetails (mandatório)
Obter os detalhes de um envio
O exemplo seguinte mostra como obter o estado de entrega de um VoiceSMS previamente enviado.
E a correspondente resposta, de sucesso:
GetSubmissionStatus
Consulta o estado de uma submissão. Se não houver nenhuma submissão com o identificador passado então não é feito nada.Parâmetros do pedido
- id : long (mandatório)
- Identificador da submissão (MessageAggregatorId).
Parâmetros de resposta
- SubmissionStatus : SubmissionStatus2 (opcional)
Obter o estado de um envio
O exemplo seguinte mostra como obter o estado de entrega de um VoiceSMS previamente enviado.
E a correspondente resposta, de sucesso:
SendVoiceSmsSubmission
Envia uma submissão de mensagem de voz.Parâmetros do pedido
- submission : VoiceSmsSubmission (opcional)
Parâmetros de resposta
- SubmissionStatus : SubmissionStatus (opcional)
Envio de um VoiceSMS
O seguinte exemplo mostra como enviar um VoiceSMS. Deve substituir o texto TODO-REPLACE por valores válidos.
E a correspondente resposta, de sucesso:
VoiceSMS Entidades
ArrayOfString
| Nome do atributo | Descrição |
|---|---|
| Lista de string : string (opcional) |
RecipientsStatus
| Nome do atributo | Descrição |
|---|---|
| canceled : ArrayOfString (opcional) | Lista dos destinatários para mensagem cancelada. |
| delivered : ArrayOfString (opcional) | Lista dos destinatários para mensagem entregue ao destinatário. |
| failed : ArrayOfString (opcional) | Lista dos destinatários para mensagem não enviada devido a erro. |
| sent : ArrayOfString (opcional) | Lista dos destinatários para mensagem entregue ao SMSC. |
| waiting : ArrayOfString (opcional) | Lista dos destinatários para mensagem à espera de ser enviada. |
Submission
| Nome do atributo | Descrição |
|---|---|
| ContactLists : ArrayOfString (opcional) | Não deve utilizar este atributo. |
| Lista de Recipients : string (opcional) | Lista de destinatários individuais É necessário informar este campo ou então o campo ContactLists. |
| DeliveryDate : dateTime | 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. |
| Notification : boolean | Envio com notificação ou não. Por omissão é assumido o valor “false”, ou seja, sem notificação. |
| Sender : string | Este atributo deverá ter um valor vazio (uma string vazia). |
| Validity : int | Validade da mensagem (em horas). |
SubmissionDetails
| Nome do atributo | Descrição |
|---|---|
| CanceledMessages : int | Mensagens canceladas. |
| FailedMessages : int | Mensagens falhadas. |
| MessageType : int | Tipo da mensagem, valores possíveis: 2 – SMS 3 - SMS_PULL 4 – MMS 7 – EMAIL 8 - WAP_PUSH |
| NotifWaitMessages : int | Mensagens à espera de notificação. |
| ProcessStatus : int | Sub-estado da submissão, valores possíveis: 0 – OK 1 – TOCONFIRM 2 - CANCEL_STARTED 3 – CANCELED 4 - TOCONFIRM_EXPIRED 5 - CONFIRMED |
| SentMessages : int | Mensagens enviadas. |
| Status : int | Estado da submissão, valores possíveis: 0 - NOT_STARTED 1 – STARTED 2 - FINISHED |
| TotalMessages : int | Total de mensagens a enviar. |
| WaitMessages : int | Mensagens em espera. |
| creationDate : dateTime | Data de criação. Formato: yyyy-mm-ddTHH:MM:ss |
| endDate : dateTime | Data de fim de envio da submissão. Formato: yyyy-mm-ddTHH:MM:ss |
| link : string (opcional) | Link da mensagem se tratar-se de uma submissão do tipo Wap Push. |
| message : string (opcional) | Texto da mensagem. |
| notificationRequested : boolean | Indica se foi pedida notificação de entrega. |
| originator : string (opcional) | Originador da mensagem. |
| recipientsStatus : RecipientsStatus (opcional) | Estado dos destinatários da submissão caso o parâmetro getRecipientsStatus tenha sido passado a true Este objecto tem 5 listas, uma para cada estado: canceled, delivered, failed, sent, waiting. |
| sender : string (opcional) | Nome do utilizador Global Channel que criou a submissão. |
| startDate : dateTime | Data de início de envio da submissão. Formato: yyyy-mm-ddTHH:MM:ss |
| submissionId : long | Identificador da submissão (MessageAggregatorId). |
SubmissionStatus
| Nome do atributo | Descrição |
|---|---|
| Id : long | Identificador da submissão criada (MessageAggregatorId). |
| Message : string (opcional) | Texto informativo do resultado da submissão. |
| Status : int | Estado da submissão no Global Channel. |
SubmissionStatus2
| Nome do atributo | Descrição |
|---|---|
| CanceledMessages : int | Mensagens canceladas. |
| FailedMessages : int | Mensagens falhadas. |
| MessageType : int | Tipo da mensagem, valores possíveis: 2 – SMS 3 - SMS_PULL 4 – MMS 7 – EMAIL 8 - WAP_PUSH |
| NotifWaitMessages : int | Mensagens à espera de notificação. |
| ProcessStatus : int | Sub-estado da submissão, valores possíveis: 0 – OK 1 – TOCONFIRM 2 - CANCEL_STARTED 3 – CANCELED 4 - TOCONFIRM_EXPIRED 5 - CONFIRMED |
| SentMessages : int | Mensagens enviadas. |
| Status : int | Estado da submissão, valores possíveis: 0 - NOT_STARTED 1 – STARTED 2 - FINISHED |
| TotalMessages : int | Total de mensagens a enviar. |
| WaitMessages : int | Mensagens à espera de notificação. |
| SubmissionId : long | Identificador da submissão (MessageAggregatorId). |
| EndDate : dateTime | Data de fim de envio da submissão. Formato: yyyy-mm-ddTHH:MM:ss |
| StartDate : dateTime | Data de início de envio da submissão. Formato: yyyy-mm-ddTHH:MM:ss |
VoiceSmsSubmission
| Nome do atributo | Descrição |
|---|---|
| Herda de Submission | |
| FileBytes : base64Binary (opcional) | Conteúdo do ficheiro em bytes. |