Make Voice Call

Request Parameters

Parameter	Required	Description
channel	yes	Specify the channel as "voice"
from	yes	CLI i.e. Caller Line Identity, also referred as the Caller ID. You will need to buy a voice-enabled long-code under the Numbers section. This will be your caller-ID for the outbound call. If you don't see an option to buy numbers, contact the imiconnect Ops Team.
to	yes	Object that contains the array of mobile number(s) to call and the respective correlation ID(s)
to.msisdn	yes	The mobile number to call along with the country code.
to.correlationId	no	The CorrelationID is a unique identifier that you can attach to every request as a reference a particular transaction or event.
priority	no	Accepts numbers: 1 - low 2 - medium - 3 - high
callbackData	no	Data that you would like to send to the notify Url
notifyUrl	no	The URL at which you want imiconnect Platform to notify about the callback data and the receipts
requestedReceipts	no	Events for which the user will receive notifications. The events are: Offered: when imiconnect platform offers a call to the network to place a call Accepted: when the network accepts the call offered by imiconnect and places to end-customer Answered: when the end-customer answers the call Dropped: when the call is dropped because of an internal technical error Rejected: when the call gets rejected; it can be due to various reasons like network failure, the customer is busy, rejected by the customer, etc. Released: when the call is ended by the platform Disconnected: when the end-customer disconnects the call Trombone Connected: when the imiconnect platform sends an outbound call to the customer and the customer asks to talk to an agent. The Trombone Connect event occurs when both parties A (end-customer) and B (agent) are connected. Trombone Released: when the party B (agent) exits the call Message Expired: when the call request comes in after the configured expiry time, the request expires.
sendAt	no	The timestamp at which the message is sent in UNIX epoch or ISO8601
content	yes	A JSON object where you will need to configure the message to the user
content.type	yes	media or TTS (Text to Speech) media - use this type if you have uploaded an audio prompt in the Voice Media on imiconnect Platform TTS - use this type if you want to specify the message dynamically for TTS conversion
content.mediaId	yes	Media Id is applicable only when the type is "media". Provide the ID of the prompt that you have uploaded in the Voice Media on imiconnect Platform.
ttsProcessor	yes (Applicable only if content type is "TTS")	Currently, only Azure is supported.
language	yes (Applicable only if content type is "TTS")	Refer to [Azure documentation] (https://docs.microsoft.com/en-in/azure/cognitive-services/speech-service/#pivot=start&panel=texttospeech). Click here to see a list of all the TTS languages supported.
voice	yes (Applicable only if content type is "TTS")	Refer to [Azure documentation] (https://docs.microsoft.com/en-in/azure/cognitive-services/speech-service/#pivot=start&panel=texttospeech)
region	yes (Applicable only if content type is "TTS")	Refer to [Azure documentation] (https://docs.microsoft.com/en-in/azure/cognitive-services/speech-service/#pivot=start&panel=texttospeech)
text	yes (Applicable only if content type is "TTS")	Text to be synthesised. The character limit is 2000.
voiceType	yes (Applicable only if content type is "TTS")	The voice type: neural
gender	yes (Applicable only if content type is "TTS")	Gender of the voice that you have selected for TTS

Response Parameters

Parameter	Description
requestTimestamp	The date and time stamp in ISO8601 format at which the request is submitted
messageId	Unique transaction id of the message with which the request is made
correlationId	The same correlationId that you have provided in the request for the corresponding message is returned in the response.
status	The status of the call: Queued or Rejected
code	The response code of the sent request. See the Response Codes section for more details.
message	Description of the error message like Parameter missing or Invalid Parameter

Response Codes

Response Codes	Description
200 OK	Successful
201 Created	Created
201 Partial Content
400 Bad Request	Bad input parameter. Error description should indicate which one and why.
401 Unauthorized	Customer doesn’t exist. Customer account over quota.
404 Not Found	Resource not found
405 Method Not Allowed	The resource doesn't support the specified HTTP verb
409 Conflict	Conflict
429 Too Many Requests	Too many requests for rate limiting
500 Internal Server Error	Servers are not working as expected. The request is probably valid but needs to be requested again later.
503 Service Unavailable	Service Unavailable

content: 
 {   "type": "media",
     "mediaId":"1561"
 }

content: 
 {    "type": "TtS",
      "ttsProcessor": "Azure",
      "language": "EN-US",
      "voice": "GuyNeural",
      "region": "Canada"
      "text": "Time for lunch",
      "voiceType":"Neural",
      "gender":"male"
 }

Error Codes

Error Code	Description
7401	No Answer
7402	Customer Busy
7404	Others
7406	Call Rejected
7407	Call Offered
7408	Call Accepted
7409	Call Dropped
7410	Call Disconnected
7411	Trombone Connected
7412	Trombone Released
7208	Message Expired