Skip to content
Linq Copy agent prompt

Sip Profiles

SIP configuration

Your Linq representative provides the signaling and media IP ranges and ports to allow through your firewall during onboarding.

Set primary_uri to your endpoint as scheme + host — sips: for TLS or sip: for UDP, with no user part (we add it). Each call arrives at your endpoint as:

sip:<called-number>@<your-host>

so you can route on the dialed number. The caller’s number is in the From header in E.164.

Create a SIP profile
client.sipProfiles.create(SipProfileCreateParams { name, primary_uri, backup_uri } body, RequestOptionsoptions?): SipProfile { id, assigned_number_count, created_at, 5 more }
POST/v3/sip-profiles
List SIP profiles
client.sipProfiles.list(RequestOptionsoptions?): SipProfileListResponse { sip_profiles }
GET/v3/sip-profiles
Get a SIP profile by ID
client.sipProfiles.retrieve(stringsipProfileID, RequestOptionsoptions?): SipProfile { id, assigned_number_count, created_at, 5 more }
GET/v3/sip-profiles/{sipProfileId}
Update a SIP profile
client.sipProfiles.update(stringsipProfileID, SipProfileUpdateParams { backup_uri, name, primary_uri } body, RequestOptionsoptions?): SipProfile { id, assigned_number_count, created_at, 5 more }
PUT/v3/sip-profiles/{sipProfileId}
Delete a SIP profile
client.sipProfiles.delete(stringsipProfileID, RequestOptionsoptions?): void
DELETE/v3/sip-profiles/{sipProfileId}
Assign or clear a phone number's SIP profile
client.sipProfiles.assign(stringphoneNumber, SipProfileAssignParams { sip_profile_id } body, RequestOptionsoptions?): SipProfileAssignResponse { phone_number, sip_profile_id }
PUT/v3/phone-numbers/{phoneNumber}/sip-profile
ModelsExpand Collapse
SipProfile { id, assigned_number_count, created_at, 5 more }
id: string

Unique identifier for the SIP profile

assigned_number_count: number

How many phone numbers reference this profile

created_at: string
formatdate-time
name: string

Human-readable name

primary_uri: string

Your SIP endpoint as scheme + host (sip: UDP / sips: TLS); no user part — we set it to the called number on each call.

updated_at: string
formatdate-time
version: number

Monotonic version, incremented on each update

backup_uri?: string | null

Optional failover SIP URI. Null when unset.

SipProfileListResponse { sip_profiles }
sip_profiles: Array<SipProfile { id, assigned_number_count, created_at, 5 more } >

The partner’s SIP profiles

id: string

Unique identifier for the SIP profile

assigned_number_count: number

How many phone numbers reference this profile

created_at: string
formatdate-time
name: string

Human-readable name

primary_uri: string

Your SIP endpoint as scheme + host (sip: UDP / sips: TLS); no user part — we set it to the called number on each call.

updated_at: string
formatdate-time
version: number

Monotonic version, incremented on each update

backup_uri?: string | null

Optional failover SIP URI. Null when unset.

SipProfileAssignResponse { phone_number, sip_profile_id }
phone_number: string

The phone number whose assignment changed

sip_profile_id: string | null

The assigned SIP profile id, or null when cleared