Live registration state of a number's SIP credentials
Reports whether a device is currently registered against each of the number's credentials, read from the registrar.
Separate from the credential list because it costs a round-trip per credential: managing credentials must not depend on the registrar being healthy, since revoking one is exactly what you do when it is misbehaving. Render the list first and let this fill in.
state is three-valued on purpose. unknown means the registrar could not be asked — a different fact from a device being off, and one that must not be presented as one. A revoked credential is always unknown: it has no account left to ask about.
Authorization
bearerAuth Long-lived ES256 JWT minted from the dashboard (https://app.sautikit.com/developers/api-keys). Signed by the
platform keyring. Carries workspace_id and scopes claims;
revoked via the platform deny-list.
In: header
Path Parameters
uuidResponse Body
application/json
application/json
curl -X GET "https://example.com/v1/numbers/497f6eca-6276-4993-bfeb-53cbbbba6f08/sip-credentials/registrations"{ "registrations": [ { "credential_id": "13c40afa-2996-4a0c-b2e9-68fba9462242", "state": "registered", "contact_ip": "string", "user_agent": "string", "expires_in": 0, "last_register": "string" } ]}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ], "resolution": "string", "reason": "invalid_characters", "suggested_e164": "+254727524723" }}Mint a SIP credential (reveal-once password) POST
Provisions a credential on the registrar and returns it with everything the device needs. The number the device may present as caller ID is derived from the number this credential belongs to and cannot be set by the caller.
Issue a device connection code POST
Mint a six-digit code that connects one app device (laptop or mobile) to this line. A SIP credential carrying an extension IS a person's line; the desk phone registers with its SIP password, while app devices attach with a code instead. The plaintext code is returned ONCE and cannot be retrieved later. It is also emailed to the address supplied, so an agent with no company email address can still be enrolled by reading the digits out. Single use, ten minutes, and issuing a new code revokes any outstanding one for the same line. Fails with `numbers.extension_required` when the line has no extension — a device enrolled onto an undialable line could never be reached.