Class: Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CallMatcher

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/dialogflow_v2beta1/classes.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb,
lib/google/apis/dialogflow_v2beta1/representations.rb

Overview

Represents a call matcher that describes criteria for matching incoming SIP calls to a conversation. When Dialogflow get a SIP call from a third-party carrier, Dialogflow matches the call to an existing conversation by either: * Extracting the conversation id from the Call-Info header, e.g. Call-Info: ;purpose=Goog-ContactCenter- Conversation. * Or, if that doesn't work, matching incoming SIP headers against any CallMatcher for the conversation. If an incoming SIP call without valid Call-Info header matches to zero or multiple conversations with CallMatcher, we reject it. A call matcher contains equality conditions for SIP headers that all have to be fulfilled in order for a SIP call to match. The matched SIP headers consist of well-known headers (To, From, Call-ID) and custom headers. A CallMatcher is only valid if it specifies: * At least 1 custom header, * or at least 2 well-known headers.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDialogflowV2beta1CallMatcher

Returns a new instance of GoogleCloudDialogflowV2beta1CallMatcher.



8089
8090
8091
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 8089

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#call_id_header ⇒ String

Value of the Call-ID header to match. If empty or unspecified, we don't match to the Call-ID header. Corresponds to the JSON property callIdHeader

Returns:

  • (String) 


8061
8062
8063
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 8061

def call_id_header
  @call_id_header
end

#custom_headers ⇒ Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1CallMatcherCustomHeaders

Custom SIP headers. See the description of headers in the RFC. Corresponds to the JSON property customHeaders

Returns:



8067
8068
8069
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 8067

def custom_headers
  @custom_headers
end

#from_header ⇒ String

Value of the From header to match. If empty or unspecified, we don't match to the From header. Corresponds to the JSON property fromHeader

Returns:

  • (String) 


8074
8075
8076
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 8074

def from_header
  @from_header
end

#name ⇒ String

Output only. The unique identifier of this call matcher. Format: projects// locations//conversations//callMatchers/. Corresponds to the JSON property name

Returns:

  • (String) 


8080
8081
8082
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 8080

def name
  @name
end

#to_header ⇒ String

Value of the To header to match. If empty or unspecified, we don't match to the To header. Corresponds to the JSON property toHeader

Returns:

  • (String) 


8087
8088
8089
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 8087

def to_header
  @to_header
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



8094
8095
8096
8097
8098
8099
8100
 
# File 'lib/google/apis/dialogflow_v2beta1/classes.rb', line 8094

def update!(**args)
  @call_id_header = args[:call_id_header] if args.key?(:call_id_header)
  @custom_headers = args[:custom_headers] if args.key?(:custom_headers)
  @from_header = args[:from_header] if args.key?(:from_header)
  @name = args[:name] if args.key?(:name)
  @to_header = args[:to_header] if args.key?(:to_header)
end