Create trunk credential
create_trunk_credentialCreate a SIP digest credential for trunk authentication on a Vobiz account, enabling dynamic-IP PBXs, remote sites, or voice agents to register; returns credential ID and SIP realm.
Instructions
Create a SIP digest credential (username and password) on this Vobiz account for trunk authentication, for dynamic-IP PBXs, remote sites or voice agents. Attach it to a trunk afterwards with update_sip_trunk (credential_uuid); for static-IP peers use add_ip_acl_entry instead. The username is permanent; rotate the password with update_trunk_credential. Returns the credential id and the realm the SIP client must present. Gated by VOBIZ_ENABLE_PROVISIONING and confirm: true. The password is write-only and never returned; every call creates another credential, so a retry after a timeout should first check list_trunk_credentials.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| confirm | Yes | Must be true, set only after the user explicitly approved: creating this trunk credential. | |
| password | Yes | SECRET: the trunk credential's SIP password (8+ characters; 12+ with mixed case, digits and symbols recommended). It is sent to Vobiz once and never shown again. | |
| username | Yes | SIP username, 3-64 letters, digits or _, unique on the account and permanent. Letters and digits are safest. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ok | No | True on success. On a failure the result is isError with ok: false plus `error` (kind), `message`, `retryable` and sometimes `http_status`. | |
| note | No | How the client authenticates and that the password is never shown again. | |
| created | No | True when the record was created by this call. | |
| credential | No | The credential as Vobiz returned it, password redacted; realm is what the SIP client presents. | |
| http_status | No | HTTP status Vobiz answered with. | |
| credential_id | No | UUID of the new credential: use it as credential_uuid on a trunk. Null if Vobiz did not return one. |