Class SipClient

Client to access Egress APIs

Hierarchy

ServiceBase
- SipClient

Index

Constructors

Methods

authHeader createSipDispatchRule createSipInboundTrunk createSipOutboundTrunk createSipParticipant createSipTrunk deleteSipDispatchRule deleteSipTrunk listSipDispatchRule listSipInboundTrunk listSipOutboundTrunk listSipTrunk transferSipParticipant

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:145

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>
Parameters
- rule: SipDispatchRuleDirect | SipDispatchRuleIndividual
  sip dispatch rule
- Optionalopts: CreateSipDispatchRuleOptions
  CreateSipDispatchRuleOptions
Returns Promise<SIPDispatchRuleInfo>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:333

createSipInboundTrunk

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

createSipOutboundTrunk

createSipOutboundTrunk(
    name: string,
    address: string,
    numbers: string[],
    opts?: CreateSipOutboundTrunkOptions,
): Promise<SIPOutboundTrunkInfo>
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>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:244

createSipParticipant

createSipParticipant(
    sipTrunkId: string,
    number: string,
    roomName: string,
    opts?: CreateSipParticipantOptions,
): Promise<SIPParticipantInfo>
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>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:413

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:155

deleteSipDispatchRule

deleteSipDispatchRule(sipDispatchRuleId: string): Promise<SIPDispatchRuleInfo>
Parameters
- sipDispatchRuleId: string
  sip trunk to delete
Returns Promise<SIPDispatchRuleInfo>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:397

deleteSipTrunk

deleteSipTrunk(sipTrunkId: string): Promise<SIPTrunkInfo>
Parameters
- sipTrunkId: string
  sip trunk to delete
Returns Promise<SIPTrunkInfo>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:319

listSipDispatchRule

listSipDispatchRule(): Promise<SIPDispatchRuleInfo[]>
Returns Promise<SIPDispatchRuleInfo[]>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:383

listSipInboundTrunk

listSipInboundTrunk(): Promise<SIPInboundTrunkInfo[]>
Returns Promise<SIPInboundTrunkInfo[]>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:294

listSipOutboundTrunk

listSipOutboundTrunk(): Promise<SIPOutboundTrunkInfo[]>
Returns Promise<SIPOutboundTrunkInfo[]>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:305

listSipTrunk

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

transferSipParticipant

transferSipParticipant(
    roomName: string,
    participantIdentity: string,
    transferTo: string,
    opts?: TransferSipParticipantOptions,
): Promise<void>
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
Returns Promise<void>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:458

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

Returns Promise<SIPDispatchRuleInfo[]>

listSipInboundTrunk

Returns Promise<SIPInboundTrunkInfo[]>

listSipOutboundTrunk

Returns Promise<SIPOutboundTrunkInfo[]>

listSipTrunk

Returns Promise<SIPTrunkInfo[]>

Deprecated

transferSipParticipant

Parameters

Returns Promise<void>

Settings

On This Page