Skip to main content
PUT
Save SIP Config

Authorizations

Authorization
string
header
required

Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.

Path Parameters

agent_id
string
required

Tuner's numeric agent ID, or your Agent ID from Agent Settings > Agent Connection. Digits-only values are read as the numeric ID.

workspace_id
integer
required

Workspace ID. Find this in Workspace > General Settings.

Body

application/json
sip_url
string
required

SIP URI, e.g. sip:user@host:5060

Required string length: 1 - 500
sip_username
string | null

Username for authenticating to the SIP trunk, up to 200 characters.

Maximum string length: 200
sip_password
string | null

Password for authenticating to the SIP trunk, up to 500 characters. Leave it blank or omit it to keep the saved password. It is never returned.

Maximum string length: 500

Response

Successful Response

id
integer
required

SIP configuration ID.

settings_id
integer
required

ID of the agent settings the configuration belongs to.

workspace_id
integer
required

ID of the workspace the configuration belongs to.

sip_url
string
required

SIP URI of the trunk, e.g. sip:user@host:5060.

sip_username
string | null
required

Username used to authenticate to the SIP trunk.

sip_password_set
boolean
required

Whether a SIP password is saved. The password itself is never returned.

Example:

true

is_sip_verified
boolean
required

Whether Tuner's connectivity check against the trunk succeeded.

created_at
string<date-time>
required

When the configuration was created.

updated_at
string<date-time>
required

When the configuration was last updated.