{"_id":"58a6a1c0a51cb62f00895152","parentDoc":null,"version":{"_id":"57624356653c2d2200fec79c","__v":20,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"user":"56f99ab84d2b4f3400edb636","__v":1,"category":{"_id":"58a68ebf3239fa0f00857619","project":"55c8cff571d7580d0063a5e5","__v":0,"version":"57624356653c2d2200fec79c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-02-17T05:48:47.118Z","from_sync":false,"order":9,"slug":"account-listeners","title":"Account Event Listeners"},"project":"55c8cff571d7580d0063a5e5","updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-02-17T07:09:52.300Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","code":"{\n    \"filters\": {},\n    \"sort\": {\n        \"id\": \"desc\"\n    },\n    \"total\": 3, \n    \"offset\": 0,\n    \"limit\": 25,\n    \"items\": [\n        {\n            \"id\": 13,\n            \"voip_id\": 349034,\n            \"type\": \"callback\",\n            \"event_type\": \"call.update\",\n            \"callbacks\": [\n                {\n                    \"url\": \"https://requestb.in/10eb123\",\n                    \"role\": \"main\",\n                    \"verb\": \"POST\",\n                    \"username\": \"123\",\n                    \"password\": \"************\",\n                    \"timeout\": 10\n                }\n            ],\n            \"updated_at\": 1487312006,\n            \"created_at\": 1487311677,\n        },\n        {\n            \"id\": 12,\n            \"type\": \"callback\",\n            \"event_type\": \"call.new\",\n            \"callbacks\": [\n                {\n                    \"url\": \"https://requestb.in/10eb1221\",\n                    \"role\": \"main\",\n                    \"verb\": \"POST\",\n                    \"username\": \"123\",\n                    \"password\": \"************\",\n                    \"timeout\": 10\n                }\n            ],\n            \"updated_at\": 1487312006,\n            \"created_at\": 1487311677,\n        },\n        {\n            \"id\": 11,\n            \"voip_id\": 349034,\n            \"type\": \"callback\",\n            \"event_type\": \"call.complete\",\n            \"callbacks\": [\n                {\n                    \"url\": \"https://requestb.in/10eb1221\",\n                    \"role\": \"main\",\n                    \"verb\": \"POST\",\n                    \"username\": \"123\",\n                    \"password\": \"************\",\n                    \"timeout\": 10\n                }\n            ],\n            \"updated_at\": 1487311652,\n            \"created_at\": 1487311652,\n        },\n    ],\n}","language":"json"}]},"settings":"","examples":{"codes":[{"code":"<?php\n$client = new \\GuzzleHttp\\Client([\n    'base_uri' => 'https://api.phone.com/v4/',\n    'headers' => ['Authorization' => \"Bearer $token\"]\n]);\n$response = $client->get('accounts/123/listeners');","language":"php"}]},"method":"get","auth":"required","params":[{"_id":"56fae76b4787442b008db3c0","ref":"","in":"path","required":false,"desc":"Account ID","default":"","type":"int","name":"account_id"},{"_id":"573a3fdb17422532001d3451","ref":"","in":"query","required":false,"desc":"ID filter","default":"","type":"array_string","name":"filters[id]"},{"_id":"573a42fe09988e0e000dd6ae","ref":"","in":"query","required":false,"desc":"Results to skip","default":"","type":"int","name":"offset"},{"_id":"573c6c32ee2b3b2200422b6c","ref":"","in":"query","required":false,"desc":"Field set","default":"all","type":"string","name":"fields"}],"url":"/accounts/:account_id/listeners"},"isReference":false,"order":1,"body":"See [Account Listeners](doc:account-listeners) for more info on the properties.","excerpt":"Get a list of listeners for an account.  See [Account Listeners](doc:account-listeners) for more info on the properties.\n\nNote: This API is for users with Account Owner scope access token.  Users with Extension User scope token should invoke the Extension level List Listeners API with the following definition:\n\nGET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners","slug":"list-account-listeners","type":"endpoint","title":"List Listeners"}

getList Listeners

Get a list of listeners for an account. See [Account Listeners](doc:account-listeners) for more info on the properties. Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Extension level List Listeners API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/listeners

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
integer
Account ID

Query Params

filters[id]:
array of strings
ID filter
offset:
integer
Results to skip
fields:
stringall
Field set

Examples


Result Format


Documentation

See [Account Listeners](doc:account-listeners) for more info on the properties.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}