class Bandwidth::CreateCallRequest

CreateCallRequest Model.

Attributes

answer_fallback_method[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [AnswerFallbackMethodEnum]

answer_fallback_url[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [String]

answer_method[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [AnswerMethodEnum]

answer_url[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [String]

application_id[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [String]

call_timeout[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [Float]

callback_timeout[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [Float]

disconnect_method[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [DisconnectMethodEnum]

disconnect_url[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [String]

fallback_password[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [String]

fallback_username[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [String]

from[RW]

Format is E164 @return [String]

password[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [String]

tag[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [String]

to[RW]

Format is E164 or SIP URI @return [String]

username[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [String]

uui[RW]

When calling a SIP URI, this will be sent as the 'User-To-User' header within the initial INVITE. It must end with an 'encoding' parameter as described in tools.ietf.org/html/rfc7433. This header cannot exceed 256 characters, including the encoding parameter. @return [String]

Public Class Methods

from_hash(hash) click to toggle source

Creates an instance of the object from a hash.

# File lib/bandwidth/voice_lib/voice/models/create_call_request.rb, line 182
def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  from = hash['from']
  to = hash['to']
  answer_url = hash['answerUrl']
  application_id = hash['applicationId']
  uui = hash['uui']
  call_timeout = hash['callTimeout']
  callback_timeout = hash['callbackTimeout']
  answer_fallback_url = hash['answerFallbackUrl']
  username = hash['username']
  password = hash['password']
  fallback_username = hash['fallbackUsername']
  fallback_password = hash['fallbackPassword']
  answer_method = hash['answerMethod']
  answer_fallback_method = hash['answerFallbackMethod']
  disconnect_url = hash['disconnectUrl']
  disconnect_method = hash['disconnectMethod']
  tag = hash['tag']

  # Create object from extracted values.
  CreateCallRequest.new(from,
                        to,
                        answer_url,
                        application_id,
                        uui,
                        call_timeout,
                        callback_timeout,
                        answer_fallback_url,
                        username,
                        password,
                        fallback_username,
                        fallback_password,
                        answer_method,
                        answer_fallback_method,
                        disconnect_url,
                        disconnect_method,
                        tag)
end
names() click to toggle source

A mapping from model property names to API property names.

# File lib/bandwidth/voice_lib/voice/models/create_call_request.rb, line 123
def self.names
  @_hash = {} if @_hash.nil?
  @_hash['from'] = 'from'
  @_hash['to'] = 'to'
  @_hash['uui'] = 'uui'
  @_hash['call_timeout'] = 'callTimeout'
  @_hash['callback_timeout'] = 'callbackTimeout'
  @_hash['answer_url'] = 'answerUrl'
  @_hash['answer_fallback_url'] = 'answerFallbackUrl'
  @_hash['username'] = 'username'
  @_hash['password'] = 'password'
  @_hash['fallback_username'] = 'fallbackUsername'
  @_hash['fallback_password'] = 'fallbackPassword'
  @_hash['answer_method'] = 'answerMethod'
  @_hash['answer_fallback_method'] = 'answerFallbackMethod'
  @_hash['disconnect_url'] = 'disconnectUrl'
  @_hash['disconnect_method'] = 'disconnectMethod'
  @_hash['tag'] = 'tag'
  @_hash['application_id'] = 'applicationId'
  @_hash
end
new(from = nil, to = nil, answer_url = nil, application_id = nil, uui = nil, call_timeout = nil, callback_timeout = nil, answer_fallback_url = nil, username = nil, password = nil, fallback_username = nil, fallback_password = nil, answer_method = nil, answer_fallback_method = nil, disconnect_url = nil, disconnect_method = nil, tag = nil) click to toggle source
# File lib/bandwidth/voice_lib/voice/models/create_call_request.rb, line 145
def initialize(from = nil,
               to = nil,
               answer_url = nil,
               application_id = nil,
               uui = nil,
               call_timeout = nil,
               callback_timeout = nil,
               answer_fallback_url = nil,
               username = nil,
               password = nil,
               fallback_username = nil,
               fallback_password = nil,
               answer_method = nil,
               answer_fallback_method = nil,
               disconnect_url = nil,
               disconnect_method = nil,
               tag = nil)
  @from = from
  @to = to
  @uui = uui
  @call_timeout = call_timeout
  @callback_timeout = callback_timeout
  @answer_url = answer_url
  @answer_fallback_url = answer_fallback_url
  @username = username
  @password = password
  @fallback_username = fallback_username
  @fallback_password = fallback_password
  @answer_method = answer_method
  @answer_fallback_method = answer_fallback_method
  @disconnect_url = disconnect_url
  @disconnect_method = disconnect_method
  @tag = tag
  @application_id = application_id
end