github.com/livekit/protocol@v1.16.1-0.20240517185851-47e4c6bba773/protobufs/rpc/sip.proto (about)

     1  // Copyright 2023 LiveKit, Inc.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  syntax = "proto3";
    16  
    17  package rpc;
    18  
    19  option go_package = "github.com/livekit/protocol/rpc";
    20  
    21  import "options.proto";
    22  
    23  service SIPInternal {
    24    rpc CreateSIPParticipant(InternalCreateSIPParticipantRequest) returns (InternalCreateSIPParticipantResponse) {
    25      option (psrpc.options).affinity_func = true;
    26      option (psrpc.options).topics = true;
    27    }
    28  }
    29  
    30  message InternalCreateSIPParticipantRequest {
    31    string sip_call_id = 13;
    32    // IP that SIP INVITE is sent too
    33    string address = 2;
    34  
    35    // Number used to make the call
    36    string number = 3;
    37  
    38    // Number to call to
    39    string call_to = 4;
    40  
    41    string username = 5;
    42    string password = 6;
    43  
    44    string room_name = 7;
    45    string participant_identity = 8;
    46    string participant_name = 14;
    47    string participant_metadata = 15;
    48  
    49    // optional token that should be used when creating LiveKit participant
    50    string token = 9;
    51  
    52    // optional websocket url that should be used when creating LiveKit participant
    53    string ws_url = 10;
    54  
    55    // Optionally send following DTMF digits (extension codes) when making a call.
    56    // Character 'w' can be used to add a 0.5 sec delay.
    57    string dtmf = 11;
    58  
    59    // Optionally play ringtone in the room as an audible indicator for existing participants
    60    bool play_ringtone = 12;
    61  
    62    // NEXT ID: 16
    63  }
    64  
    65  message InternalCreateSIPParticipantResponse {
    66    string participant_id = 1;
    67    string participant_identity = 2;
    68    string sip_call_id = 3;
    69  }