Chime information & management

Get all chimes

Get detailed information about all chimes

get/v1/chimes

Request

Response

Success response

idstring required

The primary key of chime

modelKey'chime' required

The model key of the chime

state'CONNECTED' | 'CONNECTING' | 'DISCONNECTED' required

Connection state of the device.

namestring required

The name of the device.

macstring required

The primary MAC address of the device.

cameraIdsCameraId[] required

The list of (doorbell-only) cameras which this chime is paired to.

Example response

[
  {
    "id": "66d025b301ebc903e80003ea",
    "state": "CONNECTED",
    "name": "Front Door",
    "mac": "24A43C3DFEB9",
    "cameraIds": [
      "66d025b301ebc903e80003ea"
    ],
    "ringSettings": [
      {
        "cameraId": "66d025b301ebc903e80003ea",
        "repeatTimes": 3,
        "ringtoneId": "66d025b301ebc903e80003ea",
        "volume": 100
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.