Class SipServiceClient
-
- All Implemented Interfaces:
public final class SipServiceClient extends ServiceClientBase
A client for interacting with the SIP service.
See: SIP Overview
-
-
Constructor Summary
Constructors Constructor Description SipServiceClient(SipService service, String apiKey, String secret)
-
Method Summary
Modifier and Type Method Description final Call<<Error class: unknown class>>createSipInboundTrunk(String name, List<String> numbers, CreateSipInboundTrunkOptions options)Creates an inbound trunk to accept incoming calls. final Call<<Error class: unknown class>>createSipInboundTrunk(String name, List<String> numbers)Creates an inbound trunk to accept incoming calls. final Call<<Error class: unknown class>>createSipOutboundTrunk(String name, String address, List<String> numbers, CreateSipOutboundTrunkOptions options)Creates an outbound trunk for making outgoing calls. final Call<<Error class: unknown class>>createSipOutboundTrunk(String name, String address, List<String> numbers)Creates an outbound trunk for making outgoing calls. final Call<<Error class: unknown class>>updateSipInboundTrunk(String sipTrunkId, UpdateSipInboundTrunkOptions options)UpdateSIPInboundTrunk updates an existing SIP Inbound Trunk. final Call<<Error class: unknown class>>updateSipInboundTrunk(String sipTrunkId)UpdateSIPInboundTrunk updates an existing SIP Inbound Trunk. final Call<<Error class: unknown class>>updateSipOutboundTrunk(String sipTrunkId, UpdateSipOutboundTrunkOptions options)UpdateSIPOutboundTrunk updates an existing SIP Outbound Trunk. final Call<<Error class: unknown class>>updateSipOutboundTrunk(String sipTrunkId)UpdateSIPOutboundTrunk updates an existing SIP Outbound Trunk. final Call<List<<Error class: unknown class>>>listSipInboundTrunk()List inbound trunks. final Call<List<<Error class: unknown class>>>listSipOutboundTrunk()List outbound trunks. final Call<<Error class: unknown class>>deleteSipTrunk(String sipTrunkId)Deletes a trunk. final Call<<Error class: unknown class>>createSipDispatchRule(SipDispatchRule rule, CreateSipDispatchRuleOptions options)Creates a dispatch rule. final Call<<Error class: unknown class>>createSipDispatchRule(SipDispatchRule rule)Creates a dispatch rule. final Call<<Error class: unknown class>>updateSipDispatchRule(String sipDispatchRuleId, UpdateSipDispatchRuleOptions options)UpdateSIPDispatchRule updates an existing SIP Dispatch Rule. final Call<<Error class: unknown class>>updateSipDispatchRule(String sipDispatchRuleId)UpdateSIPDispatchRule updates an existing SIP Dispatch Rule. final Call<List<<Error class: unknown class>>>listSipDispatchRule()Lists the dispatch rules. final Call<<Error class: unknown class>>deleteSipDispatchRule(String sipDispatchRuleId)Deletes a dispatch rule. final Call<<Error class: unknown class>>createSipParticipant(String sipTrunkId, String number, String roomName, CreateSipParticipantOptions options)Create a LiveKit SIP Participant. final Call<Void>transferSipParticipant(String roomName, String participantIdentity, String transferTo, TransferSipParticipantOptions options)Transfer a LiveKit SIP Participant to a different SIP peer. final static SipServiceClientcreateClient(String host, String apiKey, String secret, Supplier<OkHttpClient> okHttpSupplier)Create an SipServiceClient. final static SipServiceClientcreateClient(String host, String apiKey, String secret)Create an SipServiceClient. -
-
Constructor Detail
-
SipServiceClient
SipServiceClient(SipService service, String apiKey, String secret)
-
-
Method Detail
-
createSipInboundTrunk
@JvmOverloads() final Call<<Error class: unknown class>> createSipInboundTrunk(String name, List<String> numbers, CreateSipInboundTrunkOptions options)
Creates an inbound trunk to accept incoming calls.
See: SIP Inbound Trunk
-
createSipInboundTrunk
@JvmOverloads() final Call<<Error class: unknown class>> createSipInboundTrunk(String name, List<String> numbers)
Creates an inbound trunk to accept incoming calls.
See: SIP Inbound Trunk
-
createSipOutboundTrunk
@JvmOverloads() final Call<<Error class: unknown class>> createSipOutboundTrunk(String name, String address, List<String> numbers, CreateSipOutboundTrunkOptions options)
Creates an outbound trunk for making outgoing calls.
See: SIP Outbound Trunk
-
createSipOutboundTrunk
@JvmOverloads() final Call<<Error class: unknown class>> createSipOutboundTrunk(String name, String address, List<String> numbers)
Creates an outbound trunk for making outgoing calls.
See: SIP Outbound Trunk
-
updateSipInboundTrunk
@JvmOverloads() final Call<<Error class: unknown class>> updateSipInboundTrunk(String sipTrunkId, UpdateSipInboundTrunkOptions options)
UpdateSIPInboundTrunk updates an existing SIP Inbound Trunk.
-
updateSipInboundTrunk
@JvmOverloads() final Call<<Error class: unknown class>> updateSipInboundTrunk(String sipTrunkId)
UpdateSIPInboundTrunk updates an existing SIP Inbound Trunk.
-
updateSipOutboundTrunk
@JvmOverloads() final Call<<Error class: unknown class>> updateSipOutboundTrunk(String sipTrunkId, UpdateSipOutboundTrunkOptions options)
UpdateSIPOutboundTrunk updates an existing SIP Outbound Trunk.
-
updateSipOutboundTrunk
@JvmOverloads() final Call<<Error class: unknown class>> updateSipOutboundTrunk(String sipTrunkId)
UpdateSIPOutboundTrunk updates an existing SIP Outbound Trunk.
-
listSipInboundTrunk
@JvmOverloads() final Call<List<<Error class: unknown class>>> listSipInboundTrunk()
List inbound trunks.
See: SIP Inbound Trunk
-
listSipOutboundTrunk
@JvmOverloads() final Call<List<<Error class: unknown class>>> listSipOutboundTrunk()
List outbound trunks.
See: SIP Outbound Trunk
-
deleteSipTrunk
@JvmOverloads() final Call<<Error class: unknown class>> deleteSipTrunk(String sipTrunkId)
Deletes a trunk.
-
createSipDispatchRule
@JvmOverloads() final Call<<Error class: unknown class>> createSipDispatchRule(SipDispatchRule rule, CreateSipDispatchRuleOptions options)
Creates a dispatch rule.
See: Dispatch Rules
-
createSipDispatchRule
@JvmOverloads() final Call<<Error class: unknown class>> createSipDispatchRule(SipDispatchRule rule)
Creates a dispatch rule.
See: Dispatch Rules
-
updateSipDispatchRule
@JvmOverloads() final Call<<Error class: unknown class>> updateSipDispatchRule(String sipDispatchRuleId, UpdateSipDispatchRuleOptions options)
UpdateSIPDispatchRule updates an existing SIP Dispatch Rule.
-
updateSipDispatchRule
@JvmOverloads() final Call<<Error class: unknown class>> updateSipDispatchRule(String sipDispatchRuleId)
UpdateSIPDispatchRule updates an existing SIP Dispatch Rule.
-
listSipDispatchRule
final Call<List<<Error class: unknown class>>> listSipDispatchRule()
Lists the dispatch rules.
See: Dispatch Rules
-
deleteSipDispatchRule
final Call<<Error class: unknown class>> deleteSipDispatchRule(String sipDispatchRuleId)
Deletes a dispatch rule.
See: Dispatch Rules
-
createSipParticipant
final Call<<Error class: unknown class>> createSipParticipant(String sipTrunkId, String number, String roomName, CreateSipParticipantOptions options)
Create a LiveKit SIP Participant.
See: SIP Participant
-
transferSipParticipant
final Call<Void> transferSipParticipant(String roomName, String participantIdentity, String transferTo, TransferSipParticipantOptions options)
Transfer a LiveKit SIP Participant to a different SIP peer.
See: SIP Participant
-
createClient
@JvmOverloads() final static SipServiceClient createClient(String host, String apiKey, String secret, Supplier<OkHttpClient> okHttpSupplier)
Create an SipServiceClient.
- Parameters:
okHttpSupplier- provide an OkHttpFactory if you wish to customize the http client (e.g.
-
createClient
@JvmOverloads() final static SipServiceClient createClient(String host, String apiKey, String secret)
Create an SipServiceClient.
-
-
-
-