Class: Vapi::TransferDestinationSipMessage

Inherits:
Object
  • Object
show all
Defined in:
lib/vapi_server_sdk/types/transfer_destination_sip_message.rb

Overview

This is spoken to the customer before connecting them to the destination.

Usage:
- If this is not provided and transfer tool messages is not provided, default is
"Transferring the call now".
- If set to "", nothing is spoken. This is useful when you want to silently
transfer. This is especially useful when transferring between assistants in a
squad. In this scenario, you likely also want to set
`assistant.firstMessageMode=assistant-speaks-first-with-model-generated-message`
for the destination assistant.
This accepts a string or a ToolMessageStart class. Latter is useful if you want
to specify multiple messages for different languages through the `contents`
field.

Class Method Summary collapse

Class Method Details

.from_json(json_object:) ⇒ Vapi::TransferDestinationSipMessage

Deserialize a JSON object to an instance of TransferDestinationSipMessage

Parameters:

  • json_object (String)

Returns:



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/vapi_server_sdk/types/transfer_destination_sip_message.rb', line 24

def self.from_json(json_object:)
  struct = JSON.parse(json_object, object_class: OpenStruct)
  begin
    struct.is_a?(String) != false || raise("Passed value for field struct is not the expected type, validation failed.")
    return struct unless struct.nil?

    return nil
  rescue StandardError
    # noop
  end
  begin
    Vapi::CustomMessage.validate_raw(obj: struct)
    return Vapi::CustomMessage.from_json(json_object: struct) unless struct.nil?

    return nil
  rescue StandardError
    # noop
  end
  struct
end

.validate_raw(obj:) ⇒ Void

Leveraged for Union-type generation, validate_raw attempts to parse the given

hash and check each fields type against the current object's property
definitions.

Parameters:

  • obj (Object)

Returns:

  • (Void) 


51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/vapi_server_sdk/types/transfer_destination_sip_message.rb', line 51

def self.validate_raw(obj:)
  begin
    return obj.is_a?(String) != false || raise("Passed value for field obj is not the expected type, validation failed.")
  rescue StandardError
    # noop
  end
  begin
    return Vapi::CustomMessage.validate_raw(obj: obj)
  rescue StandardError
    # noop
  end
  raise("Passed value matched no type within the union, validation failed.")
end