UserChoose which locks or Matter devices open when the user calls the call-to-open number, each on its own digit

Choose which locks or Matter devices open when the user calls the call-to-open number, each on its own digit

Stores the user's call-to-open choice: targets, 1 to 10 of {kind, id, digit}, each on its own digit 0-9, so a call can let the caller pick one by its digit. A target is {kind: 'lock', id} for an active entry of the user's accessible locks (any access level), or {kind: 'matter', id} for a linked device with deviceType matter. A target not in those lists is refused with 400. The body {kind, id} (deprecated) chooses that one target on digit 1. A user acts only for themselves; any partner API key may act for any user. Choosing the same targets on the same digits again as the same caller changes nothing (event: null); a new choice replaces the previous one whole, last writer wins. A choice of several targets opens nothing yet: a call is refused until it asks the caller for a digit. A preference, not an access grant: when a call from the user's own phone number reaches a dial-in number (listed by telephony-api's public GET /dial-in-numbers; show the one of the user's phone country, else any), the choice is checked again against the user's lists and then opened. A matter choice opens the lock whose uuid is the device id, and nothing when there is none. Caller ID can be spoofed, especially outside the US and Canada: not for high-security doors.

curl -X POST "https://api.spkey.co/users/example_string/ChooseCallToOpenLock" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
  "targets": [
    {
      "kind": "lock",
      "id": "example_string",
      "digit": "example_string"
    }
  ],
  "kind": "lock",
  "id": "example_string"
}'
{
  "success": true,
  "aggregateId": "example_string",
  "version": 3.14,
  "event": "null"
}
POST
/users/{id}/ChooseCallToOpenLock
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token (JWT)
Bearer Tokenstring
Required

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key (header: X-API-Key)
X-API-Keystring
Required

API key for B2B organization access. Provided during organization onboarding.

API key for B2B organization access. Provided during organization onboarding.
Content-Typestring
Required

The media type of the request body

Options: application/json
targetsarray

Every lock or Matter device to choose, each with the digit that picks it; replaces the whole choice

kindstring

Deprecated, use targets: the one target's list, lock or matter (with id; on digit 1)

Options: lock, matter
idstring

Deprecated, use targets: the one target's id (with kind)

Pattern: ^[A-Za-z0-9:_.-]{1,128}$
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.

header
X-API-Keystring
Required

API Key for authentication. API key for B2B organization access. Provided during organization onboarding.

Path Parameters

Body

application/json
targetsarray

Every lock or Matter device to choose, each with the digit that picks it; replaces the whole choice

kindstring

Deprecated, use targets: the one target's list, lock or matter (with id; on digit 1)

Allowed values:lockmatter
idstring

Deprecated, use targets: the one target's id (with kind)

Responses

successboolean
Required
aggregateIdstring
Required
versionnumber
Required
eventobject,null
Required