{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/accounts/:account_id/devices","auth":"required","examples":{"codes":[{"language":"php","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/devices');"}]},"method":"get","params":[{"name":"account_id","type":"int","default":"","desc":"Account ID","required":true,"in":"path","ref":"","_id":"56f9c28a5e9c512200d91b53"},{"name":"filters[id]","type":"array_string","default":"","desc":"ID filter.  Reference to this [link](doc:list-inputs#section-syntax-of-filters) for syntax of filters.","required":false,"in":"query","ref":"","_id":"56f9c28a5e9c512200d91b52"},{"name":"filters[name]","type":"array_string","default":"","desc":"Name filter","required":false,"in":"query","ref":"","_id":"577f21d6a326490e000b74a0"},{"name":"sort[id]","type":"string","default":"","desc":"ID sorting","required":false,"in":"query","ref":"","_id":"56f9c28a5e9c512200d91b51"},{"name":"sort[name]","type":"string","default":"","desc":"Name sorting","required":false,"in":"query","ref":"","_id":"577f21d6a326490e000b749f"},{"name":"limit","type":"int","default":"","desc":"Max results","required":false,"in":"query","ref":"","_id":"56f9c28a5e9c512200d91b50"},{"name":"offset","type":"int","default":"","desc":"Results to skip","required":false,"in":"query","ref":"","_id":"56f9c28a5e9c512200d91b4f"},{"name":"fields","type":"string","default":"all","desc":"Field set","required":false,"in":"query","ref":"","_id":"573c6bf9f09c292200b398a5"}],"results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n    \"filters\": {},\n    \"sort\": {\n        \"extension\": \"asc\"\n    },\n    \"total\": 2,\n    \"offset\": 0,\n    \"limit\": 10,\n    \"items\": [\n        {\n            \"id\": 24234,\n            \"name\": null,\n            \"type\": \"iphone\",\n            \"sip_authentication\": {\n                \"host\": \"sip.phone.com\",\n                \"port\": 5060,\n                \"username\": \"24234\",\n                \"password\": \"zYG6bt%vy53wj2\"\n            },\n            \"lines\": [\n                {\n                    \"line\": 1,\n                    \"extension\": {\n                        \"id\": 8928,\n                        \"name\": \"Jane Philips\",\n                        \"extension\": 2\n                    }\n                }\n            ]\n        }, \n        {\n            \"id\": 24294,\n            \"name\": \"Location #566\",\n            \"type\": \"communicator\",\n            \"sip_authentication\": {\n                \"host\": \"sip.phone.com\",\n                \"port\": 5060,\n                \"username\": \"24294\",\n                \"password\": \"os:::at:::fbtWvy71wP8\"\n            },\n            \"lines\": [\n                {\n                    \"line\": 1,\n                    \"extension\": {\n                        \"id\": 6671,\n                        \"name\": \"Marti Jackson\",\n                        \"extension\": 3\n                    }\n                }\n            ]\n        }\n    ]\n}"}]},"settings":""},"next":{"description":"","pages":[]},"title":"List Devices","type":"endpoint","slug":"list-account-devices","excerpt":"Get a list of VoIP devices associated with your account.  See [Devices](doc:account-devices) for more detail.","body":"","updates":[],"order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5779d20688c9800e00518fe0","createdAt":"2016-07-04T03:03:34.821Z","githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Account Devices","slug":"account-devices","order":8,"from_sync":false,"reference":true,"_id":"5779d198aea88b0e00f63277","__v":0,"version":"57624356653c2d2200fec79c","createdAt":"2016-07-04T03:01:44.996Z","project":"55c8cff571d7580d0063a5e5"},"editedParams2":true,"editedParams":true,"parentDoc":null,"__v":4,"user":"55c8cf9471d7580d0063a5e4","version":{"version":"4","version_clean":"4.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"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","5ede526e75bc22005d0adecc"],"_id":"57624356653c2d2200fec79c","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","__v":23,"project":"55c8cff571d7580d0063a5e5"},"project":"55c8cff571d7580d0063a5e5"}

getList Devices

Get a list of VoIP devices associated with your account. See [Devices](doc:account-devices) for more detail.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

account_id:
required
integer
Account ID

Query Params

filters[id]:
array of strings
ID filter. Reference to this [link](doc:list-inputs#section-syntax-of-filters) for syntax of filters.
filters[name]:
array of strings
Name filter
sort[id]:
string
ID sorting
sort[name]:
string
Name sorting
limit:
integer
Max results
offset:
integer
Results to skip
fields:
stringall
Field set

Examples


Result Format


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 }}