{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","params":[],"results":{"codes":[]},"settings":""},"next":{"description":"","pages":[]},"title":"Click-to-FindMe List","type":"basic","slug":"click-to-findme-list","excerpt":"Used to initiate a phone call between one phone number and any one number from a dynamic list of phone numbers.","body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use the Click-to-FindMe List API to initiate a phone call with a click of a mouse.\"\n}\n[/block]\nThe Click-to-FindMe List API is used to initiate a phone call between one phone number and any one number from a dynamic list of phone numbers defined in at the time the Click-to-FindMe List API is called. The order in which the numbers are called -- either the list first, or the 3rd party first -- can be modified.\n\nIf the list of numbers/agents is static and the caller experience requires no change call-to-call, our [Click-to-FindMe](doc:click-to-findme) API would be a better option.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Base URL for Click-to-FindMe List\",\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    \"0-0\": \"access_key\",\n    \"0-1\": \"Yes* (See Notes)\",\n    \"2-0\": \"key\",\n    \"2-1\": \"Yes* (See Notes)\",\n    \"1-0\": \"secret_access_key\",\n    \"1-2\": \"String\",\n    \"3-0\": \"action\",\n    \"3-1\": \"Yes\",\n    \"8-0\": \"type\",\n    \"8-2\": \"**1** or **2**\",\n    \"10-0\": \"no_answer_email\",\n    \"10-2\": \"Email Address\",\n    \"10-1\": \"No\",\n    \"11-0\": \"no_answer_sms\",\n    \"11-2\": \"Unformatted Phone Number\",\n    \"12-0\": \"no_answer_url\",\n    \"12-2\": \"URL\",\n    \"13-0\": \"no_answer_phone\",\n    \"13-1\": \"No\",\n    \"1-1\": \"Yes* (See Notes)\",\n    \"0-2\": \"String\",\n    \"2-2\": \"String\",\n    \"3-2\": \"**clickto.findme**\",\n    \"8-1\": \"No\",\n    \"h-3\": \"Max Length\",\n    \"0-3\": \"n/a\",\n    \"11-1\": \"No\",\n    \"h-4\": \"Notes\",\n    \"h-5\": \"Usage\",\n    \"0-4\": \"If using *access_key*, *secret_access_key* is required. The parameter *key* is not required in this case.\",\n    \"0-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"1-4\": \"If using *secret_access_key*, *access_key* is required. The parameter *key* is not required in this case.\",\n    \"2-4\": \"If using *key*, both *access_key* and *secret_access_key* are not required. The parameter *key* is required in this case.\",\n    \"1-3\": \"n/a\",\n    \"2-3\": \"n/a\",\n    \"3-3\": \"n/a\",\n    \"3-4\": \"Only accepts **clickto.findme** for Click-to-FindMe\",\n    \"8-4\": \"**1** - Call `phone_to_call` first (default)\\n**2** - Call the FindMe first\",\n    \"8-3\": \"1\",\n    \"10-3\": \"n/a\",\n    \"11-3\": \"n/a\",\n    \"1-5\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-5\": \"Public API key used for limited access to the API for a particular DialogTech account\",\n    \"3-5\": \"Defines the API call as a \\\"Click-to-FindMe\\\" type\",\n    \"8-5\": \"Determines the order in which the various numbers are dialed\",\n    \"10-4\": \"Only available when `type=2`\",\n    \"10-5\": \"Define an email address to send an email to if no one on the phone list accepts the call. This email will include the phone_to_call along with the outcome of each attempt to the phone numbers on the list.\",\n    \"11-5\": \"Define a phone number to receive an SMS message if no one on the phone list accepts the call. The text will say that the call was unsuccessful along with the phone_to_call. You must have at least one phone number registered for SMS to utilize this feature.\",\n    \"12-1\": \"No\",\n    \"12-3\": \"n/a\",\n    \"12-4\": \"Only available when `type=2`\",\n    \"12-5\": \"Define a URL to post XML data to if no one on the phone list accepts the call. This data will include the phone_to_call along with the outcome of each attempt of the phone numbers on the list.\",\n    \"13-5\": \"Define a phone number to do a blind transfer of the call to if no one on the phone list accepts the call.\",\n    \"13-2\": \"Unformatted Phone Number\",\n    \"13-3\": \"n/a\",\n    \"13-4\": \"Only available when `type=2`\",\n    \"11-4\": \"Only available when `type=2`\",\n    \"4-0\": \"list\",\n    \"4-1\": \"Yes\",\n    \"4-2\": \"Pipe delimitated list  of unformatted phone numbers\",\n    \"4-3\": \"n/a\",\n    \"4-4\": \"An list of phone numbers, pipe delimitated, in which any one is a valid recipient to be connected to the `phone_to_call` number.\",\n    \"4-5\": \"Determines which list of numbers will be attempted to join any one number from that group, to the `phone_to_call` third party.\",\n    \"5-0\": \"phone_to_call\",\n    \"5-1\": \"Yes\",\n    \"5-2\": \"Unformatted Phone Number\",\n    \"5-3\": \"n/a\",\n    \"5-4\": \"Can be any unformatted phone number\",\n    \"5-5\": \"Defines the third party being joined to the pre-defined list of numbers in a Click-to-FindMe\",\n    \"6-0\": \"first_callerid\",\n    \"6-1\": \"No\",\n    \"6-2\": \"Unformatted Phone Number\",\n    \"6-3\": \"n/a\",\n    \"6-4\": \"Must be a registered number or a tracking number within the DialogTech account.\",\n    \"6-5\": \"Defines the Caller ID utilized on the first leg of the call\",\n    \"7-0\": \"second_callerid\",\n    \"7-1\": \"No\",\n    \"7-2\": \"Unformatted Phone Number\",\n    \"7-3\": \"n/a\",\n    \"7-4\": \"Must be a registered number or a tracking number within the DialogTech account.\",\n    \"7-5\": \"Defines the Caller ID utilized on the second leg of the call\",\n    \"9-0\": \"page\",\n    \"9-1\": \"No\",\n    \"9-2\": \"String\",\n    \"9-3\": \"255\",\n    \"9-4\": \"Will be stored in the *Smart Click-to-Call Report*\",\n    \"9-5\": \"Defines the \\\"page\\\" the Click-to-FindMe originated from.\"\n  },\n  \"cols\": 6,\n  \"rows\": 14\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"FindMe Experience Config Parameters\"\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\": \"dtmf_only\",\n    \"0-1\": \"No\",\n    \"0-2\": \"**1** or **2**\",\n    \"1-0\": \"screen_prompt\",\n    \"1-1\": \"No\",\n    \"2-0\": \"usr_findme_type\",\n    \"2-1\": \"No\",\n    \"3-0\": \"loop_count\",\n    \"4-0\": \"randomize\",\n    \"5-0\": \"record\",\n    \"7-0\": \"use_screen\",\n    \"3-1\": \"No\",\n    \"4-1\": \"No\",\n    \"5-1\": \"No\",\n    \"7-1\": \"No\",\n    \"9-0\": \"holdmusic\",\n    \"9-1\": \"No\",\n    \"11-0\": \"holdrepeat\",\n    \"11-1\": \"No\",\n    \"12-0\": \"timeout\",\n    \"12-1\": \"No\",\n    \"13-0\": \"whisper_phrase\",\n    \"13-1\": \"No\",\n    \"14-0\": \"nextaction\",\n    \"14-1\": \"No\",\n    \"15-0\": \"nextactionitem\",\n    \"15-1\": \"No\",\n    \"16-0\": \"ref\",\n    \"16-1\": \"No\",\n    \"1-4\": \"Only available when `type=1`\\n\\nLets you provide an announcement that will be read to the caller using text-to-speech. If you use screen_prompt to provide your own announcement, you should bear in mind that the call will play a beep and start recording, and that if the caller does not leave a name, the callee will get a \\\"Name not provided\\\" message. You can change this default behavior by using the `use_screen` parameter.\",\n    \"1-5\": \"Provide a custom text-to-speech screening prompt for use with `use_screen`\",\n    \"2-2\": \"**1** or **2**\",\n    \"1-2\": \"String\",\n    \"3-2\": \"**1** to **5**\",\n    \"3-5\": \"Number of times to go through the call list before triggering last action\",\n    \"3-4\": \"Loop count 1 is the default\",\n    \"3-3\": \"1\",\n    \"2-3\": \"1\",\n    \"0-3\": \"1\",\n    \"2-4\": \"1 - Individual FindMe (default)\\n2 - Customer service hunt group\",\n    \"2-5\": \"Determines the default audio prompts within the FindMe to sound like it's trying to reach an individual, or a member of a team\",\n    \"0-4\": \"*0* - Allow the operator to accept the call using \\\"Yes\\\" or keypad press\\n*1* - Force the operator to use their Keypad to accept the call\",\n    \"0-5\": \"Force the operator to use their Keypad to accept the call\",\n    \"4-2\": \"**0** or **1**\",\n    \"4-4\": \"0 - Do not randomize the list order (default)\\n1 - Randomize the list order\",\n    \"4-3\": \"1\",\n    \"4-5\": \"Specify if the order in which numbers are attempted from the `list` parameter is randomized.\",\n    \"5-2\": \"**0** or **1**\",\n    \"1-3\": \"**TBD**\",\n    \"5-3\": \"1\",\n    \"5-4\": \"0 - Do not record the call (default)\\n1 - Record the call\",\n    \"5-5\": \"Determine if the call should be recorded once connected\",\n    \"7-2\": \"**0** or **1**\",\n    \"7-3\": \"1\",\n    \"7-4\": \"Only available when `type=1`\\n\\n0 - Do not screen the `phone_to_call` third party for their name \\n1 - Screen the `phone_to_call` third party for their name (default)\",\n    \"7-5\": \"Determine if the `phone_to_call` third party should be prompted for their name\",\n    \"9-2\": \"String: Filename (ex **filename.wav**)\",\n    \"9-5\": \"Hold music to play for the caller while waiting for the operator to accept the call.\",\n    \"9-4\": \"Name of music file located in the *holdme* directory in Audio File Maintenance\",\n    \"9-3\": \"n/a\",\n    \"11-2\": \"**0** or **1** or **2**\",\n    \"11-3\": \"1\",\n    \"11-4\": \"0 - Repeat hold music only once per FindMe session\\n1 - Repeat hold music only once between each FindMe attempt\\n2 - Repeat hold music continuously between FindMe attempts\",\n    \"11-5\": \"Define how the hold music experience is for the caller.\",\n    \"12-2\": \"**10** through **60**\",\n    \"12-3\": \"2\",\n    \"12-4\": \"Values can be anywhere from 10-60, Default is 30.\",\n    \"12-5\": \"Define the number of seconds each number within the `list` is attempted before that number is determined to be \\\"No answer\\\" and the next number, or `nextaction` is attempted\",\n    \"13-2\": \"String\",\n    \"13-3\": \"**TBD**\",\n    \"13-4\": \"Only available when `use_screen=0`\\n\\nMessage is whispered via text-to-speech\",\n    \"13-5\": \"Message whispered to the operator\",\n    \"14-2\": \"**1** through **7**\",\n    \"14-3\": \"1\",\n    \"14-4\": \"Only available when `type=1`\\n\\n[See \\\"Next Action\\\" options below](doc:click-to-findme-list#section-next-action-options)\",\n    \"14-5\": \"Defines the application type that the call will transfer to if none of the numbers in the `list` accept the call\",\n    \"15-5\": \"Defines the specific building block that the call will transfer to if none of the numbers in the `list` accept the call\",\n    \"15-4\": \"Only available when `type=1`\\n\\n[See \\\"Next Action\\\" options below](doc:click-to-findme-list#section-next-action-options)\",\n    \"15-3\": \"n/a\",\n    \"15-2\": \"Building Block ID\",\n    \"16-2\": \"String\",\n    \"16-3\": \"255\",\n    \"16-4\": \"Will be stored in the Smart Click-to-Call Report\",\n    \"16-5\": \"An available field where a custom reference can be stored\",\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 - Whisper the third party's name to the list number\\n1 - Whisper text to the list number\\n2 - Whisper audio to the list number\",\n    \"8-5\": \"Determines the type of screening presented to the recipient of the call.\",\n    \"6-0\": \"no_intro\",\n    \"6-1\": \"No\",\n    \"6-2\": \"**0** or **1**\",\n    \"6-3\": \"1\",\n    \"6-4\": \"0 - Disable screening audio prompts\\n1 - Enable screening audio prompts (default)\",\n    \"6-5\": \"Determines if the audio prompts for screening the `phone_to_call` are enabled or not\",\n    \"10-0\": \"usr_audio_prompt_set_id\",\n    \"10-1\": \"No\",\n    \"10-2\": \"ID of an existing Custom Audio Prompt Set from a FindMe\",\n    \"10-3\": \"n/a\",\n    \"10-4\": \"Please contact [our support team](mailto:support:::at:::dialogtech.com) for assistance in utilizing this parameter\",\n    \"10-5\": \"Defines the custom audio prompts used for for the caller and agent(s) in a FindMe List\"\n  },\n  \"cols\": 6,\n  \"rows\": 17\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Next Action Options\"\n}\n[/block]\nThese values are accepted for the nextaction and nextactionitem parameters above when all the numbers in the FindMe list fail to get connected to the third party *phone_to_call*\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"nextaction Value\",\n    \"h-1\": \"nextactionitem Value\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"**1**\",\n    \"1-0\": \"**2**\",\n    \"2-0\": \"**3**\",\n    \"3-0\": \"**4**\",\n    \"4-0\": \"**5**\",\n    \"5-0\": \"**6**\",\n    \"6-0\": \"**7**\",\n    \"0-1\": \"*Not required*\",\n    \"0-2\": \"Tell user no one is available and disconnect.\",\n    \"1-1\": \"Voice Mailbox ID\",\n    \"1-2\": \"Transfer to Voice Mail\",\n    \"2-1\": \"*Not required*\",\n    \"2-2\": \"Automatically transfer the call to the last number tried in the list\",\n    \"3-1\": \"Virtual Receptionist ID\",\n    \"3-2\": \"Transfer to Virtual Receptionist\",\n    \"4-1\": \"FindMe ID\",\n    \"4-2\": \"Transfer to FindMe\",\n    \"5-1\": \"SurVo/IVR ID\",\n    \"5-2\": \"Transfer to SurVo/IVR\",\n    \"6-1\": \"*Not required*\",\n    \"6-2\": \"Automatically transfer the call to the last number tried in the list without introduction\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\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 click-to-FindMe API.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?php\\n\\t/*\\n\\t\\tClick-to-FindMe List EX1:\\n\\t\\tThis example will use access_key and secret_access_key\\n\\t\\tfor a Reverse FindMe List -- This means we'll be calling\\n\\t\\tthe dynamic list of numbers first, then the third\\n\\t\\tparty. Using access_key and secret_access_key means \\n\\t\\t'key' is not required.\\n\\t*/\\n\\n\\t// create curl resource\\n\\t$ch = curl_init(); \\n\\t$baseuri = \\\"https://secure.dialogtech.com/ibp_api.php?\\\";\\n\\n\\t// API Specific Static Parameters\\n\\t$action = \\\"clickto.findme\\\";\\n\\n\\t// Required User Parameters\\n\\t$access_key = \\\"foo\\\";\\n\\t$secret_access_key = \\\"bar\\\";\\n\\t$type = \\\"2\\\";\\n\\t$list = \\\"5559998888|5559997777\\\";\\n\\t$phone_to_call = \\\"5551112222\\\";\\n\\t$page = \\\"LeadResponse.html\\\";\\n\\t$first_callerid = \\\"9998887777\\\"; // Will display as the Caller ID for the 'phone_to_call' recipient as type=1\\n\\t$second_callerid = \\\"8887776666\\\"; // Will display as the Caller ID for the 'id' recipient as type=1\\n\\t$no_answer_email = \\\"[email protected]\\\";\\n\\t$no_answer_sms = \\\"5554443333\\\";\\n\\n\\t// Construct the full URL\\n\\t$full_url = $baseuri . \\\"&action=\\\" . $action .\\n\\t\\t\\\"&access_key=\\\" . $access_key .\\n\\t\\t\\\"&secret_access_key=\\\" . $secret_access_key .\\n\\t\\t\\\"&type=\\\" . $type .\\n\\t\\t\\\"&list=\\\" . $list .\\n\\t\\t\\\"&phone_to_call=\\\" . $phone_to_call .\\n\\t\\t\\\"&page=\\\" . $page .\\n\\t\\t\\\"&first_callerid=\\\" . $first_callerid .\\n\\t\\t\\\"&second_callerid=\\\" . $second_callerid .\\n\\t\\t\\\"&no_answer_email=\\\" . $no_answer_email .\\n\\t\\t\\\"&no_answer_sms=\\\" . $no_answer_sms;\\n\\n\\t// Set the URL\\n\\tcurl_setopt($ch, CURLOPT_URL, $full_url);\\n\\n\\t// Sets the return options of the cURL to return the actual result from the curl request, and FALSE on failure\\n\\tcurl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);\\n\\n\\t// Sets the $output variable to the result of the curl\\n\\t$output = curl_exec($ch);\\n\\n\\t// Close curl resource to free up system resources\\n\\tcurl_close($ch);\\n\\n\\t// Send the API output to the php page\\n\\techo $output;\\n?>\",\n      \"language\": \"php\",\n      \"name\": \"PHP Example 1\"\n    }\n  ]\n}\n[/block]\nWhen requesting the click-to-call API, the client side response will only populate after the first leg of the call is answered or not. The response will be a plain-text string indicating the success/failure of the first leg of the call.\n[block:api-header]\n{\n  \"title\": \"Example Response\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<!DOCTYPE response [\\n    \\n<!ELEMENT response (result,result_description,sid)>\\n<!ELEMENT result (#PCDATA)>\\n<!ELEMENT result_description (#PCDATA)>\\n<!ELEMENT sid (#PCDATA)>\\n    ]>\\n<response>\\n    <result>success</result>\\n    <result_description>Call Connected</result_description>\\n    <sid>181127fc48636186</sid>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"Success\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<!DOCTYPE response [\\n    \\n<!ELEMENT response (result,result_description,sid)>\\n<!ELEMENT result (#PCDATA)>\\n<!ELEMENT result_description (#PCDATA)>\\n<!ELEMENT sid (#PCDATA)>\\n    ]>\\n<response>\\n    <result>failed</result>\\n    <result_description>unknown</result_description>\\n    <sid>181127fa636be04c</sid>\\n</response>\",\n      \"language\": \"xml\",\n      \"name\": \"Failed\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"No Answer Email/SMS/URL Examples\"\n}\n[/block]\n\nThese examples were generated by an example very similar to [PHP Example 1](doc:click-to-findme-list#section-using-this-api) above.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"To: [email protected]\\nFrom: [email protected]\\nSubject: LeadResponse unsuccessful for (555) 111-2222\\n\\nAttempts to connect an agent to (555) 111-2222 were unsuccessful, with the following activity breakdown:\\n\\n(555) 868-8950 No Answer\",\n      \"language\": \"text\",\n      \"name\": \"Email\"\n    },\n    {\n      \"code\": \"To: (555) 444-3333\\nFrom: (555) 758-5902\\n\\nMessage: LeadResponse unsuccessful for (555) 111-2222\",\n      \"language\": \"text\",\n      \"name\": \"SMS\"\n    },\n    {\n      \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<response>\\n\\t<phone_to_call>5551112222</phone_to_call>\\n\\t<attempts>\\n\\t\\t<attempt>\\n\\t\\t\\t<called_number>5558688950</called_number>\\n\\t\\t\\t<call_result>No Answer</call_result>\\n\\t\\t</attempt>\\n\\t</attempts>\\n</response>\",\n      \"language\": \"text\",\n      \"name\": \"URL*\"\n    }\n  ]\n}\n[/block]\n*URL was delivered as POST Payload to the no_answer_url defined in the API call.","updates":["5bfda367195fdd014eabe144"],"order":3,"isReference":false,"hidden":true,"sync_unique":"","link_url":"","link_external":false,"_id":"58fdf91feed0651b00f82d60","createdAt":"2017-04-24T13:09:51.461Z","user":"58cadf93d223510f005d27db","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1","5f6cf225ba56a40011bff62d"],"_id":"558d9c33beb7c719007f631c","createdAt":"2015-06-26T18:38:43.154Z","project":"558d9c32beb7c719007f6319","releaseDate":"2015-06-26T18:38:43.153Z","__v":20},"__v":1,"category":{"sync":{"isSync":false,"url":""},"pages":["558dbe324cd25f0d00b7ecce","558dbe407afc102f008ed8a4","558dbe567afc102f008ed8a9","558dbe677afc102f008ed8ac","558dbe7e4cd25f0d00b7ecd0","558dbea37afc102f008ed8b2","558dbeb27afc102f008ed8b4","558dbec14cd25f0d00b7ecd2","558dbed0beb7c719007f63b4","558dbf61beb7c719007f63ba"],"title":"Call Initiation APIs","slug":"call-initiation-api","order":2,"from_sync":false,"reference":false,"_id":"558db0bc7afc102f008ed863","version":"558d9c33beb7c719007f631c","createdAt":"2015-06-26T20:06:20.813Z","project":"558d9c32beb7c719007f6319","__v":10},"githubsync":"","parentDoc":null,"project":"558d9c32beb7c719007f6319"}