{"__v":8,"_id":"544e570cbd51b9080037f8d3","category":{"__v":21,"_id":"543bf3e22a30961a00b66eb3","pages":["5489d5e61ea5330b007b5a51","5489e243d8dec60b00034297","5489e318aefb240b00d197ef","56cdf622e538330b0021ab5a"],"project":"542dbe0ecb19820800c1f4d7","version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-13T15:46:42.097Z","from_sync":false,"order":1,"slug":"inboundxml","title":"InboundXML"},"is_link":false,"parentDoc":null,"project":"542dbe0ecb19820800c1f4d7","user":"544a586d27b7fc140078db12","version":{"__v":29,"_id":"542ecc0a6b0eb6080066ca77","forked_from":"542dbe0fcb19820800c1f4da","project":"542dbe0ecb19820800c1f4d7","createdAt":"2014-10-03T16:17:14.165Z","releaseDate":"2014-10-03T16:17:14.165Z","categories":["542ecc0a6b0eb6080066ca78","542ef44f6b0eb6080066cb24","543bf3e22a30961a00b66eb3","5446952b82bd7e08002768a0","544821ae8d7af31a00dd41ce","544a7885f1aefa08006efc69","544c758e11845f0e001ed8de","544e5565b80812080035be55","544e558dbd51b9080037f8ca","5450b045a66f020800dba73d","5450eb6aa66f020800dba945","5450f39ea66f020800dba989","5450f877a66f020800dba9cf","54510356a66f020800dbaa17","5451274514af501a00b50c99","54513345a66f020800dbab24","54513cc014af501a00b50d24","54515eec14af501a00b50db9","54519b1d14af501a00b50ea9","54519b2aa66f020800dbacb4","54524f9704160008005b1d27","54538d2308d1800800473d95","54538d420c09721000a06a03","54538e5608d1800800473d9a","5453ea9547c30114004fb375","5453eb12b077c31c00067bcb","5453eb27b077c31c00067bcd","5453ed5db077c31c00067bde","548075cbe291c51a00e7e096"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-10-27T14:30:36.016Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"results":{"codes":[]},"settings":"","try":true,"auth":"never","params":[],"url":""},"isReference":false,"order":3,"body":"Like the `<Number>` element, the `<Conference>` element is only nested within the `<Dial>` element. Instead of dialing a number, the `<Conference>` element allows the ongoing call to connect to a conference room.\n\nThe conference room name is nested within the `<Conference>` element, and all calls connected to the same conference room name will be in the room together.\n\nBy default, all callers will hear hold music until two callers are in the room. To change this behavior, startConferenceOnEnter may be set to ‘true’ or ‘false’. The waitUrl attribute may be used to set a custom MP3. For greater customization, the URL of an InboundXML document can be used while callers are waiting as well. If an InboundXML document is used, the `<Gather>`, `<Record>` and `<Dial>` elements are not allowed.\n\nWhen callers enter or exit the room, a beep is heard if the beep attribute is set to the default value of ‘true’. A participant can be initially muted by setting the muted attribute to ‘true’.\n\nThe conference room can be limited to a certain number of participants by setting the maxParticipants attribute. The endConferenceOnExit attribute is used to end a conference when an specific user (or any one of many users) exits.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"muted\",\n    \"0-1\": \"Boolean value specifying if the conference should be muted. Default Value: false. Allowed Value: true or false.\",\n    \"1-0\": \"beep\",\n    \"1-1\": \"Boolean value specifying if a beep should play upon entrance to conference. Default Value: false. Allowed Value: true or false.\",\n    \"2-0\": \"startConferenceOnEnter\",\n    \"2-1\": \"Boolean value specifying if conference should begin upon entrance. Default Value: false. Allowed Value: true or false.\",\n    \"3-0\": \"endConferenceOnExit\",\n    \"3-1\": \"Boolean value specifying if conference should end upon a specific users exit. Default Value: false. Allowed Value: true or false.\",\n    \"4-0\": \"maxParticipants\",\n    \"4-1\": \"The maximum number of participants allowed in the conference call. Default Value: 40. Allowed Value: integer from 1 to 40.\",\n    \"5-0\": \"waitSound\",\n    \"5-1\": \"URL to inboundXML where conference participants can be sent to while they wait for entrance into the conference. Only `<Play>` method supported at this time.\",\n    \"6-0\": \"hangupOnStar\",\n    \"6-1\": \"Boolean value specifying if pressing * should end the conference. Default Value: false. Allowed Value: true or false.\",\n    \"7-0\": \"callbackUrl\",\n    \"7-1\": \"URL where some parameters specific to `<Conference>` will be sent when participants enter and exit the conference and once it is completed. There is only one callbackUrl allowed per conference. The first callbackUrl will be the only one used.\",\n    \"8-0\": \"callbackMethod\",\n    \"8-1\": \"Method used to request the callback URL. Default Value: POST. Allowed Value: POST or GET.\",\n    \"9-0\": \"digitsMatch\",\n    \"9-1\": \"Specifies digits that Zang should listen for and send to the callbackUrl if a caller inputs them. Separate additional digits or digit patterns with a comma. Allowed Value: Pattern made up of the digits 0-9, #, or *.\",\n    \"10-0\": \"stayAlone\",\n    \"10-1\": \"Boolean value specifying if the caller should stay alone in the conference call. Default Value: false. Allowed Value: true or false.\",\n    \"11-0\": \"record\",\n    \"11-1\": \"Boolean value specifying if the conference should be recorded. Default Value: false. Allowed Value: true or false.\",\n    \"12-0\": \"recordCallbackUrl\",\n    \"12-1\": \"URL to sound that the recording will be sent to from the conference.\",\n    \"13-0\": \"recordFileFormat\",\n    \"13-1\": \"File format in which the recording will be saved in. Default Value: mp3. Allowed Value: mp3 or wav.\"\n  },\n  \"cols\": 2,\n  \"rows\": 14\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Nesting\",\n  \"body\": \"In addition to the default `<Response>` element, the `<Conference>` element must also be nested within the following `<Dial>` verb. No other elements may be nested within the `<Conference>` element.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Examples\"\n}\n[/block]\nThe InboundXML below will start a conference with the name “ZangExampleChat” when the number using the XML is called. The maximum participants allowed in this conference is 5 and pressing * will end this conference.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<Response>\\n  <Dial>\\n    <Conference startConferenceOnEnter=\\\"true\\\" callbackUrl=\\\"http://webhookr.com/conf-callback\\\" hangupOnStar=\\\"true\\\" maxParticipants=\\\"5\\\">ZangExampleChat</Conference>\\n  </Dial>\\n</Response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"conference","type":"basic","title":"<Conference>"}
Like the `<Number>` element, the `<Conference>` element is only nested within the `<Dial>` element. Instead of dialing a number, the `<Conference>` element allows the ongoing call to connect to a conference room. The conference room name is nested within the `<Conference>` element, and all calls connected to the same conference room name will be in the room together. By default, all callers will hear hold music until two callers are in the room. To change this behavior, startConferenceOnEnter may be set to ‘true’ or ‘false’. The waitUrl attribute may be used to set a custom MP3. For greater customization, the URL of an InboundXML document can be used while callers are waiting as well. If an InboundXML document is used, the `<Gather>`, `<Record>` and `<Dial>` elements are not allowed. When callers enter or exit the room, a beep is heard if the beep attribute is set to the default value of ‘true’. A participant can be initially muted by setting the muted attribute to ‘true’. The conference room can be limited to a certain number of participants by setting the maxParticipants attribute. The endConferenceOnExit attribute is used to end a conference when an specific user (or any one of many users) exits. [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "muted", "0-1": "Boolean value specifying if the conference should be muted. Default Value: false. Allowed Value: true or false.", "1-0": "beep", "1-1": "Boolean value specifying if a beep should play upon entrance to conference. Default Value: false. Allowed Value: true or false.", "2-0": "startConferenceOnEnter", "2-1": "Boolean value specifying if conference should begin upon entrance. Default Value: false. Allowed Value: true or false.", "3-0": "endConferenceOnExit", "3-1": "Boolean value specifying if conference should end upon a specific users exit. Default Value: false. Allowed Value: true or false.", "4-0": "maxParticipants", "4-1": "The maximum number of participants allowed in the conference call. Default Value: 40. Allowed Value: integer from 1 to 40.", "5-0": "waitSound", "5-1": "URL to inboundXML where conference participants can be sent to while they wait for entrance into the conference. Only `<Play>` method supported at this time.", "6-0": "hangupOnStar", "6-1": "Boolean value specifying if pressing * should end the conference. Default Value: false. Allowed Value: true or false.", "7-0": "callbackUrl", "7-1": "URL where some parameters specific to `<Conference>` will be sent when participants enter and exit the conference and once it is completed. There is only one callbackUrl allowed per conference. The first callbackUrl will be the only one used.", "8-0": "callbackMethod", "8-1": "Method used to request the callback URL. Default Value: POST. Allowed Value: POST or GET.", "9-0": "digitsMatch", "9-1": "Specifies digits that Zang should listen for and send to the callbackUrl if a caller inputs them. Separate additional digits or digit patterns with a comma. Allowed Value: Pattern made up of the digits 0-9, #, or *.", "10-0": "stayAlone", "10-1": "Boolean value specifying if the caller should stay alone in the conference call. Default Value: false. Allowed Value: true or false.", "11-0": "record", "11-1": "Boolean value specifying if the conference should be recorded. Default Value: false. Allowed Value: true or false.", "12-0": "recordCallbackUrl", "12-1": "URL to sound that the recording will be sent to from the conference.", "13-0": "recordFileFormat", "13-1": "File format in which the recording will be saved in. Default Value: mp3. Allowed Value: mp3 or wav." }, "cols": 2, "rows": 14 } [/block] [block:callout] { "type": "info", "title": "Nesting", "body": "In addition to the default `<Response>` element, the `<Conference>` element must also be nested within the following `<Dial>` verb. No other elements may be nested within the `<Conference>` element." } [/block] [block:api-header] { "type": "basic", "title": "Examples" } [/block] The InboundXML below will start a conference with the name “ZangExampleChat” when the number using the XML is called. The maximum participants allowed in this conference is 5 and pressing * will end this conference. [block:code] { "codes": [ { "code": "<Response>\n <Dial>\n <Conference startConferenceOnEnter=\"true\" callbackUrl=\"http://webhookr.com/conf-callback\" hangupOnStar=\"true\" maxParticipants=\"5\">ZangExampleChat</Conference>\n </Dial>\n</Response>", "language": "xml" } ] } [/block]