create_sip_credential
Mint a new SIP credential for a number so a device can register. The registrar generates the username and password and returns them along with the server, port, transport and realm the device needs. Many credentials per number are expected — one per person once an extension is set, or one per device without — up to the number's limit; label each one so it can be told apart later. Pass client_id to carry your own caller reference (e.g. a member id) onto outbound calls from the device, and extension to turn this credential into a person's line with a 4-digit internal number the workspace's other devices can dial — internal calls connect directly and are not charged, and app devices can then be attached to the same line with a connection code. Fails with numbers.credential_limit_reached when the number is full (revoke one to free a slot), numbers.extension_taken when another credential already uses that extension, numbers.extension_invalid when it is not exactly 4 digits, and numbers.sip_provisioning_failed when the registrar cannot be reached, in which case nothing is created.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"number_id": "<number_id>"
},
"name": "create_sip_credential"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| label | No | human label naming the device this credential is for, e.g. 'Reception desk phone' or 'Odoo prod' | |
| purpose | No | Required on tools that read data or reports; recommended on every tool. One sentence: what you are doing and why (for example "finding this caller's open ticket to answer them"). Building a report, dashboard, analytics or an export is a SautiDesk Pro feature done by the report tools, not by pulling records. | |
| client_id | No | optional free-text caller reference the registrar substitutes for the caller number on outbound calls from this device — use it to carry your own identifier, such as a member id. Not a phone number; the number the device may present is derived server-side. | |
| extension | No | optional internal extension — exactly 4 digits, unique across the workspace. The workspace's other registered devices reach this one by dialling it, and those calls connect directly between the devices and are not charged. Never reaches a carrier. | |
| number_id | Yes | tenant number UUID to mint a credential for |