{"_id":"558dc05d7afc102f008ed8b9","user":"558d70614cd25f0d00b7eba4","project":"558d9c32beb7c719007f6319","category":{"_id":"5908d1f64f544425002b6aae","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T18:37:42.174Z","from_sync":false,"order":9,"slug":"legacy-documentation","title":"Legacy Documentation"},"githubsync":"","__v":214,"parentDoc":null,"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":"2015-06-26T21:13:01.340Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use the Conference Calls API to launch conference calls.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/xT7z0llQRDGzPMQHI9kf_1440211614_call-group.png\",\n        \"1440211614_call-group.png\",\n        \"128\",\n        \"128\",\n        \"#1cafe2\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nThe Conference Calls API allows the user to launch conference calls. This API allows the user to schedule outbound calls to conference call attendees, if the user would rather not wait for all attendees to dial in. In addition to scheduling conference calls, the Conference Call API allows the user to add, remove, and mute attendees. The user also has the option of viewing the list of all scheduled conference calls, within a desired period of time.\n\nThe user may utilize the Find Me Call Forwarding API with the Add Attendee, Call Attendee, Attendee Details, Kick Attendee, Attendee List, Mute Attendee, Remove Attendee, Un-Mute Attendee, Details, List, Remove, and Schedule methods. \n\n##Add Attendee\n    conference.attendee.add\n\nUse the Add Attendee method to add one or more attendees to an existing Smart Conference Form.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Please Note\",\n  \"body\": \"If the conference call is already in progress, the Conference Smart Form will make outbound calls to new attendees and add them to the conference call.\"\n}\n[/block]\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"4-0\": \"User Conference Attendee ID\",\n    \"4-1\": \"X\",\n    \"0-1\": \"X\",\n    \"1-0\": \"Attendee List\",\n    \"1-1\": \"X\",\n    \"2-0\": \"Immediate\",\n    \"2-2\": \"X\",\n    \"3-0\": \"Invitations\",\n    \"3-2\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n    \n## Call Attendee\n    conference.attendee.call\n\nUse the Call Attendee method to add one or more call participants to a conference call.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Please Note\",\n  \"body\": \"The scheduled conference is programmed to call the phone number the attendee used to reach the call (in the past?).\"\n}\n[/block]\nThe parameters listed in the following table may be needed to complete this action:\n    \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"1-0\": \"User Conference ID\",\n    \"2-0\": \"User Conference Attendee ID\",\n    \"3-0\": \"User Conference Participation ID\",\n    \"1-1\": \"X\",\n    \"2-1\": \"X\",\n    \"3-1\": \"X\",\n    \"0-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n## Attendee Details\n    conference.attendee.details\n\nUse the Attendee Details to obtain conference call, participation details for a specific attendee.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"1-0\": \"User Conference ID\",\n    \"1-1\": \"X\",\n    \"2-0\": \"User Conference Attendee ID\",\n    \"0-1\": \"X\",\n    \"2-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n    \n## Kick Attendee\n    conference.attendee.kick\n\nUse the Kick Attendee method to kick a user (?) off of a conference call.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"1-0\": \"User Conference ID\",\n    \"1-1\": \"X\",\n    \"0-1\": \"X\",\n    \"2-0\": \"User Number\",\n    \"2-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n## Attendee List\n    conference.attendee.list\n\nUse the Attendee List method to obtain a list of attendees scheduled for a conference call.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"1-0\": \"User Conference ID\",\n    \"1-1\": \"X\",\n    \"0-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n## Mute Attendee\n    conference.attendee.mute\n\nUse the Mute Attendees method to mute a conference call participant.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONA\",\n    \"0-0\": \"API Key\",\n    \"1-0\": \"User Conference ID\",\n    \"1-1\": \"X\",\n    \"2-0\": \"User Number\",\n    \"2-1\": \"X\",\n    \"0-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n## Remove Attendee\n    conference.attendee.remove\n\nUse the Remove Attendees method to delete one or more attendees from a scheduled conference call.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"1-0\": \"User Conference ID\",\n    \"2-0\": \"User Conference Attendee ID\",\n    \"0-1\": \"X\",\n    \"1-1\": \"X\",\n    \"2-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n## Un-mute Attendee\n    conference.attendee.unmute\n\nUse the Un-Mute Attendee to un-mute a muted conference participant. \n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"1-0\": \"User Conference ID\",\n    \"1-1\": \"X\",\n    \"2-0\": \"User Number\",\n    \"2-1\": \"X\",\n    \"0-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n## Details\n    conference.details\n\nUse the Details method to obtain the details for a specific conference call.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"1-0\": \"User Conference ID\",\n    \"1-1\": \"X\",\n    \"0-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n## List\n    conference.list\n\nUse the List method to list all scheduled and completed conference calls.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n## Remove\n    conference.remove\n\nUse the Remove method to delete an inactive conference call.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-0\": \"User Conference ID\",\n    \"1-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n## Schedule\n    conference.schedule\n\nUse the Schedule method to schedule a conference call.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-0\": \"Attendee List\",\n    \"1-1\": \"X\",\n    \"2-0\": \"Conference Length\",\n    \"2-2\": \"X\",\n    \"3-0\": \"Conference Name\",\n    \"4-0\": \"Desc\",\n    \"3-2\": \"X\",\n    \"4-2\": \"X\",\n    \"5-0\": \"Inbound Only\",\n    \"5-2\": \"X\",\n    \"6-0\": \"Invitations\",\n    \"7-0\": \"Pin\",\n    \"6-2\": \"X\",\n    \"7-2\": \"X\",\n    \"8-0\": \"Scheduled Time\",\n    \"8-2\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"link\",\n  \"title\": \"API Test Panel\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/xAFLAAe0ROkT4CZrPEUr_1437618071_monitor-gear-control-panel.png\",\n        \"1437618071_monitor-gear-control-panel.png\",\n        \"48\",\n        \"48\",\n        \"#fcf1d4\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nUse the DialogTech [API Wizard and Test Panel](https://secure.ifbyphone.com/developer_testpanel.php) to make changes to a customer account.\n\nPlease note that this tool works with the live data in a customer account. The user must be careful when adding, editing, or deleting data.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example URLs\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/Lv5jdUtCSryMWMYDC4Hh_1440199635_link_add.png\",\n        \"1440199635_link_add.png\",\n        \"32\",\n        \"32\",\n        \"#609e04\",\n        \"\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Add Attendee Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.attendee.add&usr_conference_id=3731&attendee_list=7737648727%7CRose%20Tyler%7Crtyler%40example.com&immediate=1&invitations=1\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Call Attendee Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.attendee.call&usr_conference_id=3731&usr_conference_attendee_id=12181&usr_conference_participation_id=8921\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Attendee Details Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.attendee.list&usr_conference_id=3731&usr_conference_attendee_id=12181 \",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Kick Attendee Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.attendee.unmute&usr_conference_id=3731&user_number=28971\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Attendee List Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.attendee.list&usr_conference_id=3731\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Mute Attendee Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.attendee.mute&usr_conference_id=3731&user_number=28971\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Remove Attendee Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.attendee.remove&usr_conference_id=3731&usr_conference_attendee_id=12181\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Un-Mute Attendee Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.attendee.unmute&usr_conference_id=3731&user_number=28971\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Details Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.schedule&usr_conference_id=3731\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**List Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.list\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Remove Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.remove&usr_conference_id=3691\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Schedule Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=conference.schedule&conference_name=Conference%20%2317&scheduled_time=2008-11-18%2014%3A18%3A00%20-0600&conference_length=10&inboundonly=1&invitations=1&attendee_list=7735551212%7CJohn%20Smith%7Cjsmith%40example.com%7C%7C7735552222%7CMary%20Cellphone\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Responses\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/NV2CKkgsTbCxZUo41Sfe_1440199713_XML_Extention.png\",\n        \"1440199713_XML_Extention.png\",\n        \"32\",\n        \"32\",\n        \"#37472b\",\n        \"\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Add Attendee Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result/>\\n<result_description>Successfully added 1 out of 1 valid attendee(s) to the Smart Conference</result_description>\\n<usr_conference_id>3731</usr_conference_id>\\n<attendees_added>1</attendees_added>\\n<attendee>\\n<usr_conference_attendee_id>12181</usr_conference_attendee_id>\\n<attendee_name>Rose Tyler</attendee_name>\\n<phone_number>7735552222</phone_number>\\n<email_address>rtyler:::at:::example.com</email_address>\\n</attendee>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Call Attendee Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Smart Conference participant call successfully performed</result_description>\\n<result_action>call</result_action>\\n<usr_conference_id>3731</usr_conference_id>\\n<usr_conference_attendee_id>12181</usr_conference_attendee_id>\\n<usr_conference_participation_id>8921</usr_conference_participation_id>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Attendee Details Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Smart Conference attendee details successfully generated</result_description>\\n<usr_conference_attendee_id>12181</usr_conference_attendee_id>\\n<attendee_name>Harriet Jones</attendee_name>\\n<phone_number>773551212</phone_number>\\n<email_address>formerminister@example.com</email_address>\\n<participation>\\n<usr_conference_participation_id>8921</usr_conference_participation_id\\n<sid>0811188727015299</sid>\\n<caller_id>7735559999</caller_id>\\n<status>2</status>\\n<user_number/>\\n<muted>0</muted>\\n<active_minutes>10</active_minutes>\\n<elapsed_minutes>12.2</elapsed_minutes>\\n</participation>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Kick Attendee Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Smart Conference participant kick successfully performed</result_description>\\n<result_action>kick</result_action>\\n<usr_conference_id>3731</usr_conference_id>\\n<user_number>999</user_number>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Attendee List Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Smart Conference attendee list successfully generated\\n<attendee>\\n<usr_conference_attendee_id>11911</usr_conference_attendee_id>\\n<attendee_name>Rose Tyler</attendee_name>\\n<phone_number>7735552222</phone_number>\\n<email_address/>\\n<participation>\\n<usr_conference_participation_id/>\\n<sid/>\\n<caller_id/>\\n<status>0</status>\\n<user_number/>\\n<muted>0</muted>\\n<active_minutes>0</active_minutes>\\n<elapsed_minutes/>\\n</participation>\\n</attendee>\\n<attendee>\\n<usr_conference_attendee_id>12181</usr_conference_attendee_id>\\n<attendee_name>Harriet Jones</attendee_name>\\n<phone_number>7735551212</phone_number>\\n<email_address>formerminister@example.com</email_address>\\n<participation>\\n<usr_conference_participation_id>8921</usr_conference_participation_id\\n<sid>0811188727015299</sid>\\n<caller_id>7735559999</caller_id>\\n<status>1</status>\\n<user_number/>\\n<muted>0</muted>\\n<active_minutes>10</active_minutes>\\n<elapsed_minutes>12.2</elapsed_minutes>\\n</participation>\\n</attendee>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Mute Attendee Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Smart Conference participant mute successfully performed</result_description>\\n<result_action>mute</result_action>\\n<usr_conference_id>3731</usr_conference_id>\\n<user_number>28971</user_number>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Remove Attendee Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Successfully removed 1 attendee(s) from the Smart Conference</result_description>\\n<usr_conference_id>3731</usr_conference_id>\\n<attendees_removed>1</attendees_removed>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Un-Mute Attendee Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Smart Conference participant unmute successfully performed</result_description>\\n<result_action>unmute</result_action>\\n<usr_conference_id>3731</usr_conference_id>\\n<user_number>28971</user_number>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Details Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description/>\\n<usr_conference_id>3731</usr_conference_id>\\n<conference_name>Smart Conference 11-17-2008</conference_name>\\n<scheduled_time>2008-11-18 15:20:00 -0600</scheduled_time>\\n<conference_length>10</conference_length>\\n<pin/>\\n<allow_overrun>1</allow_overrun>\\n<status>0</status>\\n<attendees>2</attendees>\\n<participants>0</participants>\\n<sys_conference_server_id>2</sys_conference_server_id>\\n<dnis>8003415801</dnis>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**List Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>\\n</result_description>\\n<conference>\\n<usr_conference_id>370</usr_conference_id>\\n<conference_name>Demo Conference</conference_name>\\n<scheduled_time>2009-06-13 17:30:00 -0500</scheduled_time>\\n<conference_length>60</conference_length>\\n<pin>1234</pin>\\n<allow_overrun>1</allow_overrun>\\n<status>0</status>\\n<attendees>3</attendees>\\n<participants>0</participants>\\n<sys_conference_server_id>1</sys_conference_server_id>\\n<dnis>8475551234</dnis>\\n</conference>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Remove Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>The conference was successfully removed</result_description>\\n<usr_conference_id>112</usr_conference_id>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Schedule Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>\\nSuccessfully scheduled the Smart Conference with 2 out of 2 valid attendee(s)\\n</result_description>\\n<usr_conference_id>3651</usr_conference_id>\\n<conference_name>\\nConference #17\\n</conference_name>\\n<scheduled_time>2008-11-18 14:20:00 -0600</scheduled_time>\\n<conference_length>10</conference_length>\\n<pin/>\\n<allow_overrun>1</allow_overrun>\\n<status>1</status>\\n<attendees_added>2</attendees_added>\\n<sys_conference_server_id>2</sys_conference_server_id>\\n<dnis>8005551212</dnis>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"","slug":"conference-calls","type":"basic","title":"CONFERENCE CALLS"}

Use the Conference Calls API to launch conference calls.

The Conference Calls API allows the user to launch conference calls. This API allows the user to schedule outbound calls to conference call attendees, if the user would rather not wait for all attendees to dial in. In addition to scheduling conference calls, the Conference Call API allows the user to add, remove, and mute attendees. The user also has the option of viewing the list of all scheduled conference calls, within a desired period of time.

The user may utilize the Find Me Call Forwarding API with the Add Attendee, Call Attendee, Attendee Details, Kick Attendee, Attendee List, Mute Attendee, Remove Attendee, Un-Mute Attendee, Details, List, Remove, and Schedule methods.

Add Attendee

conference.attendee.add

Use the Add Attendee method to add one or more attendees to an existing Smart Conference Form.

Please Note

If the conference call is already in progress, the Conference Smart Form will make outbound calls to new attendees and add them to the conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

Attendee List

X

Immediate

X

Invitations

X

User Conference Attendee ID

X

Call Attendee

conference.attendee.call

Use the Call Attendee method to add one or more call participants to a conference call.

Please Note

The scheduled conference is programmed to call the phone number the attendee used to reach the call (in the past?).

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

User Conference ID

X

User Conference Attendee ID

X

User Conference Participation ID

X

Attendee Details

conference.attendee.details

Use the Attendee Details to obtain conference call, participation details for a specific attendee.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

User Conference ID

X

User Conference Attendee ID

X

Kick Attendee

conference.attendee.kick

Use the Kick Attendee method to kick a user (?) off of a conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

User Conference ID

X

User Number

X

Attendee List

conference.attendee.list

Use the Attendee List method to obtain a list of attendees scheduled for a conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

User Conference ID

X

Mute Attendee

conference.attendee.mute

Use the Mute Attendees method to mute a conference call participant.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONA

API Key

X

User Conference ID

X

User Number

X

Remove Attendee

conference.attendee.remove

Use the Remove Attendees method to delete one or more attendees from a scheduled conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

User Conference ID

X

User Conference Attendee ID

X

Un-mute Attendee

conference.attendee.unmute

Use the Un-Mute Attendee to un-mute a muted conference participant.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

User Conference ID

X

User Number

X

Details

conference.details

Use the Details method to obtain the details for a specific conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

User Conference ID

X

List

conference.list

Use the List method to list all scheduled and completed conference calls.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

Remove

conference.remove

Use the Remove method to delete an inactive conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

User Conference ID

X

Schedule

conference.schedule

Use the Schedule method to schedule a conference call.

The parameters listed in the following table may be needed to complete this action:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

Attendee List

X

Conference Length

X

Conference Name

X

Desc

X

Inbound Only

X

Invitations

X

Pin

X

Scheduled Time

X

linkAPI Test Panel

Use the DialogTech API Wizard and Test Panel to make changes to a customer account.

Please note that this tool works with the live data in a customer account. The user must be careful when adding, editing, or deleting data.

Example URLs

Add Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.add&usr_conference_id=3731&attendee_list=7737648727%7CRose%20Tyler%7Crtyler%40example.com&immediate=1&invitations=1

Call Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.call&usr_conference_id=3731&usr_conference_attendee_id=12181&usr_conference_participation_id=8921

Attendee Details Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.list&usr_conference_id=3731&usr_conference_attendee_id=12181 

Kick Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.unmute&usr_conference_id=3731&user_number=28971

Attendee List Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.list&usr_conference_id=3731

Mute Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.mute&usr_conference_id=3731&user_number=28971

Remove Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.remove&usr_conference_id=3731&usr_conference_attendee_id=12181

Un-Mute Attendee Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.attendee.unmute&usr_conference_id=3731&user_number=28971

Details Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.schedule&usr_conference_id=3731

List Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.list

Remove Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.remove&usr_conference_id=3691

Schedule Example URL:

/ibp_api.php?api_key=foofoofoo&action=conference.schedule&conference_name=Conference%20%2317&scheduled_time=2008-11-18%2014%3A18%3A00%20-0600&conference_length=10&inboundonly=1&invitations=1&attendee_list=7735551212%7CJohn%20Smith%7Cjsmith%40example.com%7C%7C7735552222%7CMary%20Cellphone

Example Responses

Add Attendee Example Response:

<response>
<result/>
<result_description>Successfully added 1 out of 1 valid attendee(s) to the Smart Conference</result_description>
<usr_conference_id>3731</usr_conference_id>
<attendees_added>1</attendees_added>
<attendee>
<usr_conference_attendee_id>12181</usr_conference_attendee_id>
<attendee_name>Rose Tyler</attendee_name>
<phone_number>7735552222</phone_number>
<email_address>rtyler@example.com</email_address>
</attendee>
</response>

Call Attendee Example Response:

<response>
<result>success</result>
<result_description>Smart Conference participant call successfully performed</result_description>
<result_action>call</result_action>
<usr_conference_id>3731</usr_conference_id>
<usr_conference_attendee_id>12181</usr_conference_attendee_id>
<usr_conference_participation_id>8921</usr_conference_participation_id>
</response>

Attendee Details Example Response:

<response>
<result>success</result>
<result_description>Smart Conference attendee details successfully generated</result_description>
<usr_conference_attendee_id>12181</usr_conference_attendee_id>
<attendee_name>Harriet Jones</attendee_name>
<phone_number>773551212</phone_number>
<email_address>formerminister@example.com</email_address>
<participation>
<usr_conference_participation_id>8921</usr_conference_participation_id
<sid>0811188727015299</sid>
<caller_id>7735559999</caller_id>
<status>2</status>
<user_number/>
<muted>0</muted>
<active_minutes>10</active_minutes>
<elapsed_minutes>12.2</elapsed_minutes>
</participation>
</response>

Kick Attendee Example Response:

<response>
<result>success</result>
<result_description>Smart Conference participant kick successfully performed</result_description>
<result_action>kick</result_action>
<usr_conference_id>3731</usr_conference_id>
<user_number>999</user_number>
</response>

Attendee List Example Response:

<response>
<result>success</result>
<result_description>Smart Conference attendee list successfully generated
<attendee>
<usr_conference_attendee_id>11911</usr_conference_attendee_id>
<attendee_name>Rose Tyler</attendee_name>
<phone_number>7735552222</phone_number>
<email_address/>
<participation>
<usr_conference_participation_id/>
<sid/>
<caller_id/>
<status>0</status>
<user_number/>
<muted>0</muted>
<active_minutes>0</active_minutes>
<elapsed_minutes/>
</participation>
</attendee>
<attendee>
<usr_conference_attendee_id>12181</usr_conference_attendee_id>
<attendee_name>Harriet Jones</attendee_name>
<phone_number>7735551212</phone_number>
<email_address>formerminister@example.com</email_address>
<participation>
<usr_conference_participation_id>8921</usr_conference_participation_id
<sid>0811188727015299</sid>
<caller_id>7735559999</caller_id>
<status>1</status>
<user_number/>
<muted>0</muted>
<active_minutes>10</active_minutes>
<elapsed_minutes>12.2</elapsed_minutes>
</participation>
</attendee>
</response>

Mute Attendee Example Response:

<response>
<result>success</result>
<result_description>Smart Conference participant mute successfully performed</result_description>
<result_action>mute</result_action>
<usr_conference_id>3731</usr_conference_id>
<user_number>28971</user_number>
</response>

Remove Attendee Example Response:

<response>
<result>success</result>
<result_description>Successfully removed 1 attendee(s) from the Smart Conference</result_description>
<usr_conference_id>3731</usr_conference_id>
<attendees_removed>1</attendees_removed>
</response>

Un-Mute Attendee Example Response:

<response>
<result>success</result>
<result_description>Smart Conference participant unmute successfully performed</result_description>
<result_action>unmute</result_action>
<usr_conference_id>3731</usr_conference_id>
<user_number>28971</user_number>
</response>

Details Example Response:

<response>
<result>success</result>
<result_description/>
<usr_conference_id>3731</usr_conference_id>
<conference_name>Smart Conference 11-17-2008</conference_name>
<scheduled_time>2008-11-18 15:20:00 -0600</scheduled_time>
<conference_length>10</conference_length>
<pin/>
<allow_overrun>1</allow_overrun>
<status>0</status>
<attendees>2</attendees>
<participants>0</participants>
<sys_conference_server_id>2</sys_conference_server_id>
<dnis>8003415801</dnis>
</response>

List Example Response:

<response>
<result>success</result>
<result_description>
</result_description>
<conference>
<usr_conference_id>370</usr_conference_id>
<conference_name>Demo Conference</conference_name>
<scheduled_time>2009-06-13 17:30:00 -0500</scheduled_time>
<conference_length>60</conference_length>
<pin>1234</pin>
<allow_overrun>1</allow_overrun>
<status>0</status>
<attendees>3</attendees>
<participants>0</participants>
<sys_conference_server_id>1</sys_conference_server_id>
<dnis>8475551234</dnis>
</conference>
</response>

Remove Example Response:

<response>
<result>success</result>
<result_description>The conference was successfully removed</result_description>
<usr_conference_id>112</usr_conference_id>
</response>

Schedule Example Response:

<response>
<result>success</result>
<result_description>
Successfully scheduled the Smart Conference with 2 out of 2 valid attendee(s)
</result_description>
<usr_conference_id>3651</usr_conference_id>
<conference_name>
Conference #17
</conference_name>
<scheduled_time>2008-11-18 14:20:00 -0600</scheduled_time>
<conference_length>10</conference_length>
<pin/>
<allow_overrun>1</allow_overrun>
<status>1</status>
<attendees_added>2</attendees_added>
<sys_conference_server_id>2</sys_conference_server_id>
<dnis>8005551212</dnis>
</response>