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"
}'
import requests
import json
url = "https://api.spkey.co/users/example_string/ChooseCallToOpenLock"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"targets": [
{
"kind": "lock",
"id": "example_string",
"digit": "example_string"
}
],
"kind": "lock",
"id": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://api.spkey.co/users/example_string/ChooseCallToOpenLock", {
method: "POST",
headers: {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_API_TOKEN (JWT)",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"targets": [
{
"kind": "lock",
"id": "example_string",
"digit": "example_string"
}
],
"kind": "lock",
"id": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"targets": [
{
"kind": "lock",
"id": "example_string",
"digit": "example_string"
}
],
"kind": "lock",
"id": "example_string"
}`)
req, err := http.NewRequest("POST", "https://api.spkey.co/users/example_string/ChooseCallToOpenLock", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN (JWT)")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.spkey.co/users/example_string/ChooseCallToOpenLock')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN (JWT)'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"targets": [
{
"kind": "lock",
"id": "example_string",
"digit": "example_string"
}
],
"kind": "lock",
"id": "example_string"
}'
response = http.request(request)
puts response.body
{
"success": true,
"aggregateId": "example_string",
"version": 3.14,
"event": "null"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Forbidden",
"message": "You don't have permission to access this resource",
"code": 403
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
{
"error": "Service Unavailable",
"message": "The service is temporarily unavailable. Please try again later",
"code": 503
}
/users/{id}/ChooseCallToOpenLockTarget server for requests. Edit to use your own host.
JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API key for B2B organization access. Provided during organization onboarding.
User ID
The media type of the request body
Every lock or Matter device to choose, each with the digit that picks it; replaces the whole choice
Deprecated, use targets: the one target's list, lock or matter (with id; on digit 1)
Deprecated, use targets: the one target's id (with kind)
Request Preview
Response
Response will appear here after sending the request
Authentication
Bearer token (JWT). JWT token from SmartphoneKey authentication. Identifies the B2C user or B2B service.
API Key for authentication. API key for B2B organization access. Provided during organization onboarding.
Path Parameters
User ID
Body
Every lock or Matter device to choose, each with the digit that picks it; replaces the whole choice
Deprecated, use targets: the one target's list, lock or matter (with id; on digit 1)
lockmatterDeprecated, use targets: the one target's id (with kind)