RESTful API

Placing a Voice Call

Overview

Place a voice call to a mobile phone number. The voice call will be generated from the message's content via a text to speech software. This is a final interaction which means that we don't expect any replay form the recipient.

URL

Parameters on the following URL are inside braces { }

https://www.messangi.com/messangi_mmc/rest/api/tools/placeVoiceCall/{instanceId}/{provider}/{mobileNumber}/{msgContent}/{publicKey}/{signature}
Parameter Name Description
instanceId An instance id is the workspace identification number, if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
provider As we only support one provider yet, use unicel as a constant to all invocations
mobileNumber Recipient for the call
msgContent The content of the message per se. This parameter must be Base64 encoded.
publicKey The public key to access this API. if you don't know yours please request it using our ticketing tool, you will need to provide your Mobile Engagement Campaign Manager's URL and your user login
signature The unique SHA256 signature for this call, it's involve all input parameters. To learn about generating the correct signature please visit our Java Example

Response

The Response XML is divided in a static part and a dynamic one, we call it dynamic because it will vary depending on the method you invoke. Please read our Response XML Basics section if you want to learn more about the response parts.

<input>placeVoiceCall</input>
<status>OK</status>
<description>Completed</description>
<result>
	<blast>
		<blastId>-2490820026197535447</blastId>
		<status>FINISHED</status>
		<statusDescription>Finished</statusDescription>
		<clientId>As223sdadq8d8287v5z</clientId>
		<appName>Inbox</appName>
		<message>
			<blastId>-2490820026197535447</blastId>
			<id>2758ebc5-1db5-4822-a5ed-36121e0674a6</id>
			<type>VOICE</type>
			<from>Unicel</from>
			<to>13056708084</to>
			<text>This is a sample call</text>
			<status>SENT</status>
			<statusDescription>Sent</statusDescription>
			<date>2014-01-24T12:45:50.903-04:30</date>
			<timezone>America/Caracas</timezone>
		</message>
	</blast>
</result>
Result parameters

Please be aware that the <message> tag and its content is a generic object and may apply to other responses in other methods.

Parameter Name Description Possible Values
blastId The unique blast identification, a blast is always needed to send one or more messages Text
status Indicates current the blast's status For more information please review the Message's Status page
statusDescription A human readable explanation about the blast's status Text
clientId The client identification (sender) Text
appName The app name used to sent the message Text
message.blastId Unique identifier for the blast used to fire the message Text
message.id Unique identifier for the message created Text
message.type Indicates the kind of message that was sent PUSH
SMS
EMAIL
VOICE
message.from Who sent the message for PUSH, Application that sent the message
for SMS, Short/Long code which originated the message
for EMAIL, the email address which sent the message.
For voice it will be the provider used unicel in this case
message.to Recipient for this message Any of the following:
deviceId
mobile number
email address
message.text Message's content Text
message.status Indicates the message's status at the origination moment See our Message's Status page
message.statusDescription A human readable explanation about the current status Text
message.date Time mark at the origination moment A formatted date string: yyyy-MM-dd'T'HH:mm:ss.SSSZZ
For more information please review the pattern letters quick reference
message.timezone Timezone used Text