{"__v":8,"_id":"544ab18abb58010800710b86","category":{"__v":0,"_id":"54538e5608d1800800473d9a","pages":["542ef4fd1161420800d8370c","544a9f7c4688c708001866a2","544ab18abb58010800710b86","543acbefe14e09080000a0ac","544c5f7236475e0e005014c7","543bd73c5e7c871600f190da","543bf3f25e7c871600f19170","544577290a8dbc1a00ff6a23"],"project":"542dbe0ecb19820800c1f4d7","version":"542ecc0a6b0eb6080066ca77","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-10-31T13:27:50.899Z","from_sync":false,"order":3,"slug":"calls","title":"Calls"},"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-24T20:07:38.351Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"examples":{"codes":[]},"method":"get","results":{"codes":[{"name":"JSON","code":"{\n  \"page\": 0,\n  \"num_pages\": 29,\n  \"page_size\": 50,\n  \"total\": 1454,\n  \"start\": 0,\n  \"end\": 49,\n  \"uri\": \"/v2/Accounts/{AccountSid}/Calls.json\",\n  \"first_page_uri\": \"/v2/Accounts/{AccountSid}/Calls.json?Page=0&PageSize=50\",\n  \"previous_page_uri\": null,\n  \"next_page_uri\": \"/v2/Accounts/{AccountSid}/Calls.json?Page=1&PageSize=50\",\n  \"last_page_uri\": \"/v2/Accounts/{AccountSid}/Calls.json?Page=28&PageSize=50\",\n  \"calls\": [\n\n    {\n    \"sid\": \"{CallSid}\",\n    \"date_created\": \"Fri, 27 Jul 2012 15:52:02 +0000\",\n    \"date_updated\": \"Fri, 27 Jul 2012 15:52:11 +0000\",\n    \"parent_call_sid\": \"\",\n    \"account_sid\": \"{AccountSid}\",\n    \"to\": \"+12015554992\",\n    \"from\": \"Restricted\",\n    \"phone_number_sid\": \"{phone_number_sid}\",\n    \"status\": \"completed\",\n    \"start_time\": \"Fri, 27 Jul 2012 15:52:02 +0000\",\n    \"end_time\": \"Fri, 27 Jul 2012 15:52:11 +0000\",\n    \"duration\": \"9\",\n    \"price\": \"0.020000\",\n    \"direction\": \"inbound\",\n    \"answered_by\": \"None\",\n    \"api_version\": \"v2\",\n    \"forwarded_from\": \"\",\n    \"p_asserted_identity\": \"\",\n    \"sip_privacy\": \"\",\n    \"privacy_hide_number\": \"False\",\n    \"uri\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}.json\",\n    \"subresource_uris\": {\n        \"notifications\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json\",\n        \"recordings\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json\"\n        }\n    }\n\n\n    , \n    {\n    \"sid\": \"{CallSid}\",\n    \"date_created\": \"Fri, 27 Jul 2012 15:51:57 +0000\",\n    \"date_updated\": \"Fri, 27 Jul 2012 15:52:09 +0000\",\n    \"parent_call_sid\": \"\",\n    \"account_sid\": \"{AccountSid}\",\n    \"to\": \"+12015554992\",\n    \"from\": \"+17325551234\",\n    \"phone_number_sid\": \"{phone_number_sid\",\n    \"status\": \"completed\",\n    \"start_time\": \"Fri, 27 Jul 2012 15:52:03 +0000\",\n    \"end_time\": \"Fri, 27 Jul 2012 15:52:09 +0000\",\n    \"duration\": \"6\",\n    \"price\": \"0.066000\",\n    \"direction\": \"outbound-dial\",\n    \"answered_by\": \"None\",\n    \"api_version\": \"v2\",\n    \"forwarded_from\": \"\",\n    \"p_asserted_identity\": \"\",\n    \"sip_privacy\": \"None\",\n    \"privacy_hide_number\": \"False\",\n    \"uri\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}.json\",\n    \"subresource_uris\": {\n        \"notifications\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json\",\n        \"recordings\": \"/v2/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json\"\n        }\n    }\n\n    ...\n\n    ]\n}        ","language":"json","status":null},{"name":"","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":"optional","params":[{"_id":"544ab27d4688c708001866bf","ref":"","in":"path","required":true,"desc":"Enter the Account Sid","default":"","type":"string","name":"AccountSid"},{"_id":"544ab27d4688c708001866be","ref":"","in":"query","required":false,"desc":"Filter by a specific number calls were made to.","default":"","type":"string","name":"To"},{"_id":"544ab27d4688c708001866bd","ref":"","in":"query","required":false,"desc":"Filter by a specific number calls were made from.","default":"","type":"string","name":"From"},{"_id":"544ab27d4688c708001866bc","ref":"","in":"query","required":false,"desc":"Filter by calls with the specified status. Allowed values are \"ringing\", \"in-progress\", \"queued\", \"busy\", \"completed\", \"no-answer\", and \"failed\".","default":"","type":"string","name":"Status"},{"_id":"544ab27d4688c708001866bb","ref":"","in":"query","required":false,"desc":"Filter by all calls beginning on or from a certain date. Date range can be specified using inequalities like so: \"StartTime>=YYYY-MM-DD\".","default":"","type":"string","name":"StartTime"},{"_id":"544ab27d4688c708001866ba","ref":"","in":"query","required":false,"desc":"Used to return a particular page within the list.","default":"","type":"string","name":"Page"},{"_id":"544ab27d4688c708001866b9","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/Calls.json"},"isReference":false,"order":2,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response Parameters\"\n}\n[/block]\n\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\": \"calls\",\n    \"11-1\": \"Array containing calls.\"\n  },\n  \"cols\": 2,\n  \"rows\": 12\n}\n[/block]\nReturn parameters for calls are equal to those on [\"View Call\" API call](/v2/docs/view-call).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example cURL\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -X GET 'https://api.zang.io/v2/Accounts/{AccountSid}/Calls.json' -u '{AccountSid}:{AuthToken}'\",\n      \"language\": \"shell\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"If you're using cURL on Windows, be sure to change those single quotes to double quotes!\"\n}\n[/block]","excerpt":"list all calls associated with your account or filter results","slug":"list-calls","type":"endpoint","title":"List Calls"}

getList Calls

list all calls associated with your account or filter results

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

AccountSid:
required
string
Enter the Account Sid

Query Params

To:
string
Filter by a specific number calls were made to.
From:
string
Filter by a specific number calls were made from.
Status:
string
Filter by calls with the specified status. Allowed values are "ringing", "in-progress", "queued", "busy", "completed", "no-answer", and "failed".
StartTime:
string
Filter by all calls beginning on or from a certain date. Date range can be specified using inequalities like so: "StartTime>=YYYY-MM-DD".
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

[block:api-header] { "type": "basic", "title": "Response Parameters" } [/block] [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": "calls", "11-1": "Array containing calls." }, "cols": 2, "rows": 12 } [/block] Return parameters for calls are equal to those on ["View Call" API call](/v2/docs/view-call). [block:api-header] { "type": "basic", "title": "Example cURL" } [/block] [block:code] { "codes": [ { "code": "curl -X GET 'https://api.zang.io/v2/Accounts/{AccountSid}/Calls.json' -u '{AccountSid}:{AuthToken}'", "language": "shell" } ] } [/block] [block:callout] { "type": "info", "body": "If you're using cURL on Windows, be sure to change those single quotes to double quotes!" } [/block]