Devices

A Device is a hardware phone that is linked to an account and can be remotely configured

• GET/provisioning/device

  Gets all of the active devices on an account

  Back to top

  Request Details

  Response Details

  Request Details

  This command has no URL/Query String parameters

  Response Details

  200 Response

  {
      "result" : [
          {
              "accounts" : [
                  {
                      "account" : 1,
                      "user" : "0dbf7ab1-c87b-4492-a1d2-5afdc9f44ff4"
                  }
              ],
              "can_push_firmware" : true,
              "created_on" : "2023-06-04",
              "keep_alive_time" : 20,
              "mac_address" : "0123456789AB",
              "name" : "Pete's Grandstream",
              "phone_book_uuid" : "45afca24-70f4-48f0-a5f8-708d47a6785c",
              "serial_number" : "BC0987654321",
              "updated_on" : "2023-06-04",
              "use_keep_alive" : true,
              "use_tcp" : true,
              "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

• GET/provisioning/device/{uuid}

  Gets a specific device on an account

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • uuid

    • String

    • True

    The UUID of the Device to be queried

  Response Details

  200 Response

  {
      "result" : {
          "accounts" : [
              {
                  "account" : 1,
                  "user" : "0dbf7ab1-c87b-4492-a1d2-5afdc9f44ff4"
              }
          ],
          "can_push_firmware" : true,
          "created_on" : "2023-06-04",
          "keep_alive_time" : 20,
          "mac_address" : "0123456789AB",
          "name" : "Pete's Grandstream",
          "phone_book_uuid" : "45afca24-70f4-48f0-a5f8-708d47a6785c",
          "serial_number" : "BC0987654321",
          "updated_on" : "2023-06-04",
          "use_keep_alive" : true,
          "use_tcp" : true,
          "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }