-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
251 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,229 @@ | ||
| // Copyright 2024 LiveKit, Inc. | ||
| // | ||
| // Licensed under the Apache License, Version 2.0 (the "License"); | ||
| // you may not use this file except in compliance with the License. | ||
| // You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, software | ||
| // distributed under the License is distributed on an "AS IS" BASIS, | ||
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| // See the License for the specific language governing permissions and | ||
| // limitations under the License. | ||
|
|
||
| use std::ptr::null; | ||
| use livekit_protocol as proto; | ||
|
|
||
| use crate::access_token::VideoGrants; | ||
| use crate::get_env_keys; | ||
| use crate::services::{LIVEKIT_PACKAGE, ServiceBase, ServiceResult}; | ||
| use crate::services::ingress::{CreateIngressOptions, IngressListFilter}; | ||
| use crate::services::twirp_client::TwirpClient; | ||
|
|
||
| const SVC: &str = "SIP"; | ||
|
|
||
| #[derive(Debug)] | ||
| pub struct SIPClient { | ||
| base: ServiceBase, | ||
| client: TwirpClient, | ||
| } | ||
|
|
||
| #[derive(Default, Clone, Debug)] | ||
| pub struct CreateSIPTrunkOptions { | ||
| /// CIDR or IPs that traffic is accepted from | ||
| /// An empty list means all inbound traffic is accepted. | ||
| pub inbound_addresses: Vec<String>, | ||
| /// Accepted `To` values. This Trunk will only accept a call made to | ||
| /// these numbers. This allows you to have distinct Trunks for different phone | ||
| /// numbers at the same provider. | ||
| pub inbound_numbers: Vec<String>, | ||
| /// Username and password used to authenticate inbound SIP invites | ||
| /// May be empty to have no Authentication | ||
| pub inbound_username: String, | ||
| pub inbound_password: String, | ||
|
|
||
| /// IP that SIP INVITE is sent too | ||
| pub outbound_address: String, | ||
| /// Username and password used to authenticate outbound SIP invites | ||
| /// May be empty to have no Authentication | ||
| pub outbound_username: String, | ||
| pub outbound_password: String, | ||
| } | ||
|
|
||
| #[derive(Debug, Clone, PartialEq, Eq)] | ||
| pub enum ListSIPTrunkFilter { | ||
| All, | ||
| } | ||
|
|
||
| #[derive(Default, Clone, Debug)] | ||
| pub struct CreateSIPDispatchRuleOptions { | ||
| /// What trunks are accepted for this dispatch rule | ||
| /// If empty all trunks will match this dispatch rule | ||
| pub trunk_ids: Vec<String>, | ||
| pub hide_phone_number: bool, | ||
| } | ||
|
|
||
| #[derive(Debug, Clone, PartialEq, Eq)] | ||
| pub enum ListSIPDispatchRuleFilter { | ||
| All, | ||
| } | ||
|
|
||
| #[derive(Default, Clone, Debug)] | ||
| pub struct CreateSIPParticipantOptions { | ||
| /// Optional identity of the participant in LiveKit room | ||
| pub participant_identity: String, | ||
| /// Optionally send following DTMF digits (extension codes) when making a call. | ||
| /// Character 'w' can be used to add a 0.5 sec delay. | ||
| pub dtmf: String, | ||
| /// Optionally play ringtone in the room as an audible indicator for existing participants | ||
| pub play_ringtone: bool, | ||
| } | ||
|
|
||
| impl SIPClient { | ||
| pub fn with_api_key(host: &str, api_key: &str, api_secret: &str) -> Self { | ||
| Self { | ||
| base: ServiceBase::with_api_key(api_key, api_secret), | ||
| client: TwirpClient::new(host, LIVEKIT_PACKAGE, None), | ||
| } | ||
| } | ||
|
|
||
| pub fn new(host: &str) -> ServiceResult<Self> { | ||
| let (api_key, api_secret) = get_env_keys()?; | ||
| Ok(Self::with_api_key(host, &api_key, &api_secret)) | ||
| } | ||
|
|
||
| pub async fn create_sip_trunk( | ||
| &self, | ||
| number: String, | ||
| options: CreateSIPTrunkOptions, | ||
| ) -> ServiceResult<proto::SipTrunkInfo> { | ||
| self.client | ||
| .request( | ||
| SVC, | ||
| "CreateSIPTrunk", | ||
| proto::CreateSipTrunkRequest { | ||
| outbound_number: number.to_owned(), | ||
| outbound_address: options.outbound_address.to_owned(), | ||
| outbound_username: options.outbound_username.to_owned(), | ||
| outbound_password: options.outbound_password.to_owned(), | ||
|
|
||
| inbound_numbers: options.inbound_numbers.to_owned(), | ||
| inbound_numbers_regex: Vec::new(), | ||
| inbound_addresses: options.inbound_addresses.to_owned(), | ||
| inbound_username: options.inbound_username.to_owned(), | ||
| inbound_password: options.inbound_password.to_owned(), | ||
| }, | ||
| self.base.auth_header(VideoGrants { ..Default::default() })?, | ||
| ) | ||
| .await | ||
| .map_err(Into::into) | ||
| } | ||
|
|
||
| pub async fn list_sip_trunk( | ||
| &self, | ||
| filter: ListSIPTrunkFilter, | ||
| ) -> ServiceResult<Vec<proto::SipTrunkInfo>> { | ||
|
|
||
| let resp: proto::ListSipTrunkResponse = self | ||
| .client | ||
| .request( | ||
| SVC, | ||
| "ListSIPTrunk", | ||
| proto::ListSipTrunkRequest { }, | ||
| self.base.auth_header(VideoGrants { ..Default::default() })?, | ||
| ) | ||
| .await?; | ||
|
|
||
| Ok(resp.items) | ||
| } | ||
|
|
||
| pub async fn delete_sip_trunk(&self, sip_trunk_id: &str) -> ServiceResult<proto::SipTrunkInfo> { | ||
| self.client | ||
| .request( | ||
| SVC, | ||
| "DeleteSIPTrunk", | ||
| proto::DeleteSipTrunkRequest { sip_trunk_id: sip_trunk_id.to_owned() }, | ||
| self.base.auth_header(VideoGrants { ..Default::default() })?, | ||
| ) | ||
| .await | ||
| .map_err(Into::into) | ||
| } | ||
|
|
||
| pub async fn create_sip_dispatch_rule( | ||
| &self, | ||
| rule: proto::sip_dispatch_rule::Rule, | ||
| options: CreateSIPDispatchRuleOptions, | ||
| ) -> ServiceResult<proto::SipDispatchRuleInfo> { | ||
| self.client | ||
| .request( | ||
| SVC, | ||
| "CreateSIPDispatchRule", | ||
| proto::CreateSipDispatchRuleRequest { | ||
| trunk_ids: options.trunk_ids.to_owned(), | ||
| hide_phone_number: options.hide_phone_number, | ||
| rule: Some(proto::SipDispatchRule{ | ||
| rule: Some(rule.to_owned()), | ||
| }), | ||
| }, | ||
| self.base.auth_header(VideoGrants { ..Default::default() })?, | ||
| ) | ||
| .await | ||
| .map_err(Into::into) | ||
| } | ||
|
|
||
| pub async fn list_sip_dispatch_rule( | ||
| &self, | ||
| filter: ListSIPDispatchRuleFilter, | ||
| ) -> ServiceResult<Vec<proto::SipDispatchRuleInfo>> { | ||
|
|
||
| let resp: proto::ListSipDispatchRuleResponse = self | ||
| .client | ||
| .request( | ||
| SVC, | ||
| "ListSIPDispatchRule", | ||
| proto::ListSipDispatchRuleRequest { }, | ||
| self.base.auth_header(VideoGrants { ..Default::default() })?, | ||
| ) | ||
| .await?; | ||
|
|
||
| Ok(resp.items) | ||
| } | ||
|
|
||
| pub async fn delete_sip_dispatch_rule(&self, sip_dispatch_rule_id: &str) -> ServiceResult<proto::SipDispatchRuleInfo> { | ||
| self.client | ||
| .request( | ||
| SVC, | ||
| "DeleteSIPDispatchRule", | ||
| proto::DeleteSipDispatchRuleRequest { sip_dispatch_rule_id: sip_dispatch_rule_id.to_owned() }, | ||
| self.base.auth_header(VideoGrants { ..Default::default() })?, | ||
| ) | ||
| .await | ||
| .map_err(Into::into) | ||
| } | ||
|
|
||
| pub async fn create_sip_participant( | ||
| &self, | ||
| sip_trunk_id: String, | ||
| call_to: String, | ||
| room_name: String, | ||
| options: CreateSIPParticipantOptions, | ||
| ) -> ServiceResult<proto::SipParticipantInfo> { | ||
| self.client | ||
| .request( | ||
| SVC, | ||
| "CreateSIPParticipant", | ||
| proto::CreateSipParticipantRequest { | ||
| sip_trunk_id: sip_trunk_id.to_owned(), | ||
| sip_call_to: call_to.to_owned(), | ||
| room_name: room_name.to_owned(), | ||
| participant_identity: options.participant_identity.to_owned(), | ||
| dtmf: options.dtmf.to_owned(), | ||
| play_ringtone: options.play_ringtone, | ||
| }, | ||
| self.base.auth_header(VideoGrants { ..Default::default() })?, | ||
| ) | ||
| .await | ||
| .map_err(Into::into) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters