Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Speakers

Retrieving a list of speakers is possible with this endpoint.
It is important to note that after using the pageSize parameter, the "totalSize" in the response represents the total number of available speakers, not the number of speakers resulting from the query string.

get/speakers

Query parameters

includestring[]
sortstring[]

Sort by timestamp

pageTokenstring

Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.

pageSizeinteger

The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.

locationId__instring[]

List of Location IDs to filter on that is comma separated.

[
  "2428fda3-389f-48ce-b062-85875dd6b2e2"
]
bridgeId__instring[]

List of Bridge IDs to filter on that is comma separated.

[
  "00001106",
  "00001107"
]
tags__containsstring[]

Only return speakers that have all tags in the list, separated by commas.

[
  "string"
]
tags__anystring[]

Only return speakers that have one or more of the tags in the list, separated by commas.

[
  "string"
]
name__containsstring

Filter to get the locations whose the name contains the provided substring. The lookup is exact and case insensitive

name__instring[]

Filter to get the speakers whose name is on the provided list. The lookup is exact and case insensitive.

namestring

Filter to get the speakers with the specified name. The lookup is exact and case insensitive.

id__instring[]

Filter to get the speakers whose id is on the provided list. The lookup is exact and case insensitive.

id__containsstring

Filter to get the speakers whose the id contains the provided substring. The lookup is exact and case insensitive

qstring
Example:entrance

Text search that is applied to multiple fields. The fields being searched are defined by the backend and can be changed without warning. Example fields being searched: id, accountId, name, bridgeId, locationId, notes, tags, locationSummary.name.

qRelevance__gtenumber float
Example:0.5

Sets the current minimum similarity threshold that is used with the q parameter. The threshold must be between 0 and 1 (float, default is 0.5).

status__inDeviceConnectionStatus[]

Filter to get the devices with the specified status. The lookup is exact and case insensitive.

status__neDeviceConnectionStatus[]

Filter to get the devices with status that is not equal to the provided value. The lookup is exact and case insensitive.

Response

OK

nextPageTokenstring nullable required

Token to retrieve the next page. The value of this token is passed into the field pageToken. This value can be null if there is no next page.

prevPageTokenstring nullable required

Token to retrieve the previous page. The value of this token is passed into the field pageToken. This value can be null of there is no previous page.

totalSizeinteger nullable

The number of resource entries being returned from the result set. This can be omitted if the API endpoint does not have total size information.

Example response

{
  "results": [
    {
      "name": "My new device",
      "bridgeId": "1000f60d",
      "locationId": "2428fda3-389f-48ce-b062-85875dd6b2e2",
      "statusV2": {
        "cloudConnectionStatus": "connected",
        "edgeReportedDeviceStatus": "operational",
        "deviceSpecificError": "generalDeviceError"
      },
      "notes": "Painted black to better blend with its environment.",
      "bridgeSummary": {
        "id": "1000f60d",
        "name": "Front Lobby Bridge"
      },
      "timeZone": {
        "zone": "America/Chicago"
      },
      "devicePosition": {
        "latitude": 52.3074013,
        "longitude": 4.9459903,
        "azimuth": 7.419435,
        "rangeInMeters": 50.4,
        "floor": 50,
        "fieldOfView": 100
      },
      "networkInfo": {
        "ipUsedByBridge": "10.143.55.140",
        "adapters": [
          {
            "macAddress": "8A:D4:AD:09:DF:91",
            "ipAddress": "10.143.55.140"
          }
        ]
      },
      "deviceInfo": {
        "make": "Axis communications",
        "model": "C1310-E Network Horn Speaker",
        "guid": "ddfa5b34-5d04-431e-8287-110fe87edf71"
      },
      "visibleByBridges": [
        "1000f60d"
      ],
      "settings": {
        "sipPort": 5060
      },
      "qRelevance": 0.5
    }
  ]
}