VOXO Docs

Devices

GEThttps://api.voxo.co/v2/devices?tenantId={tenantId}

List Devices

List all devices for the provided account id

Parameters

  • Name
    tenantId*
    Type
    integer
    Description
    1234

Header

  • Name
    Authorization*
    Type
    string
    Description

    Bearer {accessToken}

  • Name
    Content-Type*
    Type
    string
    Description
    application/json

Request

GET
/devices?tenantId=1234
curl --location -g --request GET 'https://api.voxo.co/v2/devices?tenantId=1234' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {accessToken}'

Response

[
  {
    "id": 14137,
    "name": "Richard Cheese",
    "mac": "XX:XX:XX:XX:XX:XX",
    "tenantId": 1234,
    "phLine1ExId": 1234,
    "extPeer": "2134-durst",
    "phoneModelId": 69,
    "deviceModel": "Grandstream",
    "tenantName": "Art",
    "tenantCode": "durst",
    "userAgent": "Grandstream HT812 1.0.11.6"
  },
  ...
],
GEThttps://api.voxo.co/v2/devices/:deviceId

Get Device By ID

Retrieve the device details for the provided device id

Header

  • Name
    Content-Type*
    Type
    string
    Description
    application/json
  • Name
    Authorization*
    Type
    string
    Description
    Bearer {accessToken}

Request

GET
/devices/14137
curl --location -g --request GET 'https://api.voxo.co/v2/devices/14137' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {accessToken}'

Response

{
  "id": 14137,
  "name": "Richard Cheese",
  "mac": "XX:XX:XX:XX:XX:XX",
  "tenantId": 1234,
  "phLine1ExId": 1234,
  "extPeer": "2134-durst",
  "phoneModelId": 69,
  "deviceModel": "Grandstream",
  "tenantName": "Art",
  "tenantCode": "durst",
  "userAgent": "Grandstream HT812 1.0.11.6"
}
GEThttps://api.voxo.co/v2/devices/search?mac={deviceMac}&?name={deviceName}

Search Devices

Search devices across all accounts by mac and/or name

Parameters

Either name of mac search is required. MAC can be partial, but must follow the general format shown

  • Name
    name
    Type
    integer
    Description
    ayed
  • Name
    mac
    Type
    string (MAC)
    Description
    XX:XX:XX:XX:XX:XX

Header

  • Name
    Authorization*
    Type
    string
    Description

    Bearer {accessToken}

  • Name
    Content-Type*
    Type
    string
    Description
    application/json

Request

GET
/devices/search?mac=5D:0C
curl --location -g --request GET 'https://api.voxo.co/v2/devices/search?mac=5D:0C' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {accessToken}'

Response

[
  {
    "id": 14137,
    "name": "Richard Cheese",
    "mac": "XX:XX:XX:XX:5D:0C",
    "tenantId": 1234,
    "phLine1ExId": 1234,
    "extPeer": "2134-durst",
    "phoneModelId": 69,
    "deviceModel": "Grandstream",
    "tenantName": "Art",
    "tenantCode": "durst",
    "userAgent": "Grandstream HT812 1.0.11.6"
  },
...
],