Skip to main content

SipTrunkAiSetupRequest

Same AI carrier-wizard setup used in the app. password is required for registration/digest. deviceConcurrencyLimit and devicePoolKey are optional structured controls; remaining connection details may be supplied as freeform JSON and are mapped by SipSandwichAI Custom LLM.

authenticationModestring

Possible values: [registration, digest, ip]

Default value: registration
retellImportIdentifierModestring

Possible values: [private, provider_address]

Default value: provider_address
providerSourceIpsstring[]

Required for IP authentication.

deviceConcurrencyLimitinteger | nullnullable

Explicit optional per-extension/device call limit. This structured value overrides AI interpretation.

Possible values: >= 1 and <= 1000

Default value: null
devicePoolKeystring | nullnullable

Shared pool key for interchangeable devices. Requires deviceConcurrencyLimit.

Possible values: Value must match regular expression ^[A-Za-z0-9][A-Za-z0-9._:-]{0,79}$

Default value: null
waitSecondsinteger

How long this request waits for a connected trunk before returning 202. Poll GET /api/v1/sip/trunks/ai-setup/{id} until status is connected or failed. Use 0 to return the job immediately.

Possible values: >= 0 and <= 180

Default value: 90
notesstring

Optional freeform carrier sheet or paste, same as the wizard notes field.

usernamestring
registrarHoststring
hoststring
domainstring
property name*any

Same AI carrier-wizard setup used in the app. password is required for registration/digest. deviceConcurrencyLimit and devicePoolKey are optional structured controls; remaining connection details may be supplied as freeform JSON and are mapped by SipSandwichAI Custom LLM.

SipTrunkAiSetupRequest
{
"authenticationMode": "registration",
"retellImportIdentifierMode": "provider_address",
"providerSourceIps": [
"string"
],
"deviceConcurrencyLimit": null,
"devicePoolKey": null,
"waitSeconds": 90,
"notes": "string",
"username": "string",
"registrarHost": "string",
"host": "string",
"domain": "string"
}