Jump to: navigation, search

List Devices

This operation allows you to list devices.

Requests

Devices can be listed in the following groupings:

  • All devices in a contact center
    • requires contact center admin role.
    • Path to be used: .../api/v2/devices
  • All devices assigned to a given user
    • Requires contact center admin role.
    • Path to be used: ...api/v2/users/{userid}/devices
  • All devices assigned to the current user
    • Requires contact center agent or login role.
    • Path to be used: ...api/v2/me/devices

List Device URIs or Devices

Request

The request can return the list of device URIs or the list of devices. To list uris:

GET .../devices

Response

{
   "statusCode":0,
   "uris":[
      "http://172.21.16.123:8080/cloud-web/api/v2/devices/0c754c1f-7a65-4a7f-9a2b-c5bb5c983653",
      "http://172.21.16.123:8080/cloud-web/api/v2/devices/406ff680-63c8-4eeb-8c23-f39f538059d1",
      "http://172.21.16.123:8080/cloud-web/api/v2/devices/d6186ffc-af3d-4925-835e-a9e8dad98051"
   ]
}

List Device Fields

Request

To list devices use the fields=* query parameter:

GET .../devices?fields=*

Response

{
   "statusCode":0,
   "devices":[
      {
         "id":"0c754c1f-7a65-4a7f-9a2b-c5bb5c983653",
         "deviceState":"Inactive",
         "phoneNumberUri":"http://172.21.16.123:8080/cloud-web/api/v2/phone-numbers/6658d431-9195-4184-a462-b8a6fd901de8",
         "telephonyNetwork":"Public",
         "model":"CloudDevice",
         "vendor":"Genesys",
         "phoneNumber":"+16509870000",
         "country":{
            "name":"United States",
            "code":"US",
            "callingCode":"1"
         },
         "location":"California",
         "e164Number":"+16509870000",
         "voiceServiceUri":"http://172.21.16.123:8080/cloud-web/api/v2/services/b40eb01e-199d-4db3-a91f-a0cf104ab2bf"
      },
      {
         "id":"1fd21300-303d-401f-9b4c-0d9c2801433e",
         "deviceState":"Inactive",
         "phoneNumberUri":"http://172.21.16.123:8080/cloud-web/api/v2/phone-numbers/812a7b7b-0e5b-4025-9443-79363b85773c",
         "telephonyNetwork":"Public",
         "model":"CloudDevice",
         "vendor":"Genesys",
         "phoneNumber":"3001",
         "country":{
            "name":"",
            "code":"",
            "callingCode":""
         },
         "e164Number":"3001",
         "voiceServiceUri":"http://172.21.16.123:8080/cloud-web/api/v2/services/b40eb01e-199d-4db3-a91f-a0cf104ab2bf"
      },
      ...
   ]
}

Feedback

Comment on this article:

blog comments powered by Disqus
This page was last modified on December 12, 2014, at 10:16.