Issue a device connection code
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.
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
uuiduuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v1/numbers/497f6eca-6276-4993-bfeb-53cbbbba6f08/sip-credentials/497f6eca-6276-4993-bfeb-53cbbbba6f08/connection-codes" \ -H "Content-Type: application/json" \ -d '{}'{ "code_id": "c6a02b7d-40f4-4982-9c97-607f4e20761a", "code": "048371", "extension": "1002", "expires_at": "2019-08-24T14:15:22Z", "email_sent": true}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.
Revoke an unredeemed connection code DELETE
Next Page