Pacote de Prompts de voz Global Channel

Pacote de Prompts de voz Global Channel

Envio de voz mensagens pré-gravadas

Comprar produto

Descrição Técnica

Serviço VoiceSMS

Permite envia um ficheiro wav para váris destinatários.

Manual de Referência da API

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:

Voltar ao topo

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:

Voltar ao topo

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:

Voltar ao topo

VoiceSMS Entidades

ArrayOfString

Nome do atributo Descrição
Lista de string : string (opcional)
Voltar ao topo

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.
Voltar ao topo

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).
Voltar ao topo

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).
Voltar ao topo

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.
Voltar ao topo

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
Voltar ao topo

VoiceSmsSubmission

Nome do atributo Descrição
Herda de Submission
FileBytes : base64Binary (opcional) Conteúdo do ficheiro em bytes.
Voltar ao topo

Autenticação da API SOAP

Autenticação de um pedido SOAP

Cada pedido deverá conter informação de autenticação para estabelecer a identidade de quem fez o pedido e o token de autorização chamado ESB AccessKey (chave de acesso).

ESB Access Key

Inserir caminho para obter a chave de acesso.

A autorização do uso da API é efectuada através da chave de acesso (ESBAccessKey) que é disponibilizada no final do processo de compra do produto.

Na sua área de cliente encontrará nos detalhes do produto a geração de chaves de acesso que podem ser geradas para si, para outros utilizadores da API registados no SAPO Services ou então por qualquer utilizador.

O elemento "ESBAccessKey" deverá aparecer num SOAP Header da mensagem após o SOAP Header "ESBCredentials".

Exemplo:

ESBCredentials

ESBCredentials é um tipo complexo que é usado para passar as credenciais de modo a autenticar o pedido SOAP.

Elemento Descrição
ESBUsername O email da conta usada para para acederà API.
ESBPassword A palavra-passe que corresponde à conta de email especificada em ESBUsername.
ESBToken O token de acesso que representa as credenciais (ESBUsername + ESBPassword) usadas para comprar o uso da API.

Pedido com ESBUsername e ESBPassword

Pedido com ESBToken

Usar um ESBToken ao invés do ESBUsername e ESBPassword pode ser útil se não pretende dar as suas credenciais a quem está a usar a API.

Para gerar um ESBToken deverá usar o serviço SAPO STS (Security Token Service). O ESB Token é válido por 12 horas.

Obter um ESB Token:

Resposta:

Token: id42ho234iwh234odihwdw786576413a3836467b94f8c2991f(...)wdwqdqwd

Voltar ao topo