Class: OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent::Data

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb,
sig/openai/models/webhooks/realtime_call_incoming_webhook_event.rbs

Overview

See Also:

  • OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent#data

Defined Under Namespace

Modules: SipMediaSecurity Classes: SipHeader

Instance Attribute Summary collapse

Attributes inherited from Internal::Type::BaseModel

#last_response

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], #_request_id, #_set_last_response, coerce, #deconstruct_keys, #deep_to_h, dump, #encode_with, fields, hash, #hash, inherited, #inspect, inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, coerce_with_error, dump, #dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(name:, value:) ⇒ Object

Parameters:

  • call_id —

    The ID of the pending SIP call. Pass this value unchanged when accepting or rejecting the call through the Realtime API. For the Live API, use the session_id from live.transport.incoming instead.

  • sip_headers —

    Headers from the SIP INVITE, excluding SIP authorization headers. Retained names, values, repeated entries, and order are preserved. Treat these values as untrusted call metadata.

  • sip_media_security —

    Media protection selected on the SIP leg during SDP negotiation. srtp indicates SRTP; rtp indicates unencrypted RTP. Omitted when unknown. This does not describe SIP signaling security or confirm that media has flowed. Clients should handle unrecognized values as unknown.




# File 'lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb', line 121

Instance Attribute Details

#call_id ⇒ String

The ID of the pending SIP call. Pass this value unchanged when accepting or rejecting the call through the Realtime API. For the Live API, use the session_id from live.transport.incoming instead.

Returns:

  • (String) 


65
 
# File 'lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb', line 65

required :call_id, String

#sip_headers ⇒ ::Array[OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data::SipHeader]

Headers from the SIP INVITE, excluding SIP authorization headers. Retained names, values, repeated entries, and order are preserved. Treat these values as untrusted call metadata.

Returns:

  • (::Array[OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data::SipHeader]) 


73
74
75
76
 
# File 'lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb', line 73

required(
  :sip_headers,
  -> { OpenAI::Internal::Type::ArrayOf[OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data::SipHeader] }
)

#sip_media_security ⇒ OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent::Data::sip_media_security?

Media protection selected on the SIP leg during SDP negotiation. srtp indicates SRTP; rtp indicates unencrypted RTP. Omitted when unknown. This does not describe SIP signaling security or confirm that media has flowed. Clients should handle unrecognized values as unknown.

Returns:

  • (OpenAI::Models::Webhooks::RealtimeCallIncomingWebhookEvent::Data::sip_media_security, nil) 


85
86
87
88
 
# File 'lib/openai/models/webhooks/realtime_call_incoming_webhook_event.rb', line 85

optional(
  :sip_media_security,
  union: -> { OpenAI::Webhooks::RealtimeCallIncomingWebhookEvent::Data::SipMediaSecurity }
)

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


111
 
# File 'sig/openai/models/webhooks/realtime_call_incoming_webhook_event.rbs', line 111

def to_hash: -> {