{"_id":"5779d1b299b40b0e005abb49","category":{"_id":"5779d198aea88b0e00f63277","__v":0,"version":"57624356653c2d2200fec79c","project":"55c8cff571d7580d0063a5e5","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-07-04T03:01:44.996Z","from_sync":false,"order":8,"slug":"account-devices","title":"Account Devices"},"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"},"__v":10,"project":"55c8cff571d7580d0063a5e5","user":"55c8cf9471d7580d0063a5e4","updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-07-04T03:02:10.705Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"Your Phone.com account may have one or more physical handsets or other VoIP devices associated with it.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Generic VoIP Devices Only\",\n  \"body\": \"This service only shows generic VoIP devices at this time.  If you have any physical handsets or virtualized software-based devices, you will need to continue using the Control Panel to manage them.\"\n}\n[/block]\n## Supported Services\n* [List Devices](doc:list-account-devices) \n* [Create Device](doc:create-account-device)\n* [Get Device](doc:get-account-device) \n* [Replace Device](doc:replace-account-device) \n* [Delete Device](doc:delete-account-device) \n\n## Summary Object\nThe Device Summary Object is used to briefly represent a VoIP device. It consists of the ID and name only:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"Integer\",\n    \"0-2\": \"ID\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"User-supplied name, otherwise `NULL`\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 2345,\\n    \\\"name\\\": \\\"Front Desk Handset\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full Device Object includes the properties in the [Device Summary Object](#summary-object), along with the following:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`sip_authentication`\",\n    \"0-1\": \"A [SIP Authentication Properties Object](#section-sip-authentication-object). See below for details.  Read-only.\",\n    \"1-0\": \"`lines`\",\n    \"1-1\": \"Array of [Line Objects](#section-line-object) showing which extensions are attached to this device, and their assigned line numbers.  See below for details.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\nHere is an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": 2345,\\n    \\\"name\\\": \\\"Front Desk Handset\\\",\\n    \\\"sip_authentication\\\": {\\n        \\\"host\\\": \\\"sip.phone.com\\\",\\n        \\\"port\\\": 5060,\\n        \\\"username\\\": \\\"34345\\\",\\n        \\\"password\\\": \\\"zYG6bt%vy53wj2\\\",\\n    },\\n    \\\"lines\\\": [\\n        {\\n            \\\"line\\\": 1,\\n            \\\"extension\\\": {\\n                \\\"id\\\": 2242,\\n                \\\"name\\\": \\\"Bob's Desk (work)\\\"\\n            }\\n        },\\n        {\\n            \\\"line\\\": 2,\\n            \\\"extension\\\": {\\n                \\\"id\\\": 98292,\\n                \\\"name\\\": \\\"Bob's Desk (personal)\\\"\\n            }\\n        }\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## SIP Authentication Object\nThe SIP Authentication object has the following properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`host`\",\n    \"0-1\": \"Hostname\",\n    \"1-0\": \"`port`\",\n    \"1-1\": \"Port number\",\n    \"2-0\": \"`username`\",\n    \"2-1\": \"Username. This is the ID of the device.\",\n    \"3-0\": \"`password`\",\n    \"3-1\": \"Password.\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n## Line Object\nThis is an object showing an extension mapped to this device, and the line number it is mapped with.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`line`\",\n    \"0-1\": \"Line number\",\n    \"1-0\": \"`extension`\",\n    \"1-1\": \"[Extensions](doc:account-extensions) object that this line number is mapped to.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","excerpt":"","slug":"account-devices","type":"basic","title":"Devices"}
Your Phone.com account may have one or more physical handsets or other VoIP devices associated with it. [block:callout] { "type": "info", "title": "Generic VoIP Devices Only", "body": "This service only shows generic VoIP devices at this time. If you have any physical handsets or virtualized software-based devices, you will need to continue using the Control Panel to manage them." } [/block] ## Supported Services * [List Devices](doc:list-account-devices) * [Create Device](doc:create-account-device) * [Get Device](doc:get-account-device) * [Replace Device](doc:replace-account-device) * [Delete Device](doc:delete-account-device) ## Summary Object The Device Summary Object is used to briefly represent a VoIP device. It consists of the ID and name only: [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "Integer", "0-2": "ID", "1-0": "`name`", "1-1": "String", "1-2": "User-supplied name, otherwise `NULL`" }, "cols": 3, "rows": 2 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": 2345,\n \"name\": \"Front Desk Handset\"\n}", "language": "json" } ] } [/block] ## Full Object The Full Device Object includes the properties in the [Device Summary Object](#summary-object), along with the following: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`sip_authentication`", "0-1": "A [SIP Authentication Properties Object](#section-sip-authentication-object). See below for details. Read-only.", "1-0": "`lines`", "1-1": "Array of [Line Objects](#section-line-object) showing which extensions are attached to this device, and their assigned line numbers. See below for details." }, "cols": 2, "rows": 2 } [/block] Here is an example: [block:code] { "codes": [ { "code": "{\n \"id\": 2345,\n \"name\": \"Front Desk Handset\",\n \"sip_authentication\": {\n \"host\": \"sip.phone.com\",\n \"port\": 5060,\n \"username\": \"34345\",\n \"password\": \"zYG6bt%vy53wj2\",\n },\n \"lines\": [\n {\n \"line\": 1,\n \"extension\": {\n \"id\": 2242,\n \"name\": \"Bob's Desk (work)\"\n }\n },\n {\n \"line\": 2,\n \"extension\": {\n \"id\": 98292,\n \"name\": \"Bob's Desk (personal)\"\n }\n }\n ]\n}", "language": "json" } ] } [/block] ## SIP Authentication Object The SIP Authentication object has the following properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`host`", "0-1": "Hostname", "1-0": "`port`", "1-1": "Port number", "2-0": "`username`", "2-1": "Username. This is the ID of the device.", "3-0": "`password`", "3-1": "Password." }, "cols": 2, "rows": 4 } [/block] ## Line Object This is an object showing an extension mapped to this device, and the line number it is mapped with. [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`line`", "0-1": "Line number", "1-0": "`extension`", "1-1": "[Extensions](doc:account-extensions) object that this line number is mapped to." }, "cols": 2, "rows": 2 } [/block]