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, apiKey?, secret?): 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:118

Methods

authHeader

authHeader(grant, sip?): 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, opts?): Promise<SIPDispatchRuleInfo>
Parameters
- rule: SipDispatchRuleDirect | SipDispatchRuleIndividual
  sip dispatch rule
- Optionalopts: CreateSipDispatchRuleOptions
  CreateSipDispatchRuleOptions
Returns Promise<SIPDispatchRuleInfo>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:328

createSipInboundTrunk

createSipInboundTrunk(name, numbers, opts?): 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:178

createSipOutboundTrunk

createSipOutboundTrunk(name, address, numbers, opts?): 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:230

createSipParticipant

createSipParticipant(sipTrunkId, number, roomName, opts?): 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, opts?): 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:128

deleteSipDispatchRule

deleteSipDispatchRule(sipDispatchRuleId): 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): Promise<SIPTrunkInfo>
Parameters
- sipTrunkId: string
  sip trunk to delete
Returns Promise<SIPTrunkInfo>
- Defined in packages/livekit-server-sdk/src/SipClient.ts:314

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

listSipOutboundTrunk

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

listSipTrunk

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

transferSipParticipant

transferSipParticipant(roomName, participantIdentity, transferTo, opts?): 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:477