{"_id":"59b8efaa500d720010e11277","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":"58e64f4ad303ca1900c7e712","__v":1,"parentDoc":null,"updates":["59d28f693f52ff003cc825b5"],"next":{"pages":[],"description":""},"createdAt":"2017-09-13T08:43:22.145Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":3,"body":"Inbound IVR will allow your customers to dial your dedicated voice number (DID) and get into the IVR flow. \nYou can use an inbound IVR to set up surveys, polls, or to automate your customer support processes.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Prerequisites\",\n  \"body\": \"In order to use the Inbound IVR service you must purchase a number (DID number). Once you have your number you create a scenario, get a ScenarioID, and use it to set up an Inbound IVR action on the number.\\nOnce you complete these steps you are ready to advertise this number to your customers.\\n\\nUse our [Numbers API](/docs/phone-number) or [Customer portal](https://portal.infobip.com/settings/numbers/) to purchase **Voice enabled** phone number.\"\n}\n[/block]\nTo setup Inbound IVR use this methode:\n    [Setup Inbound IVR action ](#setup-inbound-ivr)\n\nAdditional methods:\n\n* [Get Inbound IVR action](#get-inbound-ivr-action)\n* [Delete Inbound IVR action](#delete-inbound-ivr-action) \n[block:api-header]\n{\n  \"title\": \"Setup Inbound IVR\"\n}\n[/block]\nThis method allows you to set up an Inbound IVR action for a DID number. \n\n```\nPOST https://api.infobip.com/\n```\nRequest parameters\n\n\n|Property name|Type|Description|\n|-|-|-|\n|scenarioID|string|type of number setup (`VOICE_IVR`)|\n\n###Request example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /numbers/1/numbers/6FED0BC540BFADD9B05ED7D89AAC22FA/action HTTP/1.1\\nHost: api.infobip.com\\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\\nContent-Type: application/json\\nAccept: application/json\\n\\n{\\n \\\"type\\\" : \\\"VOICE_IVR\\\",\\n \\\"scenarioId\\\" : \\\"scenarioId\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nResponse\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"actionKey\\\": \\\"6FED0BC540BFADD9BD89AAC22FA\\\",\\n  \\\"type\\\": \\\"VOICE_IVR\\\",\\n  \\\"scenarioId\\\": \\\"scenarioId\\\"\\n }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nA successful response is represented by an HTTP status code `200 OK`.\n[block:api-header]\n{\n  \"title\": \"Get action\"\n}\n[/block]\nThe method will return the action that was set up on a specific number (`numberKey`).\n\n```\nGET https://api.infobip.com/numbers/1/numbers/{numberKey}/actions\n``` \n\n###Request example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"GET /numbers/1/numbers/6FED0BC540BFADD9B05ED7D89AAC22FA/actions HTTP/1.1\\nHost: api.infobip.com\\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\\nAccept: application/json\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n###Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"actions\\\": [\\n    {\\n      \\\"actionKey\\\": \\\"6FED0BC540BFADD9BD89AAC22FA\\\",\\n      \\\"type\\\": \\\"VOICE_IVR\\\"\\n     }\\n  ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Delete an Inbound IVR action\"\n}\n[/block]\nThis method will delete an Inbound IVR action (`actionKey`) on a number (`numberKey`).\n\n```\nDELETE https://api.infobip.com/numbers/1/numbers/{numberKey}/actions/{actionKey}\n``` \n\n###Request example\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"DELETE /numbers/1/numbers/6FED0BC540BFADD9B05ED7D89AAC22FA/actions/6FED0BC540BFADD9BD89AAC22FA HTTP/1.1\\nHost: api.infobip.com\\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\\nAccept: application/json\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\nA successful response is presented by an HTTP status code `204 No Content`. There is no response body.","excerpt":"Let us show you how to set up an Inbound IVR.","slug":"inbound-ivr-setup","type":"basic","title":"Inbound IVR setup"}

Inbound IVR setup

Let us show you how to set up an Inbound IVR.

Inbound IVR will allow your customers to dial your dedicated voice number (DID) and get into the IVR flow. You can use an inbound IVR to set up surveys, polls, or to automate your customer support processes. [block:callout] { "type": "info", "title": "Prerequisites", "body": "In order to use the Inbound IVR service you must purchase a number (DID number). Once you have your number you create a scenario, get a ScenarioID, and use it to set up an Inbound IVR action on the number.\nOnce you complete these steps you are ready to advertise this number to your customers.\n\nUse our [Numbers API](/docs/phone-number) or [Customer portal](https://portal.infobip.com/settings/numbers/) to purchase **Voice enabled** phone number." } [/block] To setup Inbound IVR use this methode: [Setup Inbound IVR action ](#setup-inbound-ivr) Additional methods: * [Get Inbound IVR action](#get-inbound-ivr-action) * [Delete Inbound IVR action](#delete-inbound-ivr-action) [block:api-header] { "title": "Setup Inbound IVR" } [/block] This method allows you to set up an Inbound IVR action for a DID number. ``` POST https://api.infobip.com/ ``` Request parameters |Property name|Type|Description| |-|-|-| |scenarioID|string|type of number setup (`VOICE_IVR`)| ###Request example [block:code] { "codes": [ { "code": "POST /numbers/1/numbers/6FED0BC540BFADD9B05ED7D89AAC22FA/action HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\nContent-Type: application/json\nAccept: application/json\n\n{\n \"type\" : \"VOICE_IVR\",\n \"scenarioId\" : \"scenarioId\"\n}", "language": "json" } ] } [/block] Response [block:code] { "codes": [ { "code": "{\n \"actionKey\": \"6FED0BC540BFADD9BD89AAC22FA\",\n \"type\": \"VOICE_IVR\",\n \"scenarioId\": \"scenarioId\"\n }", "language": "json" } ] } [/block] A successful response is represented by an HTTP status code `200 OK`. [block:api-header] { "title": "Get action" } [/block] The method will return the action that was set up on a specific number (`numberKey`). ``` GET https://api.infobip.com/numbers/1/numbers/{numberKey}/actions ``` ###Request example [block:code] { "codes": [ { "code": "GET /numbers/1/numbers/6FED0BC540BFADD9B05ED7D89AAC22FA/actions HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\nAccept: application/json", "language": "json" } ] } [/block] ###Response [block:code] { "codes": [ { "code": "{\n \"actions\": [\n {\n \"actionKey\": \"6FED0BC540BFADD9BD89AAC22FA\",\n \"type\": \"VOICE_IVR\"\n }\n ]\n}", "language": "json" } ] } [/block] [block:api-header] { "title": "Delete an Inbound IVR action" } [/block] This method will delete an Inbound IVR action (`actionKey`) on a number (`numberKey`). ``` DELETE https://api.infobip.com/numbers/1/numbers/{numberKey}/actions/{actionKey} ``` ###Request example [block:code] { "codes": [ { "code": "DELETE /numbers/1/numbers/6FED0BC540BFADD9B05ED7D89AAC22FA/actions/6FED0BC540BFADD9BD89AAC22FA HTTP/1.1\nHost: api.infobip.com\nAuthorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==\nAccept: application/json", "language": "json" } ] } [/block] A successful response is presented by an HTTP status code `204 No Content`. There is no response body.