{"_id":"5a1fe81f3172fa001ce232aa","project":"54eb50e5615ffc1900305a16","version":{"_id":"54eb63b859b1172100334fae","project":"54eb50e5615ffc1900305a16","forked_from":"54eb63a1867e1917009b711d","__v":28,"createdAt":"2015-02-23T17:30:32.501Z","releaseDate":"2015-02-23T17:30:32.501Z","categories":["54eb63b959b1172100334faf","54eb63b959b1172100334fb0","54eb63b959b1172100334fb1","54eb63b959b1172100334fb2","54ed8dd4ab373e2300f50eae","54ed99b2ab373e2300f50ede","55153a6de68daa2f00cff838","551546edbc466623002afe72","5515472ac28d6125001b8884","55154749c28d6125001b8885","555d9b4106dfec0d00d38ea7","5613e06e433e5735007c7708","5624bbb785a31117001c5403","56669e857cc81e0d00253f8e","568b8d837a42220d00498311","56a632277ef6620d00e2f18a","56d8147c3eb4dd0b00201aac","57a9ce2fac6db30e000d7efd","57a9cf4e944ea60e00dc3f74","58172386715dce0f00da4aa0","582dc59ee1b8692300c0dd03","589b19b4fec2730f0082e040","58b04a023529383900a759b5","58b92d1598157a0f004869bf","592e7685c58275000f20174f","59392839e376d4002f8a0474","59393064e376d4002f8a05a1","5947ae0d4005e2000f3a4fec","594a74df1d1de5001ab3517a","5954bc387a147f001b918915","59b8eeeb707542001076d3b6"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1"},"category":{"_id":"59b8eeeb707542001076d3b6","project":"54eb50e5615ffc1900305a16","version":"54eb63b859b1172100334fae","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-09-13T08:40:11.892Z","from_sync":false,"order":14,"slug":"voice-ivr","title":"Voice IVR"},"user":"583ee4a14828d50f00126d0f","__v":1,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-11-30T11:14:39.605Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"name":"","code":"POST /voice/ivr/1/messages HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\nContent-Type: application/json\nAccept: application/json\n\n{\n   \"bulkId\": \"BULK-ID-123-xyz\",\n   \"messages\": [\n      {\n         \"scenarioId\": \"6298AA7707903A4ED680B436929681AD\",\n         \"from\": \"41793026700\",\n         \"destinations\": [\n            {\n               \"to\": \"41793026727\"\n            },\n            {\n               \"to\": \"41793026731\"\n            }\n         ],\n         \"parameters\": {\n           \"foo\": \"bar\"\n         },\n         \"notifyUrl\": \"http://www.example.com/voice/advanced\",\n         \"notifyContentType\": \"application/json\",\n         \"callbackData\":\"DLR callback data\",\n         \"validityPeriod\": 720,\n         \"sendAt\": \"2016-07-07T17:00:00.000+01:00\",\n         \"record\": false,\n         \"retry\": {\n            \"minPeriod\":1,\n            \"maxPeriod\": 5,\n            \"maxCount\":5\n         },\n         \"sendingSpeed\": {\n         \t\t\"speed\": 10,\n            \"timeUnit\": \"hour\"\n         }\n      }\n   ]\n}","language":"json"}]},"settings":"554860d6d2c8410d006c215e","results":{"codes":[{"name":"OK - JSON","code":"{\n  \"bulkId\": \"BULK-ID-123-xyz\",\n  \"messages\": [\n    {\n      \"to\": \"385993061678\",\n      \"status\": {\n        \"groupId\": 1,\n        \"groupName\": \"PENDING\",\n        \"id\": 26,\n        \"name\": \"PENDING_ACCEPTED\",\n        \"description\": \"Message accepted, pending for delivery.\"\n      },\n      \"messageId\": \"fda25a85-22fe-43e4-ad70-acb01bbd919b\"\n    }\n  ]\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"59c360e9c99a7d0010b48640","ref":"","in":"body","required":false,"desc":"The ID which uniquely identifies the request.","default":"","type":"string","name":"bulkId"},{"_id":"566abc7b74d574170070b711","ref":"","in":"body","required":false,"desc":"Numeric sender ID in E.164 format","default":"","type":"string","name":"from"},{"_id":"566abc7b74d574170070b710","ref":"","in":"body","required":true,"desc":"Array of message destination addresses. Destination address must be in the international format (Example: 41793026727).","default":"","type":"array_string","name":"to"},{"_id":"566abc7b74d574170070b70f","ref":"","in":"body","required":true,"desc":"Scenario key","default":"","type":"string","name":"scenarioId"},{"_id":"5a1fe81f3172fa001ce232ab","ref":"","in":"body","required":false,"desc":"The parameters that should be passed to the scenario on execution.","default":"","type":"object","name":"parameters"},{"_id":"57c9fd0b35d18d0e00242a0a","ref":"","in":"body","required":false,"desc":"The URL on your callback server on which the [Delivery report](http://dev.infobip.com/v1/docs/delivery-reports) will be sent.","default":"","type":"string","name":"notifyUrl"},{"_id":"57c9fd0b35d18d0e00242a09","ref":"","in":"body","required":false,"desc":"Preferred Delivery report content type. Can be `application/json` or `application/xml`.","default":"","type":"string","name":"notifyContentType"},{"_id":"566abc7b74d574170070b702","ref":"","in":"body","required":false,"desc":"The message validity period shown in minutes. When the period expires, it will not be allowed for the message to be sent. A validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).","default":"","type":"int","name":"validityPeriod"},{"_id":"566abc7b74d574170070b704","ref":"","in":"body","required":false,"desc":"Used for scheduled IVR flow (IVR will not to be sent immediately, but at scheduled time).","default":"","type":"datetime","name":"sendAt"},{"_id":"58cfb4266868a21900dab908","ref":"","in":"body","required":false,"desc":"Additional client's data that will be sent on the notifyUrl. The maximum value is 200 characters.","default":"","type":"string","name":"callbackData"},{"_id":"59943dbc32aa4a00259931e2","ref":"","in":"body","required":false,"desc":"Used to define if the delivery of the IVR should be retried in case the first try doesn't succeed. Additional retries will be made according to the schedule defined by minPeriod and maxPeriod parameters and platform's internal retry logic. If the minPeriod differs maxPeriod, delivery will be retried in the following manner: after 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours or until maxPeriod is reached.  If the retry attempt for the MaxPeriod is reached, the MaxPeriod will be used for all subsequent retries. If the minPeriod and the maxPeriod are defined as equal values, the period of time between retries will be equal to this value. IVR delivery will be retried until the successful delivery or validity or maxCount value is reached.","default":"","type":"object","name":"retry"},{"_id":"59943dbc32aa4a00259931e1","ref":"","in":"body","required":false,"desc":"Defines the minimal waiting time (in minutes) after the previous failed attempt to try to deliver the flow again.","default":"","type":"int","name":"minPeriod"},{"_id":"59943dbc32aa4a00259931e0","ref":"","in":"body","required":false,"desc":"Defines the maximum waiting time (in minutes) after the previous failed attempt to try to deliver the flow again.","default":"","type":"int","name":"maxPeriod"},{"_id":"59943dbc32aa4a00259931df","ref":"","in":"body","required":false,"desc":"Specify the maximum number of retry attempts. Maximum value of the maxCount is 4. Higher value, if entered will be set to 4.","default":"","type":"int","name":"maxCount"},{"_id":"5a0438d21534c4001a99d629","ref":"","in":"body","required":false,"desc":"Sending rate defined in number of messages sent per second, minute, hour or day. First message will be sent immediately (or at sendAt if scheduling is used) and subsequent messages will be sent respecting defined speed. For example, if sending speed is defined as 10 messages per hour, messages will be sent every 6 minutes. If this parameter is defined, validity period is ignored.","default":"","type":"object","name":"sendingSpeed"},{"_id":"5a0438d21534c4001a99d628","ref":"","in":"body","required":false,"desc":"Defines the number of messages that will be sent per specified time unit.","default":"","type":"int","name":"speed"},{"_id":"5a0438d21534c4001a99d627","ref":"","in":"body","required":false,"desc":"Defines time unit used for calculating sending speed.  Possible values: second, minute, hour and day.","default":"","type":"string","name":"timeUnit"}],"url":"/voice/ivr/1/messages"},"isReference":false,"order":4,"body":"Response format \n\nIf successful, the response header HTTP status code will be `200 OK` and the IVR flow will be sent.\n\nIf you try to send the request without authorization, you will receive a `401 Unauthorized` error.\n\n## Voice Response\n\n|Parameter|Type|Description|\n|-|-|-|\n|*bulkId*|String|The ID that uniquely identifies the request. Bulk ID will be received when a message is sent to more than one destination address.|\n|*messages*|[VoiceResponseDetails](#section-voiceresponsedetails)|Array of sent message objects, one object per message.|\n\n### Voice Response Details\n\n|Parameter|Type|Description|\n|-|-|-|\n|*to*|String|The message destination address.|\n|*status*|[Status](#section-status)|Indicates whether the message has been sent successfully, not sent, delivered, not delivered, waiting for delivery, or other status.|\n|*messageId*|String|The ID that uniquely identifies the sent message.|\n\n#### Status\n\n|Parameter|Type|Description|\n|-|-|-|\n|*groupId*|int|Status [group ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*groupName*|String|Status [group name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*id*|int|Status [ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*name*|String|Status [name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).|\n|*description*|String|Human readable [description](http://dev.infobip.com/v1/docs/response-codes#status-object-example) of the status.|","excerpt":"This method allows you to start an outbound IVR toward a multiple destinations.","slug":"launch-outbound-ivr","type":"endpoint","title":"Launch outbound IVR"}

postLaunch outbound IVR

This method allows you to start an outbound IVR toward a multiple destinations.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

bulkId:
string
The ID which uniquely identifies the request.
from:
string
Numeric sender ID in E.164 format
to:
required
array of strings
Array of message destination addresses. Destination address must be in the international format (Example: 41793026727).
scenarioId:
required
string
Scenario key
parameters:
object
The parameters that should be passed to the scenario on execution.
notifyUrl:
string
The URL on your callback server on which the [Delivery report](http://dev.infobip.com/v1/docs/delivery-reports) will be sent.
notifyContentType:
string
Preferred Delivery report content type. Can be `application/json` or `application/xml`.
validityPeriod:
integer
The message validity period shown in minutes. When the period expires, it will not be allowed for the message to be sent. A validity period longer than 48h is not supported (in this case, it will be automatically set to 48h).
sendAt:
datetime
Used for scheduled IVR flow (IVR will not to be sent immediately, but at scheduled time).
callbackData:
string
Additional client's data that will be sent on the notifyUrl. The maximum value is 200 characters.
retry:
object
Used to define if the delivery of the IVR should be retried in case the first try doesn't succeed. Additional retries will be made according to the schedule defined by minPeriod and maxPeriod parameters and platform's internal retry logic. If the minPeriod differs maxPeriod, delivery will be retried in the following manner: after 1 min, 2 min, 5 min, 10 min, 20 min, 30 min, 1 hour, 2 hours, 4 hours, 8 hours, 16 hours, 24 hours or until maxPeriod is reached. If the retry attempt for the MaxPeriod is reached, the MaxPeriod will be used for all subsequent retries. If the minPeriod and the maxPeriod are defined as equal values, the period of time between retries will be equal to this value. IVR delivery will be retried until the successful delivery or validity or maxCount value is reached.
minPeriod:
integer
Defines the minimal waiting time (in minutes) after the previous failed attempt to try to deliver the flow again.
maxPeriod:
integer
Defines the maximum waiting time (in minutes) after the previous failed attempt to try to deliver the flow again.
maxCount:
integer
Specify the maximum number of retry attempts. Maximum value of the maxCount is 4. Higher value, if entered will be set to 4.
sendingSpeed:
object
Sending rate defined in number of messages sent per second, minute, hour or day. First message will be sent immediately (or at sendAt if scheduling is used) and subsequent messages will be sent respecting defined speed. For example, if sending speed is defined as 10 messages per hour, messages will be sent every 6 minutes. If this parameter is defined, validity period is ignored.
speed:
integer
Defines the number of messages that will be sent per specified time unit.
timeUnit:
string
Defines time unit used for calculating sending speed. Possible values: second, minute, hour and day.

Examples


Result Format


Documentation

Response format If successful, the response header HTTP status code will be `200 OK` and the IVR flow will be sent. If you try to send the request without authorization, you will receive a `401 Unauthorized` error. ## Voice Response |Parameter|Type|Description| |-|-|-| |*bulkId*|String|The ID that uniquely identifies the request. Bulk ID will be received when a message is sent to more than one destination address.| |*messages*|[VoiceResponseDetails](#section-voiceresponsedetails)|Array of sent message objects, one object per message.| ### Voice Response Details |Parameter|Type|Description| |-|-|-| |*to*|String|The message destination address.| |*status*|[Status](#section-status)|Indicates whether the message has been sent successfully, not sent, delivered, not delivered, waiting for delivery, or other status.| |*messageId*|String|The ID that uniquely identifies the sent message.| #### Status |Parameter|Type|Description| |-|-|-| |*groupId*|int|Status [group ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*groupName*|String|Status [group name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*id*|int|Status [ID](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*name*|String|Status [name](http://dev.infobip.com/v1/docs/response-codes#status-object-example).| |*description*|String|Human readable [description](http://dev.infobip.com/v1/docs/response-codes#status-object-example) of the status.|