{"_id":"5b0c645def07e3000324f4fc","project":"55c8cff571d7580d0063a5e5","version":{"_id":"57624356653c2d2200fec79c","__v":22,"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","5b0c16f2be9fcb0003e28222","5ba8fd1a4c8c220003a08f0f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"category":{"_id":"5b0c16f2be9fcb0003e28222","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2018-05-28T14:49:22.366Z","from_sync":false,"order":10,"slug":"events","title":"Account Events"},"user":"56f99ab84d2b4f3400edb636","githubsync":"","__v":5,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2018-05-28T20:19:41.899Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"get","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/events');","language":"php","name":null}]},"settings":"","results":{"codes":[{"language":"json","code":"{\n    \"filters\": {},\n    \"sort\": {\n        \"id\": \"desc\"\n    },\n    \"total\": 53383,\n    \"offset\": 0,\n    \"limit\": 2,\n    \"items\": [{\n        \"id\": 1766701,\n        \"voip_id\": 1143257,\n        \"type\": \"call.log\",\n        \"timestamp\": \"1527531154.0000\",\n        \"extension\": null,\n        \"payload\": {\n          \"call_id\": \"dc1122fe-6c6f-4390-b0c5-f7036d4ead85\"\n        }\n    }\n    {\n        \"id\": 1766700,\n        \"voip_id\": 117,\n        \"type\": \"call.complete\",\n        \"timestamp\": \"1527529757.0000\",\n        \"extension\": null,\n        \"payload\": {\n          \"call_id\": \"dc1122fe-6c6f-4390-b0c5-f7036d4ead85\",\n          \"direction\": \"in\",\n          \"state\": \"completed\",\n          \"completion_state\": \"success\",\n          \"from_did\": \"+19047684857\",\n          \"to_did\": \"+18003059084\"\n        }\n    }]\n}","name":"","status":200}]},"auth":"required","params":[{"_id":"56fae76b4787442b008db3c0","ref":"","in":"path","required":true,"desc":"Account ID","default":"","type":"int","name":"account_id"},{"_id":"573a3fdb17422532001d3451","ref":"","in":"query","required":false,"desc":"ID filter","default":"","type":"string","name":"filters[id]"},{"_id":"5b0c6941b7985e0003070bfb","ref":"","in":"query","required":false,"desc":"Event type filter (call.new, call.update, call.complete, call.log, sms.in and sms.out)","default":"","type":"string","name":"filters[type]"},{"_id":"5b0c6941b7985e0003070bfa","ref":"","in":"query","required":false,"desc":"Filter event by creation time","default":"","type":"string","name":"filters[created_at]"},{"_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 events for an account.  See [Account Events](doc:account-events) 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 Events API with the following definition:\n\nGET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/events","slug":"list-account-events","type":"endpoint","title":"List Events"}

getList Events

Get a list of events for an account. See [Account Events](doc:account-events) 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 Events API with the following definition: GET https://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/events

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
required
integer
Account ID

Query Params

filters[id]:
string
ID filter
filters[type]:
string
Event type filter (call.new, call.update, call.complete, call.log, sms.in and sms.out)
filters[created_at]:
string
Filter event by creation time
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 }}