Mint a SIP credential (reveal-once password)
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.
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
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/numbers/497f6eca-6276-4993-bfeb-53cbbbba6f08/sip-credentials" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "label": "string", "username": "string", "password": "string", "host": "string", "port": 0, "transport": "udp", "realm": "string", "client_id": "string", "extension": "string", "ws_url": "string", "display_once": true, "created_at": "2019-08-24T14:15:22Z"}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ] }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ] }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ] }}{ "error": { "code": "validation.bad_request", "message": "string", "request_id": "string", "details": [ "string" ] }}List credentials for a number GET
Previous Page
Live registration state of a number's SIP credentials GET
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.