{"__v":2,"_id":"544c7caf36475e0e005014d9","category":{"__v":7,"_id":"544c758e11845f0e001ed8de","pages":["544c764036475e0e005014ce","544c7caf36475e0e005014d9","544d58b7bd51b9080037f558","544d4130bd51b9080037f545","544d5de4b80812080035ba36","544d94e4bd51b9080037f58c","544d9863bd51b9080037f592"],"project":"542dbe0ecb19820800c1f4d7","version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-26T04:16:14.619Z","from_sync":false,"order":7,"slug":"conferences","title":"Conferences"},"editedParams":true,"editedParams2":true,"is_link":false,"parentDoc":null,"project":"542dbe0ecb19820800c1f4d7","user":"542dc547cb19820800c1f4f1","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-26T04:46:39.444Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":true,"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"","code":"{\n    \"sid\"  : \"{ConferenceSid}\",\n    \"friendly_name\" : \"testing\",\n    \"account_sid\" : \"{AccountSid}\",\n    \"participant_count\" : \"0\",\n    \"run_time\" : \"0\",\n    \"status\"   : \"init\",\n    \"uri\" : \"/v2/Accounts/{AccountSid}/Conferences/{ConferenceSid}.json\",\n    \"date_created\" : \"Tue, 11 Sep 2012 15:26:47 +0000\",\n    \"date_updated\" : \"Tue, 11 Sep 2012 15:26:47 +0000\",\n    \"subresource_uris\": {\n        \"participants\": \"/v2/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json\"\n    }\n}        ","language":"json","status":200},{"code":"{\n    \"status\": 404,\n    \"message\": \"The requested resource was not found: /v2/Accounts/bad/bad_response.json\"\n}","language":"json","status":404}]},"settings":"","try":true,"auth":"required","params":[{"_id":"544c7eda11845f0e001ed8e7","ref":"","in":"path","required":true,"desc":"Account SID.","default":"","type":"string","name":"AccountSid"},{"_id":"544c7eda11845f0e001ed8e6","ref":"","in":"query","required":false,"desc":"Filters conferences by the given FriendlyName.","default":"","type":"string","name":"FriendlyName"},{"_id":"544c7eda11845f0e001ed8e5","ref":"","in":"query","required":false,"desc":"Filters conferences by the given status. Allowed values are \"init\", \"in-progress\", or \"completed\".","default":"","type":"string","name":"Status"},{"_id":"544c7eda11845f0e001ed8e4","ref":"","in":"query","required":false,"desc":"Filter by conferences created on, after, or before a given date. Date range can be specified using inequalities like \"DateCreated>=YYYY-MM-DD\". Allowed values are dates in the YYYY-MM-DD format.","default":"","type":"string","name":"DateCreated"},{"_id":"544c7eda11845f0e001ed8e3","ref":"","in":"query","required":false,"desc":"Filter by conferences updated on or after a given date. Date range can be specified using inequalities like \"DateCreated>=YYYY-MM-DD\". Allowed values are dates in the YYYY-MM-DD format.","default":"","type":"string","name":"DateUpdated"},{"_id":"544c7eda11845f0e001ed8e2","ref":"","in":"query","required":false,"desc":"Used to return a particular page within the list.","default":"","type":"string","name":"Page"},{"_id":"544c7eda11845f0e001ed8e1","ref":"","in":"query","required":false,"desc":"Used to specify the amount of list items to return per page.","default":"","type":"string","name":"PageSize"}],"url":"/v2/Accounts/:AccountSid/Conferences.json"},"isReference":false,"order":1,"body":"# **Response Parameters**\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"first_page_uri\",\n    \"0-1\": \"URI for the first page of results.\",\n    \"1-0\": \"end\",\n    \"1-1\": \"Last result index.\",\n    \"2-0\": \"total\",\n    \"2-1\": \"Number of items.\",\n    \"3-0\": \"previous_page_uri\",\n    \"3-1\": \"URI for the previous page of results.\",\n    \"4-0\": \"num_pages\",\n    \"4-1\": \"Number of pages.\",\n    \"5-0\": \"uri\",\n    \"5-1\": \"The Uniform Resource Identifier to this resource.\",\n    \"6-0\": \"page_size\",\n    \"6-1\": \"Number of items on a single page.\",\n    \"7-0\": \"start\",\n    \"7-1\": \"Index of the first item on the current page.\",\n    \"8-0\": \"next_page_uri\",\n    \"8-1\": \"URI for the next page of the results.\",\n    \"9-0\": \"last_page_uri\",\n    \"9-1\": \"URI for the last page of the results.\",\n    \"10-0\": \"page\",\n    \"10-1\": \"Current page number.\",\n    \"11-0\": \"conferences\",\n    \"11-1\": \"Array containing conferences.\"\n  },\n  \"cols\": 2,\n  \"rows\": 12\n}\n[/block]\nReturn parameters for conferences are equal to those on [\"View Conference\" API call](/v2/docs/view-conference).\n\n# **Example cURL**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET 'https://api.zang.io/v2/Accounts/{AccountSid}/Conferences/{ConferenceSid}.json' -u '{AccountSid}:{AuthToken}'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]","excerpt":"shows information on all conferences associated with some account","slug":"list-conferences","type":"endpoint","title":"List Conferences"}

getList Conferences

shows information on all conferences associated with some account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

AccountSid:
required
string
Account SID.

Query Params

FriendlyName:
string
Filters conferences by the given FriendlyName.
Status:
string
Filters conferences by the given status. Allowed values are "init", "in-progress", or "completed".
DateCreated:
string
Filter by conferences created on, after, or before a given date. Date range can be specified using inequalities like "DateCreated>=YYYY-MM-DD". Allowed values are dates in the YYYY-MM-DD format.
DateUpdated:
string
Filter by conferences updated on or after a given date. Date range can be specified using inequalities like "DateCreated>=YYYY-MM-DD". Allowed values are dates in the YYYY-MM-DD format.
Page:
string
Used to return a particular page within the list.
PageSize:
string
Used to specify the amount of list items to return per page.

Result Format


Documentation

# **Response Parameters** [block:parameters] { "data": { "h-0": "Parameter", "h-1": "Description", "0-0": "first_page_uri", "0-1": "URI for the first page of results.", "1-0": "end", "1-1": "Last result index.", "2-0": "total", "2-1": "Number of items.", "3-0": "previous_page_uri", "3-1": "URI for the previous page of results.", "4-0": "num_pages", "4-1": "Number of pages.", "5-0": "uri", "5-1": "The Uniform Resource Identifier to this resource.", "6-0": "page_size", "6-1": "Number of items on a single page.", "7-0": "start", "7-1": "Index of the first item on the current page.", "8-0": "next_page_uri", "8-1": "URI for the next page of the results.", "9-0": "last_page_uri", "9-1": "URI for the last page of the results.", "10-0": "page", "10-1": "Current page number.", "11-0": "conferences", "11-1": "Array containing conferences." }, "cols": 2, "rows": 12 } [/block] Return parameters for conferences are equal to those on ["View Conference" API call](/v2/docs/view-conference). # **Example cURL** [block:code] { "codes": [ { "code": "curl -X GET 'https://api.zang.io/v2/Accounts/{AccountSid}/Conferences/{ConferenceSid}.json' -u '{AccountSid}:{AuthToken}'", "language": "shell" } ] } [/block]