Package 

Interface LivekitSip.SIPInboundTrunkInfoOrBuilder

    • Method Summary

      Modifier and Type Method Description
      abstract String getSipTrunkId() string sip_trunk_id = 1;
      abstract ByteString getSipTrunkIdBytes() string sip_trunk_id = 1;
      abstract String getName() 
      Human-readable name for the Trunk.
      string name = 2;
      abstract ByteString getNameBytes() 
      Human-readable name for the Trunk.
      string name = 2;
      abstract String getMetadata() 
      User-defined metadata for the Trunk.
      string metadata = 3;
      abstract ByteString getMetadataBytes() 
      User-defined metadata for the Trunk.
      string metadata = 3;
      abstract List<String> getNumbersList() 
      Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
Creating multiple Trunks with different phone numbers allows having different rules for a single provider.
      repeated string numbers = 4;
      abstract int getNumbersCount() 
      Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
Creating multiple Trunks with different phone numbers allows having different rules for a single provider.
      repeated string numbers = 4;
      abstract String getNumbers(int index) 
      Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
Creating multiple Trunks with different phone numbers allows having different rules for a single provider.
      repeated string numbers = 4;
      abstract ByteString getNumbersBytes(int index) 
      Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
Creating multiple Trunks with different phone numbers allows having different rules for a single provider.
      repeated string numbers = 4;
      abstract List<String> getAllowedAddressesList() 
      CIDR or IPs that traffic is accepted from.
An empty list means all inbound traffic is accepted.
      repeated string allowed_addresses = 5;
      abstract int getAllowedAddressesCount() 
      CIDR or IPs that traffic is accepted from.
An empty list means all inbound traffic is accepted.
      repeated string allowed_addresses = 5;
      abstract String getAllowedAddresses(int index) 
      CIDR or IPs that traffic is accepted from.
An empty list means all inbound traffic is accepted.
      repeated string allowed_addresses = 5;
      abstract ByteString getAllowedAddressesBytes(int index) 
      CIDR or IPs that traffic is accepted from.
An empty list means all inbound traffic is accepted.
      repeated string allowed_addresses = 5;
      abstract List<String> getAllowedNumbersList() 
      Numbers that are allowed to make calls to this Trunk.
An empty list means calls from any phone number is accepted.
      repeated string allowed_numbers = 6;
      abstract int getAllowedNumbersCount() 
      Numbers that are allowed to make calls to this Trunk.
An empty list means calls from any phone number is accepted.
      repeated string allowed_numbers = 6;
      abstract String getAllowedNumbers(int index) 
      Numbers that are allowed to make calls to this Trunk.
An empty list means calls from any phone number is accepted.
      repeated string allowed_numbers = 6;
      abstract ByteString getAllowedNumbersBytes(int index) 
      Numbers that are allowed to make calls to this Trunk.
An empty list means calls from any phone number is accepted.
      repeated string allowed_numbers = 6;
      abstract String getAuthUsername() 
      Username and password used to authenticate inbound SIP invites.
May be empty to have no authentication.
      string auth_username = 7;
      abstract ByteString getAuthUsernameBytes() 
      Username and password used to authenticate inbound SIP invites.
May be empty to have no authentication.
      string auth_username = 7;
      abstract String getAuthPassword() string auth_password = 8;
      abstract ByteString getAuthPasswordBytes() string auth_password = 8;
      abstract int getHeadersCount() 
      Include these SIP X-* headers in 200 OK responses.
      map<string, string> headers = 9;
      abstract boolean containsHeaders(String key) 
      Include these SIP X-* headers in 200 OK responses.
      map<string, string> headers = 9;
      abstract Map<String, String> getHeaders() Use getHeadersMap instead.
      abstract Map<String, String> getHeadersMap() 
      Include these SIP X-* headers in 200 OK responses.
      map<string, string> headers = 9;
      abstract String getHeadersOrDefault(String key, String defaultValue) 
      Include these SIP X-* headers in 200 OK responses.
      map<string, string> headers = 9;
      abstract String getHeadersOrThrow(String key) 
      Include these SIP X-* headers in 200 OK responses.
      map<string, string> headers = 9;
      abstract int getHeadersToAttributesCount() 
      Map SIP X-* headers from INVITE to SIP participant attributes.
      map<string, string> headers_to_attributes = 10;
      abstract boolean containsHeadersToAttributes(String key) 
      Map SIP X-* headers from INVITE to SIP participant attributes.
      map<string, string> headers_to_attributes = 10;
      abstract Map<String, String> getHeadersToAttributes() Use getHeadersToAttributesMap instead.
      abstract Map<String, String> getHeadersToAttributesMap() 
      Map SIP X-* headers from INVITE to SIP participant attributes.
      map<string, string> headers_to_attributes = 10;
      abstract String getHeadersToAttributesOrDefault(String key, String defaultValue) 
      Map SIP X-* headers from INVITE to SIP participant attributes.
      map<string, string> headers_to_attributes = 10;
      abstract String getHeadersToAttributesOrThrow(String key) 
      Map SIP X-* headers from INVITE to SIP participant attributes.
      map<string, string> headers_to_attributes = 10;
      abstract int getAttributesToHeadersCount() 
      Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
      map<string, string> attributes_to_headers = 14;
      abstract boolean containsAttributesToHeaders(String key) 
      Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
      map<string, string> attributes_to_headers = 14;
      abstract Map<String, String> getAttributesToHeaders() Use getAttributesToHeadersMap instead.
      abstract Map<String, String> getAttributesToHeadersMap() 
      Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
      map<string, string> attributes_to_headers = 14;
      abstract String getAttributesToHeadersOrDefault(String key, String defaultValue) 
      Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
      map<string, string> attributes_to_headers = 14;
      abstract String getAttributesToHeadersOrThrow(String key) 
      Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
      map<string, string> attributes_to_headers = 14;
      abstract int getIncludeHeadersValue() 
      Map SIP headers from INVITE to sip.h.* participant attributes automatically.

When the names of required headers is known, using headers_to_attributes is strongly recommended.

When mapping INVITE headers to response headers with attributes_to_headers map,
lowercase header names should be used, for example: sip.h.x-custom-header.
      .livekit.SIPHeaderOptions include_headers = 15;
      abstract LivekitSip.SIPHeaderOptions getIncludeHeaders() 
      Map SIP headers from INVITE to sip.h.* participant attributes automatically.

When the names of required headers is known, using headers_to_attributes is strongly recommended.

When mapping INVITE headers to response headers with attributes_to_headers map,
lowercase header names should be used, for example: sip.h.x-custom-header.
      .livekit.SIPHeaderOptions include_headers = 15;
      abstract boolean hasRingingTimeout() 
      Max time for the caller to wait for track subscription.
      .google.protobuf.Duration ringing_timeout = 11;
      abstract Duration getRingingTimeout() 
      Max time for the caller to wait for track subscription.
      .google.protobuf.Duration ringing_timeout = 11;
      abstract boolean hasMaxCallDuration() 
      Max call duration.
      .google.protobuf.Duration max_call_duration = 12;
      abstract Duration getMaxCallDuration() 
      Max call duration.
      .google.protobuf.Duration max_call_duration = 12;
      abstract boolean getKrispEnabled() bool krisp_enabled = 13;
      abstract int getMediaEncryptionValue() .livekit.SIPMediaEncryption media_encryption = 16;
      abstract LivekitSip.SIPMediaEncryption getMediaEncryption() .livekit.SIPMediaEncryption media_encryption = 16;

      • Methods inherited from class com.google.protobuf.MessageLiteOrBuilder

        getDefaultInstanceForType, isInitialized

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • getName

         abstract String getName()
        Human-readable name for the Trunk.
        string name = 2;

      • getNameBytes

         abstract ByteString getNameBytes()
        Human-readable name for the Trunk.
        string name = 2;

      • getMetadata

         abstract String getMetadata()
        User-defined metadata for the Trunk.
        string metadata = 3;

      • getMetadataBytes

         abstract ByteString getMetadataBytes()
        User-defined metadata for the Trunk.
        string metadata = 3;

      • getNumbersList

         abstract List<String> getNumbersList()
        Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
Creating multiple Trunks with different phone numbers allows having different rules for a single provider.
        repeated string numbers = 4;

      • getNumbersCount

         abstract int getNumbersCount()
        Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
Creating multiple Trunks with different phone numbers allows having different rules for a single provider.
        repeated string numbers = 4;

      • getNumbers

         abstract String getNumbers(int index)
        Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
Creating multiple Trunks with different phone numbers allows having different rules for a single provider.
        repeated string numbers = 4;
        Parameters:
        index - The index of the element to return.

      • getNumbersBytes

         abstract ByteString getNumbersBytes(int index)
        Numbers associated with LiveKit SIP. The Trunk will only accept calls made to these numbers.
Creating multiple Trunks with different phone numbers allows having different rules for a single provider.
        repeated string numbers = 4;
        Parameters:
        index - The index of the element to return.

      • getAllowedAddressesList

         abstract List<String> getAllowedAddressesList()
        CIDR or IPs that traffic is accepted from.
An empty list means all inbound traffic is accepted.
        repeated string allowed_addresses = 5;

      • getAllowedAddressesCount

         abstract int getAllowedAddressesCount()
        CIDR or IPs that traffic is accepted from.
An empty list means all inbound traffic is accepted.
        repeated string allowed_addresses = 5;

      • getAllowedAddresses

         abstract String getAllowedAddresses(int index)
        CIDR or IPs that traffic is accepted from.
An empty list means all inbound traffic is accepted.
        repeated string allowed_addresses = 5;
        Parameters:
        index - The index of the element to return.

      • getAllowedAddressesBytes

         abstract ByteString getAllowedAddressesBytes(int index)
        CIDR or IPs that traffic is accepted from.
An empty list means all inbound traffic is accepted.
        repeated string allowed_addresses = 5;
        Parameters:
        index - The index of the element to return.

      • getAllowedNumbersList

         abstract List<String> getAllowedNumbersList()
        Numbers that are allowed to make calls to this Trunk.
An empty list means calls from any phone number is accepted.
        repeated string allowed_numbers = 6;

      • getAllowedNumbersCount

         abstract int getAllowedNumbersCount()
        Numbers that are allowed to make calls to this Trunk.
An empty list means calls from any phone number is accepted.
        repeated string allowed_numbers = 6;

      • getAllowedNumbers

         abstract String getAllowedNumbers(int index)
        Numbers that are allowed to make calls to this Trunk.
An empty list means calls from any phone number is accepted.
        repeated string allowed_numbers = 6;
        Parameters:
        index - The index of the element to return.

      • getAllowedNumbersBytes

         abstract ByteString getAllowedNumbersBytes(int index)
        Numbers that are allowed to make calls to this Trunk.
An empty list means calls from any phone number is accepted.
        repeated string allowed_numbers = 6;
        Parameters:
        index - The index of the element to return.

      • getAuthUsername

         abstract String getAuthUsername()
        Username and password used to authenticate inbound SIP invites.
May be empty to have no authentication.
        string auth_username = 7;

      • getAuthUsernameBytes

         abstract ByteString getAuthUsernameBytes()
        Username and password used to authenticate inbound SIP invites.
May be empty to have no authentication.
        string auth_username = 7;

      • getHeadersCount

         abstract int getHeadersCount()
        Include these SIP X-* headers in 200 OK responses.
        map<string, string> headers = 9;

      • containsHeaders

         abstract boolean containsHeaders(String key)
        Include these SIP X-* headers in 200 OK responses.
        map<string, string> headers = 9;

      • getHeadersMap

         abstract Map<String, String> getHeadersMap()
        Include these SIP X-* headers in 200 OK responses.
        map<string, string> headers = 9;

      • getHeadersOrThrow

         abstract String getHeadersOrThrow(String key)
        Include these SIP X-* headers in 200 OK responses.
        map<string, string> headers = 9;

      • getHeadersToAttributesCount

         abstract int getHeadersToAttributesCount()
        Map SIP X-* headers from INVITE to SIP participant attributes.
        map<string, string> headers_to_attributes = 10;

      • containsHeadersToAttributes

         abstract boolean containsHeadersToAttributes(String key)
        Map SIP X-* headers from INVITE to SIP participant attributes.
        map<string, string> headers_to_attributes = 10;

      • getAttributesToHeadersCount

         abstract int getAttributesToHeadersCount()
        Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
        map<string, string> attributes_to_headers = 14;

      • containsAttributesToHeaders

         abstract boolean containsAttributesToHeaders(String key)
        Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
        map<string, string> attributes_to_headers = 14;

      • getAttributesToHeadersMap

         abstract Map<String, String> getAttributesToHeadersMap()
        Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
        map<string, string> attributes_to_headers = 14;

      • getAttributesToHeadersOrDefault

         abstract String getAttributesToHeadersOrDefault(String key, String defaultValue)
        Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
        map<string, string> attributes_to_headers = 14;

      • getAttributesToHeadersOrThrow

         abstract String getAttributesToHeadersOrThrow(String key)
        Map LiveKit attributes to SIP X-* headers when sending BYE or REFER requests.
Keys are the names of attributes and values are the names of X-* headers they will be mapped to.
        map<string, string> attributes_to_headers = 14;

      • getIncludeHeadersValue

         abstract int getIncludeHeadersValue()
        Map SIP headers from INVITE to sip.h.* participant attributes automatically.

When the names of required headers is known, using headers_to_attributes is strongly recommended.

When mapping INVITE headers to response headers with attributes_to_headers map,
lowercase header names should be used, for example: sip.h.x-custom-header.
        .livekit.SIPHeaderOptions include_headers = 15;

      • getIncludeHeaders

         abstract LivekitSip.SIPHeaderOptions getIncludeHeaders()
        Map SIP headers from INVITE to sip.h.* participant attributes automatically.

When the names of required headers is known, using headers_to_attributes is strongly recommended.

When mapping INVITE headers to response headers with attributes_to_headers map,
lowercase header names should be used, for example: sip.h.x-custom-header.
        .livekit.SIPHeaderOptions include_headers = 15;

      • hasRingingTimeout

         abstract boolean hasRingingTimeout()
        Max time for the caller to wait for track subscription.
        .google.protobuf.Duration ringing_timeout = 11;

      • getRingingTimeout

         abstract Duration getRingingTimeout()
        Max time for the caller to wait for track subscription.
        .google.protobuf.Duration ringing_timeout = 11;

      • hasMaxCallDuration

         abstract boolean hasMaxCallDuration()
        Max call duration.
        .google.protobuf.Duration max_call_duration = 12;

      • getMaxCallDuration

         abstract Duration getMaxCallDuration()
        Max call duration.
        .google.protobuf.Duration max_call_duration = 12;

      • getKrispEnabled

         abstract boolean getKrispEnabled()

        bool krisp_enabled = 13;

      • getMediaEncryptionValue

         abstract int getMediaEncryptionValue()

        .livekit.SIPMediaEncryption media_encryption = 16;