Global Channel Voice message Pack

Global Channel Voice message Pack

Sends pre-recorded voice messages

Buy product

Technical Overview

VoiceSMS Service

Allows to send a wav file do different recipients.

API Reference

Service Operation Description
VoiceSMS GetSubmissionDetails Gets submission status. If there isn't any submisson with the given identifier than nothing is done. If the autenticated user is an Administrador than he will only see the submissions made in his account.
GetSubmissionStatus Get submission status. If there isn't any submisson with the given identifier than nothing is done.
SendVoiceSmsSubmission Submits a voice message.

VoiceSMS Service

Operations

GetSubmissionDetails

Gets submission status. If there isn't any submisson with the given identifier than nothing is done. If the autenticated user is an Administrador than he will only see the submissions made in his account.
Request Parameters
id : long (required)
Submission identifier (MessageAggregatorId).
getRecipientsStatus : boolean (required)
Indicates if must consult recipients and their status.
Response Parameters
SubmissionDetails : SubmissionDetails (required)
Examples

Get a VoiceSMS details

The following example shows how to get the details of a previously sent VoiceSMS.

And the corresponding, successful, response:

Go to top

GetSubmissionStatus

Get submission status. If there isn't any submisson with the given identifier than nothing is done.
Request Parameters
id : long (required)
Submission identifier (MessageAggregatorId).
Response Parameters
SubmissionStatus : SubmissionStatus2 (optional)
Examples

Get a VoiceSMS state

The following example shows how to get the state of a previously sent VoiceSMS.

And the corresponding, successful, response:

Go to top

SendVoiceSmsSubmission

Submits a voice message.
Request Parameters
submission : VoiceSmsSubmission (optional)
Response Parameters
SubmissionStatus : SubmissionStatus (optional)
Examples

Send a VoiceSMS submission

The following example shows how to send a VoiceSMS. You should replace TODO-REPLACE with actual valid values.

And the corresponding, successful, response:

Go to top

VoiceSMS Entities

ArrayOfString

Attribute Name Description
List of string : string (optional)
Go to top

RecipientsStatus

Attribute Name Description
canceled : ArrayOfString (optional) Recipients list for canceled messages.
delivered : ArrayOfString (optional) Recipients list for delivered messages.
failed : ArrayOfString (optional) Recipients list for messages not sent due to error.
sent : ArrayOfString (optional) Recipients list for delivered messages to SMSC.
waiting : ArrayOfString (optional) Recipients list for messages waiting to be sent.
Go to top

Submission

Attribute Name Description
ContactLists : ArrayOfString (optional) You should not use this attribute.
List of Recipients : string (optional) Individual recipients list. You must enter this field or the field ContactLists.
DeliveryDate : dateTime Initial date of the sending of the submission. If a date is not indicated or the specified date preceeds the current date/time, the send will be scheduled for the current date/time.
Notification : boolean Send with notification or not. By default it is assumed the value "false", ie without notification.
Sender : string Set this attribute to an empty string.
Validity : int Message validity (in hours).
Go to top

SubmissionDetails

Attribute Name Description
CanceledMessages : int Canceled messages.
FailedMessages : int Failed messages.
MessageType : int Message type, possible values: 2 – SMS 3 - SMS_PULL 4 – MMS 7 – EMAIL 8 - WAP_PUSH
NotifWaitMessages : int Messages waiting notification.
ProcessStatus : int Submission sub-status, possible values: 0 – OK 1 – TOCONFIRM 2 - CANCEL_STARTED 3 – CANCELED 4 - TOCONFIRM_EXPIRED 5 - CONFIRMED
SentMessages : int Sent messages.
Status : int Submission status, possible values: 0 - NOT_STARTED 1 – STARTED 2 - FINISHED
TotalMessages : int Total messages to send.
WaitMessages : int Waiting messages.
creationDate : dateTime Creation date. Format: yyyy-mm-ddTHH:MM:ss
endDate : dateTime Submission sending end date. Format: yyyy-mm-ddTHH:MM:ss
link : string (optional) Message link if it's a Wap Push message type.
message : string (optional) Message text.
notificationRequested : boolean Indicates if a request for notification was made.
originator : string (optional) Message originator.
recipientsStatus : RecipientsStatus (optional) Submission recipients status if parameter getRecipientsStatus was passed as true. This object has 5 lists, one for each status: canceled, delivered, failed, sent, waiting.
sender : string (optional) Global Channel user that created the submission.
startDate : dateTime Submission send initial date. Format: yyyy-mm-ddTHH:MM:ss
submissionId : long Submission identifier (MessageAggregatorId).
Go to top

SubmissionStatus

Attribute Name Description
Id : long Submission identifier (MessageAggregatorId).
Message : string (optional) Submission result informative text.
Status : int Submission status in Global Channel.
Go to top

SubmissionStatus2

Attribute Name Description
CanceledMessages : int Canceled messages.
FailedMessages : int Failed messages.
MessageType : int Message type, possible values: 2 – SMS 3 - SMS_PULL 4 – MMS 7 – EMAIL 8 - WAP_PUSH
NotifWaitMessages : int Messages waiting notification.
ProcessStatus : int Submission sub-status, possible values: 0 – OK 1 – TOCONFIRM 2 - CANCEL_STARTED 3 – CANCELED 4 - TOCONFIRM_EXPIRED 5 - CONFIRMED
SentMessages : int Sent messages.
Status : int Submission status, possible values: 0 - NOT_STARTED 1 – STARTED 2 - FINISHED
TotalMessages : int Total messages to send.
WaitMessages : int Messages waiting notification.
SubmissionId : long Submission identifier (MessageAggregatorId).
EndDate : dateTime Submission sending end date. Format: yyyy-mm-ddTHH:MM:ss
StartDate : dateTime Submission send initial date. Format: yyyy-mm-ddTHH:MM:ss
Go to top

VoiceSmsSubmission

Attribute Name Description
Inherits from Submission
FileBytes : base64Binary (optional) File content in bytes.
Go to top

SOAP API Authentication

Authenticating SOAP Request

Every request must contain authentication information to establish the identity of whom making the request and a autorization token called ESB Access Key.

ESB Access Key

Correct with the path to the access key

The ESB Access Key is what will authorize the usage of the API and is available when the buying process ends. In the costumer area you can find the product details where you can generate an ESB Access Key for you usage, another user registered on SAPO Services or even for everyone.

The element ESBAccessKey must appear on the message SOAP Header after the complex type ESBCredentials

Example:

ESBCredentials

ESBCredentials is a complex type that is used to pass the credentials in order to authenticate a SOAP request.

Request with username and password
Elements Description
ESBUsername The e-mail of the account that is used to access the API
ESBPassword The password that in combination with the ESBUsername is used to access the corresponding account

Example:

Request with ESBToken

Using a token instead of your username and password can be useful if you don't want to give your credentials to whom is using the API.

In order to generate a ESB Token you must use SAPO Security Token Service (STS). The ESBtoken is valid for 12 hours.

Requesting with an ESBtoken
Go to top