Class SipClient

Client to access Egress APIs

Hierarchy

ServiceBase
- SipClient

Constructors

constructor

new SipClient(host: string, apiKey?: string, secret?: string): SipClient
Parameters
- host: string
  hostname including protocol. i.e. 'https://.livekit.cloud'
- OptionalapiKey: string
  API Key, can be set in env var LIVEKIT_API_KEY
- Optionalsecret: string
  API Secret, can be set in env var LIVEKIT_API_SECRET
Returns SipClient
Overrides ServiceBase.constructor
- Defined in packages/livekit-server-sdk/src/SipClient.ts:217

Methods

authHeader

authHeader(grant: VideoGrant, sip?: SIPGrant): Promise<Record<string, string>>
Parameters
- grant: VideoGrant
- Optionalsip: SIPGrant
Returns Promise<Record<string, string>>
Inherited from ServiceBase.authHeader
- Defined in packages/livekit-server-sdk/src/ServiceBase.ts:28

createSipDispatchRule

createSipDispatchRule(
rule: SipDispatchRuleDirect | SipDispatchRuleIndividual,
opts?: CreateSipDispatchRuleOptions,
): Promise<SIPDispatchRuleInfo>
Create a new SIP dispatch rule.
Parameters
- rule: SipDispatchRuleDirect | SipDispatchRuleIndividual
  SIP dispatch rule to create
- Optionalopts: CreateSipDispatchRuleOptions
  CreateSipDispatchRuleOptions
Returns Promise<SIPDispatchRuleInfo>
Created SIP dispatch rule
- Defined in packages/livekit-server-sdk/src/SipClient.ts:430

createSipInboundTrunk

createSipInboundTrunk(
    name: string,
    numbers: string[],
    opts?: CreateSipInboundTrunkOptions,
): Promise<SIPInboundTrunkInfo>
Create a new SIP inbound trunk.
Parameters
- name: string
  human-readable name of the trunk
- numbers: string[]
  phone numbers of the trunk
- Optionalopts: CreateSipInboundTrunkOptions
  CreateSipTrunkOptions
Returns Promise<SIPInboundTrunkInfo>
Created SIP inbound trunk
- Defined in packages/livekit-server-sdk/src/SipClient.ts:280

createSipOutboundTrunk

createSipOutboundTrunk(
    name: string,
    address: string,
    numbers: string[],
    opts?: CreateSipOutboundTrunkOptions,
): Promise<SIPOutboundTrunkInfo>
Create a new SIP outbound trunk.
Parameters
- name: string
  human-readable name of the trunk
- address: string
  hostname and port of the SIP server to dial
- numbers: string[]
  phone numbers of the trunk
- Optionalopts: CreateSipOutboundTrunkOptions
  CreateSipTrunkOptions
Returns Promise<SIPOutboundTrunkInfo>
Created SIP outbound trunk
- Defined in packages/livekit-server-sdk/src/SipClient.ts:322

createSipParticipant

createSipParticipant(
    sipTrunkId: string,
    number: string,
    roomName: string,
    opts?: CreateSipParticipantOptions,
): Promise<SIPParticipantInfo>
Create a new SIP participant.
Parameters
- sipTrunkId: string
  sip trunk to use for the call
- number: string
  number to dial
- roomName: string
  room to attach the call to
- Optionalopts: CreateSipParticipantOptions
  CreateSipParticipantOptions
Returns Promise<SIPParticipantInfo>
Created SIP participant
- Defined in packages/livekit-server-sdk/src/SipClient.ts:701

createSipTrunk

createSipTrunk(
number: string,
opts?: CreateSipTrunkOptions,
): Promise<SIPTrunkInfo>
Parameters
- number: string
  phone number of the trunk
- Optionalopts: CreateSipTrunkOptions
  CreateSipTrunkOptions
Returns Promise<SIPTrunkInfo>
Deprecated
use createSipInboundTrunk or createSipOutboundTrunk
- Defined in packages/livekit-server-sdk/src/SipClient.ts:227

deleteSipDispatchRule

deleteSipDispatchRule(sipDispatchRuleId: string): Promise<SIPDispatchRuleInfo>
Delete a SIP dispatch rule.
Parameters
- sipDispatchRuleId: string
  ID of the SIP dispatch rule to delete
Returns Promise<SIPDispatchRuleInfo>
Deleted rule information
- Defined in packages/livekit-server-sdk/src/SipClient.ts:682

deleteSipTrunk

deleteSipTrunk(sipTrunkId: string): Promise<SIPTrunkInfo>
Delete a SIP trunk.
Parameters
- sipTrunkId: string
  ID of the SIP trunk to delete
Returns Promise<SIPTrunkInfo>
Deleted trunk information
- Defined in packages/livekit-server-sdk/src/SipClient.ts:413

listSipDispatchRule

listSipDispatchRule(
list?: ListSipDispatchRuleOptions,
): Promise<SIPDispatchRuleInfo[]>
List SIP dispatch rules with optional filtering.
Parameters
- list: ListSipDispatchRuleOptions = {}
  Request with optional filtering parameters
Returns Promise<SIPDispatchRuleInfo[]>
Response containing list of SIP dispatch rules
- Defined in packages/livekit-server-sdk/src/SipClient.ts:663

listSipInboundTrunk

listSipInboundTrunk(list?: ListSipTrunkOptions): Promise<SIPInboundTrunkInfo[]>
List SIP inbound trunks with optional filtering.
Parameters
- list: ListSipTrunkOptions = {}
  Request with optional filtering parameters
Returns Promise<SIPInboundTrunkInfo[]>
Response containing list of SIP inbound trunks
- Defined in packages/livekit-server-sdk/src/SipClient.ts:379

listSipOutboundTrunk

listSipOutboundTrunk(
list?: ListSipTrunkOptions,
): Promise<SIPOutboundTrunkInfo[]>
List SIP outbound trunks with optional filtering.
Parameters
- list: ListSipTrunkOptions = {}
  Request with optional filtering parameters
Returns Promise<SIPOutboundTrunkInfo[]>
Response containing list of SIP outbound trunks
- Defined in packages/livekit-server-sdk/src/SipClient.ts:396

listSipTrunk

listSipTrunk(): Promise<SIPTrunkInfo[]>
Returns Promise<SIPTrunkInfo[]>
Deprecated
use listSipInboundTrunk or listSipOutboundTrunk
- Defined in packages/livekit-server-sdk/src/SipClient.ts:362

transferSipParticipant

transferSipParticipant(
    roomName: string,
    participantIdentity: string,
    transferTo: string,
    opts?: TransferSipParticipantOptions,
): Promise<void>
Transfer a SIP participant to a different room.
Parameters
- roomName: string
  room the SIP participant to transfer is connectd to
- participantIdentity: string
  identity of the SIP participant to transfer
- transferTo: string
  SIP URL to transfer the participant to
- Optionalopts: TransferSipParticipantOptions
  TransferSipParticipantOptions
Returns Promise<void>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:757

updateSipDispatchRule

updateSipDispatchRule(
sipDispatchRuleId: string,
rule: SIPDispatchRuleInfo,
): Promise<SIPDispatchRuleInfo>
Updates an existing SIP dispatch rule by replacing it entirely.
Parameters
- sipDispatchRuleId: string
  ID of the SIP dispatch rule to update
- rule: SIPDispatchRuleInfo
  new SIP dispatch rule
Returns Promise<SIPDispatchRuleInfo>
Updated SIP dispatch rule
- Defined in packages/livekit-server-sdk/src/SipClient.ts:487

updateSipDispatchRuleFields

updateSipDispatchRuleFields(
sipDispatchRuleId: string,
fields?: SipDispatchRuleUpdateOptions,
): Promise<SIPDispatchRuleInfo>
Updates specific fields of an existing SIP dispatch rule. Only provided fields will be updated.
Parameters
- sipDispatchRuleId: string
  ID of the SIP dispatch rule to update
- fields: SipDispatchRuleUpdateOptions = {}
  Fields of the dispatch rule to update
Returns Promise<SIPDispatchRuleInfo>
Updated SIP dispatch rule
- Defined in packages/livekit-server-sdk/src/SipClient.ts:517

updateSipInboundTrunk

updateSipInboundTrunk(
sipTrunkId: string,
trunk: SIPInboundTrunkInfo,
): Promise<SIPInboundTrunkInfo>
Updates an existing SIP inbound trunk by replacing it entirely.
Parameters
- sipTrunkId: string
  ID of the SIP inbound trunk to update
- trunk: SIPInboundTrunkInfo
  SIP inbound trunk to update with
Returns Promise<SIPInboundTrunkInfo>
Updated SIP inbound trunk
- Defined in packages/livekit-server-sdk/src/SipClient.ts:546

updateSipInboundTrunkFields

updateSipInboundTrunkFields(
sipTrunkId: string,
fields: SipInboundTrunkUpdateOptions,
): Promise<SIPInboundTrunkInfo>
Updates specific fields of an existing SIP inbound trunk. Only provided fields will be updated.
Parameters
- sipTrunkId: string
  ID of the SIP inbound trunk to update
- fields: SipInboundTrunkUpdateOptions
  Fields of the inbound trunk to update
Returns Promise<SIPInboundTrunkInfo>
Updated SIP inbound trunk
- Defined in packages/livekit-server-sdk/src/SipClient.ts:576

updateSipOutboundTrunk

updateSipOutboundTrunk(
sipTrunkId: string,
trunk: SIPOutboundTrunkInfo,
): Promise<SIPOutboundTrunkInfo>
Updates an existing SIP outbound trunk by replacing it entirely.
Parameters
- sipTrunkId: string
  ID of the SIP outbound trunk to update
- trunk: SIPOutboundTrunkInfo
  SIP outbound trunk to update with
Returns Promise<SIPOutboundTrunkInfo>
Updated SIP outbound trunk
- Defined in packages/livekit-server-sdk/src/SipClient.ts:605

updateSipOutboundTrunkFields

updateSipOutboundTrunkFields(
sipTrunkId: string,
fields: SipOutboundTrunkUpdateOptions,
): Promise<SIPOutboundTrunkInfo>
Updates specific fields of an existing SIP outbound trunk. Only provided fields will be updated.
Parameters
- sipTrunkId: string
  ID of the SIP outbound trunk to update
- fields: SipOutboundTrunkUpdateOptions
  Fields of the outbound trunk to update
Returns Promise<SIPOutboundTrunkInfo>
Updated SIP outbound trunk
- Defined in packages/livekit-server-sdk/src/SipClient.ts:635

Class SipClient

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SipClient

Methods

authHeader

Parameters

Returns Promise<Record<string, string>>

createSipDispatchRule

Parameters

Returns Promise<SIPDispatchRuleInfo>

createSipInboundTrunk

Parameters

Returns Promise<SIPInboundTrunkInfo>

createSipOutboundTrunk

Parameters

Returns Promise<SIPOutboundTrunkInfo>

createSipParticipant

Parameters

Returns Promise<SIPParticipantInfo>

createSipTrunk

Parameters

Returns Promise<SIPTrunkInfo>

Deprecated

deleteSipDispatchRule

Parameters

Returns Promise<SIPDispatchRuleInfo>

deleteSipTrunk

Parameters

Returns Promise<SIPTrunkInfo>

listSipDispatchRule

Parameters

Returns Promise<SIPDispatchRuleInfo[]>

listSipInboundTrunk

Parameters

Returns Promise<SIPInboundTrunkInfo[]>

listSipOutboundTrunk

Parameters

Returns Promise<SIPOutboundTrunkInfo[]>

listSipTrunk

Returns Promise<SIPTrunkInfo[]>

Deprecated

transferSipParticipant

Parameters

Returns Promise<void>

updateSipDispatchRule

Parameters

Returns Promise<SIPDispatchRuleInfo>

updateSipDispatchRuleFields

Parameters

Returns Promise<SIPDispatchRuleInfo>

updateSipInboundTrunk

Parameters

Returns Promise<SIPInboundTrunkInfo>

updateSipInboundTrunkFields

Parameters

Returns Promise<SIPInboundTrunkInfo>

updateSipOutboundTrunk

Parameters

Returns Promise<SIPOutboundTrunkInfo>

updateSipOutboundTrunkFields

Parameters

Returns Promise<SIPOutboundTrunkInfo>

Settings

On This Page