{"_id":"5913238ac188f10f00503365","category":{"_id":"590829c7ade4172d006a87b8","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T06:40:07.955Z","from_sync":false,"order":1,"slug":"administration-apis","title":"Administration APIs"},"githubsync":"","user":"58cadf93d223510f005d27db","__v":0,"parentDoc":null,"project":"558d9c32beb7c719007f6319","version":{"_id":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","__v":19,"createdAt":"2015-06-26T18:38:43.154Z","releaseDate":"2015-06-26T18:38:43.153Z","categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-05-10T14:28:26.063Z","link_external":false,"link_url":"","sync_unique":"","hidden":true,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":17,"body":"[block:api-header]\n{\n  \"title\": \"Use the FindMe Create API to create a FindMe\"\n}\n[/block]\nUse the FindMe Create API to create a FindMe within a DialogTech's account.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for FindMe Create\",\n  \"body\": \"https://secure.dialogtech.com/ibp_api.php\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Parameter List\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Required\",\n    \"h-2\": \"Accepts\",\n    \"h-3\": \"Max Length\",\n    \"h-4\": \"Notes\",\n    \"h-5\": \"Usage\",\n    \"0-0\": \"action\",\n    \"0-1\": \"Yes\",\n    \"0-2\": \"String: **findme.create**\",\n    \"0-3\": \"n/a\",\n    \"0-4\": \"Only accepts **findme.create** to create a FindMe\",\n    \"0-5\": \"Defines the API Call as \\\"FindMe Create\\\" type\",\n    \"1-0\": \"access_key\",\n    \"1-1\": \"Yes\",\n    \"1-2\": \"String\",\n    \"1-3\": \"n/a\",\n    \"2-0\": \"secret_access_key\",\n    \"2-1\": \"Yes\",\n    \"2-2\": \"String\",\n    \"2-3\": \"n/a\",\n    \"1-4\": \"Access Key from the Key Manager within a DialogTech account\",\n    \"1-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-4\": \"Secret Access Key from the Key Manager within a DialogTech account\",\n    \"3-0\": \"name\",\n    \"4-0\": \"list_type\",\n    \"3-1\": \"Yes\",\n    \"3-2\": \"String\",\n    \"4-2\": \"**1** or **2**\",\n    \"4-1\": \"No\",\n    \"3-3\": \"n/a\",\n    \"4-3\": \"6\",\n    \"3-4\": \"Names the FindMe\",\n    \"4-4\": \"**1** - Individual FindMe *(Default)*\\n**2** - Customer Service Hunt Group\",\n    \"3-5\": \"Defines the name of the FindMe\",\n    \"4-5\": \"Modifies the **FindMe default audio prompts** to use verbiage similar to calling a single individual *(Individual FindMe)*, or any individual in a group *(Customer Service Hunt Group)*\",\n    \"5-0\": \"loop_count\",\n    \"5-1\": \"No\",\n    \"5-2\": \"String\",\n    \"5-3\": \"1\",\n    \"5-4\": \"Accepts values **0 to 5** (default is 1)\",\n    \"5-5\": \"Determines the total number of times the predefined list of numbers would be attempted in its entirety before moving to the *no answer action*\",\n    \"6-0\": \"distribution_type\",\n    \"6-1\": \"No\",\n    \"6-2\": \"**1** or **2**\",\n    \"6-3\": \"1\",\n    \"6-4\": \"**value not present on URL** - Attempt the list sequentially on each call (default)\\n**1** - Randomized order \\n**2** - Round robin order\",\n    \"6-5\": \"Determines if the predefined list of numbers should be attempted in round-robin order or randomly.\",\n    \"7-0\": \"record\",\n    \"7-1\": \"No\",\n    \"7-2\": \"**1** or **2**\",\n    \"7-3\": \"1\",\n    \"7-4\": \"**0** - Do not record the call (default)\\n**1** - Record the call\",\n    \"7-5\": \"Determines if the call will be recorded or not.\",\n    \"8-0\": \"screen_method\",\n    \"8-1\": \"No\",\n    \"8-2\": \"**0** or **1** or **2**\",\n    \"8-3\": \"1\",\n    \"8-4\": \"**0** - Record the caller's name (default)\\n**1** - Whisper the `whisper_phrase` value using text-to-speech\\n**2** - Whisper the audio file provided via `whisper_audio` *(note: The audio file must be an existing audio file within the account)*\",\n    \"8-5\": \"Determines how the caller will be screened prior to being connected\",\n    \"9-0\": \"screen_prompt\",\n    \"9-1\": \"No\",\n    \"9-2\": \"String\",\n    \"9-3\": \"n/a\",\n    \"9-4\": \"Default is a standardized pre-recorded prompt provided by DialogTech\",\n    \"9-5\": \"Determines the screen message played when `screen_method=0`\",\n    \"10-0\": \"dtmf_only\",\n    \"10-1\": \"No\",\n    \"10-2\": \"**0** or **1**\",\n    \"10-3\": \"1\",\n    \"10-4\": \"**0** - Accept voice input as well as keypress input on call-acceptance prompts\\n**1** - Only accept keypress input on call-acceptance prompts\",\n    \"10-5\": \"Determines how the user receiving the call can accept the call, **0** allows the user to say *Yes* or press 1 to accept a call. **1** requires the user to press 1 to accept the call.\",\n    \"11-0\": \"holdmusic\",\n    \"12-0\": \"holdrepeat\",\n    \"13-0\": \"timeout\",\n    \"11-1\": \"No\",\n    \"11-2\": \"String\",\n    \"11-3\": \"n/a\",\n    \"11-5\": \"Audio file to play to caller as caller waits for destination to answer. .\",\n    \"11-4\": \"Default is a standardized pre-recorded prompt provided by DialogTech *(note: The audio file must be an existing audio file within the FindMe directory in the account)*\",\n    \"12-5\": \"Determines how often the hold message is played to the caller\",\n    \"12-4\": \"**0** - Play once per FindMe session\\n**1** - Play once between attempts\\n**2** - Play continuously between attempts\",\n    \"12-3\": \"1\",\n    \"12-2\": \"**0** or **1** or **2**\",\n    \"12-1\": \"No\",\n    \"13-1\": \"No\",\n    \"13-2\": \"**10-60**\",\n    \"13-3\": \"2\",\n    \"13-4\": \"Default is 30\",\n    \"13-5\": \"Number of seconds to ring each destination before determining that attempt is not answered, and moving to the next number or action\",\n    \"14-0\": \"whisper_phrase\",\n    \"14-1\": \"No\",\n    \"14-2\": \"String\",\n    \"14-3\": \"n/a\",\n    \"14-5\": \"Phrase spoken to person who answers phone\",\n    \"14-4\": \"To be used with `screen_method` *(default is no phrase)*\",\n    \"16-0\": \"findme_action\",\n    \"16-1\": \"No\",\n    \"16-2\": \"String\",\n    \"16-3\": \"n/a\",\n    \"16-4\": \"`See FindMe Action Table Below`\",\n    \"16-5\": \"Determines which application a call is sent to after it is determined that no numbers in the FindMe list have accepted the call.\",\n    \"17-0\": \"findme_action_parameter\",\n    \"17-1\": \"No\",\n    \"17-2\": \"String\",\n    \"17-3\": \"n/a\",\n    \"17-4\": \"`See FindMe Action Table Below`\",\n    \"17-5\": \"Building Block ID associated with the `findme_action`\",\n    \"18-0\": \"advanced_audio_id\",\n    \"18-1\": \"No\",\n    \"18-2\": \"String\",\n    \"18-3\": \"n/a\",\n    \"18-4\": \"Please call our Customer Support Team to help retrieve the appropriate value if you would like to use a custom audio-prompt set.\",\n    \"18-5\": \"If there is already a configured *Advanced Audio Prompt Set* in another FindMe you can use that set ID here to use the same audio-prompt set\",\n    \"19-0\": \"numbers\",\n    \"19-1\": \"No\",\n    \"19-2\": \"String\",\n    \"19-3\": \"n/a\",\n    \"19-5\": \"Phone numbers to add to the Find Me. Can either be a single number or a comma-separated list of numbers.\",\n    \"19-4\": \"csv list of unformatted numbers *(ex: 5556667777,5553331234)\",\n    \"20-0\": \"auto_accept\",\n    \"20-1\": \"No\",\n    \"20-2\": \"String\",\n    \"20-3\": \"n/a\",\n    \"20-4\": \"**0** - Agent will be prompted to accept the call *(note: can be used with `dtmf_only` to require a keypress to accept the call)*\\n**1** - The first number that answers, receives the call without any option to accept/deny the call\\n**2** - The last number attempted will be sent the call. Call screening will be disabled if transferred in this way.\\n**3** - The last number attempted will be sent the call. Call screening will remain enabled if transferred in this way.\",\n    \"20-5\": \"Determines how the recipient of the call will be prompted (or not) to accept the call\",\n    \"21-0\": \"simul\",\n    \"21-1\": \"No\",\n    \"21-2\": \"String\",\n    \"21-3\": \"n/a\",\n    \"21-4\": \"*The maximum value will be determined by the account type, and the number of available **Simultaneous FindMe Ports** are available with the account*\",\n    \"21-5\": \"Determines the number of simultaneous calls to make to the various numbers in the FindMe list.\",\n    \"15-0\": \"whisper_audio\",\n    \"15-1\": \"No\",\n    \"15-2\": \"String\",\n    \"15-3\": \"n/a\",\n    \"15-4\": \"To be used with `screen_method`\",\n    \"15-5\": \"The name of an audio file in your Whisper Phrase Audio files folder\"\n  },\n  \"cols\": 6,\n  \"rows\": 22\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Using this API\"\n}\n[/block]\nThese code examples are meant to show a basic method of accessing DialogTech's FindMe Create API.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\",\n      \"language\": \"text\",\n      \"name\": \"PHP Example\"\n    },\n    {\n      \"code\": \"curl -X \\\"\\\"\",\n      \"language\": \"text\",\n      \"name\": \"cURL\"\n    }\n  ]\n}\n[/block]\n**Example Response**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n\\t<result>success</result>\\n\\t<result_description></result_description>\\n\\t<findme_id>12345</findme_id>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"API used to create a FindMe","slug":"findme-create","type":"basic","title":"FindMe Create"}