class PureCloud::CallbackMediaParticipant

Attributes

address[RW]

The participant address.

attributes[RW]

A list of ad-hoc attributes for the participant.

automated_callback_config_id[RW]

The id of the config for automatically placing the callback (and handling the disposition). If absent, the callback will not be placed automatically but routed to an agent as per normal.

callback_numbers[RW]

The list of phone number to use for this callback.

callback_scheduled_time[RW]

Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

callback_user_name[RW]

The name of the callback target.

connected_time[RW]

The time when this participant went connected for this media (eg: video connected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

direction[RW]

The participant's direction. Values can be: 'inbound' or 'outbound'

disconnect_type[RW]

The reason the participant was disconnected from the conversation.

end_time[RW]

The time when this participant went disconnected for this media (eg: video disconnected time). Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

error_info[RW]

If the conversation ends in error, contains additional error details.

external_contact[RW]

If this participant represents an external contact, then this will be the reference for the external contact.

external_organization[RW]

If this participant represents an external org, then this will be the reference for the external org.

held[RW]

Value is true when the participant is on hold.

id[RW]

The unique participant ID.

name[RW]

The display friendly name of the participant.

outbound_preview[RW]

The outbound preview associated with this callback.

provider[RW]

The source provider for the communication.

purpose[RW]

The participant's purpose. Values can be: 'agent', 'user', 'customer', 'external', 'acd', 'ivr

queue[RW]

The PureCloud queue for this participant.

script[RW]

The Engage script that should be used by this participant.

skip_enabled[RW]

If true, the callback can be skipped

start_hold_time[RW]

The time when this participant's hold started. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

start_time[RW]

The time when this participant first joined the conversation. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ

state[RW]

The participant's state. Values can be: 'alerting', 'connected', 'disconnected', 'dialing', 'contacting

timeout_seconds[RW]

Duration in seconds before the callback will be auto-dialed.

user[RW]

The PureCloud user for this participant.

wrapup[RW]

Wrapup for this participant, if it has been applied.

wrapup_prompt[RW]

The wrap-up prompt indicating the type of wrap-up to be performed.

wrapup_required[RW]

Value is true when the participant requires wrap-up.

wrapup_skipped[RW]

Value is true when the participant has skipped wrap-up.

wrapup_timeout_ms[RW]

The amount of time the participant has to complete wrap-up.

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/purecloud/models/callback_media_participant.rb, line 118
def self.attribute_map
  {
    
    :'id' => :'id',
    
    :'name' => :'name',
    
    :'address' => :'address',
    
    :'start_time' => :'startTime',
    
    :'connected_time' => :'connectedTime',
    
    :'end_time' => :'endTime',
    
    :'start_hold_time' => :'startHoldTime',
    
    :'purpose' => :'purpose',
    
    :'state' => :'state',
    
    :'direction' => :'direction',
    
    :'disconnect_type' => :'disconnectType',
    
    :'held' => :'held',
    
    :'wrapup_required' => :'wrapupRequired',
    
    :'wrapup_prompt' => :'wrapupPrompt',
    
    :'user' => :'user',
    
    :'queue' => :'queue',
    
    :'attributes' => :'attributes',
    
    :'error_info' => :'errorInfo',
    
    :'script' => :'script',
    
    :'wrapup_timeout_ms' => :'wrapupTimeoutMs',
    
    :'wrapup_skipped' => :'wrapupSkipped',
    
    :'provider' => :'provider',
    
    :'external_contact' => :'externalContact',
    
    :'external_organization' => :'externalOrganization',
    
    :'wrapup' => :'wrapup',
    
    :'outbound_preview' => :'outboundPreview',
    
    :'callback_numbers' => :'callbackNumbers',
    
    :'callback_user_name' => :'callbackUserName',
    
    :'skip_enabled' => :'skipEnabled',
    
    :'timeout_seconds' => :'timeoutSeconds',
    
    :'automated_callback_config_id' => :'automatedCallbackConfigId',
    
    :'callback_scheduled_time' => :'callbackScheduledTime'
    
  }
end
new(attributes = {}) click to toggle source
# File lib/purecloud/models/callback_media_participant.rb, line 227
def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}

  
  if attributes[:'id']
    self.id = attributes[:'id']
  end
  
  if attributes[:'name']
    self.name = attributes[:'name']
  end
  
  if attributes[:'address']
    self.address = attributes[:'address']
  end
  
  if attributes[:'startTime']
    self.start_time = attributes[:'startTime']
  end
  
  if attributes[:'connectedTime']
    self.connected_time = attributes[:'connectedTime']
  end
  
  if attributes[:'endTime']
    self.end_time = attributes[:'endTime']
  end
  
  if attributes[:'startHoldTime']
    self.start_hold_time = attributes[:'startHoldTime']
  end
  
  if attributes[:'purpose']
    self.purpose = attributes[:'purpose']
  end
  
  if attributes[:'state']
    self.state = attributes[:'state']
  end
  
  if attributes[:'direction']
    self.direction = attributes[:'direction']
  end
  
  if attributes[:'disconnectType']
    self.disconnect_type = attributes[:'disconnectType']
  end
  
  if attributes[:'held']
    self.held = attributes[:'held']
  end
  
  if attributes[:'wrapupRequired']
    self.wrapup_required = attributes[:'wrapupRequired']
  end
  
  if attributes[:'wrapupPrompt']
    self.wrapup_prompt = attributes[:'wrapupPrompt']
  end
  
  if attributes[:'user']
    self.user = attributes[:'user']
  end
  
  if attributes[:'queue']
    self.queue = attributes[:'queue']
  end
  
  if attributes[:'attributes']
    if (value = attributes[:'attributes']).is_a?(Array)
      self.attributes = value
    end
  end
  
  if attributes[:'errorInfo']
    self.error_info = attributes[:'errorInfo']
  end
  
  if attributes[:'script']
    self.script = attributes[:'script']
  end
  
  if attributes[:'wrapupTimeoutMs']
    self.wrapup_timeout_ms = attributes[:'wrapupTimeoutMs']
  end
  
  if attributes[:'wrapupSkipped']
    self.wrapup_skipped = attributes[:'wrapupSkipped']
  end
  
  if attributes[:'provider']
    self.provider = attributes[:'provider']
  end
  
  if attributes[:'externalContact']
    self.external_contact = attributes[:'externalContact']
  end
  
  if attributes[:'externalOrganization']
    self.external_organization = attributes[:'externalOrganization']
  end
  
  if attributes[:'wrapup']
    self.wrapup = attributes[:'wrapup']
  end
  
  if attributes[:'outboundPreview']
    self.outbound_preview = attributes[:'outboundPreview']
  end
  
  if attributes[:'callbackNumbers']
    if (value = attributes[:'callbackNumbers']).is_a?(Array)
      self.callback_numbers = value
    end
  end
  
  if attributes[:'callbackUserName']
    self.callback_user_name = attributes[:'callbackUserName']
  end
  
  if attributes[:'skipEnabled']
    self.skip_enabled = attributes[:'skipEnabled']
  end
  
  if attributes[:'timeoutSeconds']
    self.timeout_seconds = attributes[:'timeoutSeconds']
  end
  
  if attributes[:'automatedCallbackConfigId']
    self.automated_callback_config_id = attributes[:'automatedCallbackConfigId']
  end
  
  if attributes[:'callbackScheduledTime']
    self.callback_scheduled_time = attributes[:'callbackScheduledTime']
  end
  
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/purecloud/models/callback_media_participant.rb, line 189
def self.swagger_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'address' => :'String',
    :'start_time' => :'DateTime',
    :'connected_time' => :'DateTime',
    :'end_time' => :'DateTime',
    :'start_hold_time' => :'DateTime',
    :'purpose' => :'String',
    :'state' => :'String',
    :'direction' => :'String',
    :'disconnect_type' => :'String',
    :'held' => :'BOOLEAN',
    :'wrapup_required' => :'BOOLEAN',
    :'wrapup_prompt' => :'String',
    :'user' => :'UriReference',
    :'queue' => :'UriReference',
    :'attributes' => :'Hash<String, String>',
    :'error_info' => :'ErrorBody',
    :'script' => :'UriReference',
    :'wrapup_timeout_ms' => :'Integer',
    :'wrapup_skipped' => :'BOOLEAN',
    :'provider' => :'String',
    :'external_contact' => :'UriReference',
    :'external_organization' => :'UriReference',
    :'wrapup' => :'Wrapup',
    :'outbound_preview' => :'DialerPreview',
    :'callback_numbers' => :'Array<String>',
    :'callback_user_name' => :'String',
    :'skip_enabled' => :'BOOLEAN',
    :'timeout_seconds' => :'Integer',
    :'automated_callback_config_id' => :'String',
    :'callback_scheduled_time' => :'DateTime'
    
  }
end

Public Instance Methods

==(o) click to toggle source

Check equality by comparing each attribute.

# File lib/purecloud/models/callback_media_participant.rb, line 396
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      address == o.address &&
      start_time == o.start_time &&
      connected_time == o.connected_time &&
      end_time == o.end_time &&
      start_hold_time == o.start_hold_time &&
      purpose == o.purpose &&
      state == o.state &&
      direction == o.direction &&
      disconnect_type == o.disconnect_type &&
      held == o.held &&
      wrapup_required == o.wrapup_required &&
      wrapup_prompt == o.wrapup_prompt &&
      user == o.user &&
      queue == o.queue &&
      attributes == o.attributes &&
      error_info == o.error_info &&
      script == o.script &&
      wrapup_timeout_ms == o.wrapup_timeout_ms &&
      wrapup_skipped == o.wrapup_skipped &&
      provider == o.provider &&
      external_contact == o.external_contact &&
      external_organization == o.external_organization &&
      wrapup == o.wrapup &&
      outbound_preview == o.outbound_preview &&
      callback_numbers == o.callback_numbers &&
      callback_user_name == o.callback_user_name &&
      skip_enabled == o.skip_enabled &&
      timeout_seconds == o.timeout_seconds &&
      automated_callback_config_id == o.automated_callback_config_id &&
      callback_scheduled_time == o.callback_scheduled_time
end
_deserialize(type, value) click to toggle source
# File lib/purecloud/models/callback_media_participant.rb, line 463
def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /^(true|t|yes|y|1)$/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    _model = Object.const_get("PureCloud").const_get(type).new
    _model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

Method to output non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

# File lib/purecloud/models/callback_media_participant.rb, line 523
def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map{ |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end
build_from_hash(attributes) click to toggle source

build the object from hash

# File lib/purecloud/models/callback_media_participant.rb, line 444
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /^Array<(.*)>/i
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
      else
        #TODO show warning in debug mode
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    else
      # data not found in attributes(hash), not an issue as the data can be optional
    end
  end

  self
end
direction=(direction) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/callback_media_participant.rb, line 378
def direction=(direction)
  allowed_values = ["inbound", "outbound"]
  if direction && !allowed_values.include?(direction)
    fail "invalid value for 'direction', must be one of #{allowed_values}"
  end
  @direction = direction
end
disconnect_type=(disconnect_type) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/callback_media_participant.rb, line 387
def disconnect_type=(disconnect_type)
  allowed_values = ["endpoint", "client", "system", "transfer", "transfer.conference", "transfer.consult", "transfer.forward", "transfer.noanswer", "transfer.notavailable", "transport.failure", "error", "peer", "other", "spam"]
  if disconnect_type && !allowed_values.include?(disconnect_type)
    fail "invalid value for 'disconnect_type', must be one of #{allowed_values}"
  end
  @disconnect_type = disconnect_type
end
eql?(o) click to toggle source

@see the `==` method

# File lib/purecloud/models/callback_media_participant.rb, line 434
def eql?(o)
  self == o
end
hash() click to toggle source

Calculate hash code according to all attributes.

# File lib/purecloud/models/callback_media_participant.rb, line 439
def hash
  [id, name, address, start_time, connected_time, end_time, start_hold_time, purpose, state, direction, disconnect_type, held, wrapup_required, wrapup_prompt, user, queue, attributes, error_info, script, wrapup_timeout_ms, wrapup_skipped, provider, external_contact, external_organization, wrapup, outbound_preview, callback_numbers, callback_user_name, skip_enabled, timeout_seconds, automated_callback_config_id, callback_scheduled_time].hash
end
state=(state) click to toggle source

Custom attribute writer method checking allowed values (enum).

# File lib/purecloud/models/callback_media_participant.rb, line 369
def state=(state)
  allowed_values = ["alerting", "dialing", "contacting", "offering", "connected", "disconnected", "terminated", "converting", "uploading", "transmitting", "none"]
  if state && !allowed_values.include?(state)
    fail "invalid value for 'state', must be one of #{allowed_values}"
  end
  @state = state
end
to_body() click to toggle source

to_body is an alias to to_body (backward compatibility))

# File lib/purecloud/models/callback_media_participant.rb, line 506
def to_body
  to_hash
end
to_hash() click to toggle source

return the object in the form of hash

# File lib/purecloud/models/callback_media_participant.rb, line 511
def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end
to_s() click to toggle source
# File lib/purecloud/models/callback_media_participant.rb, line 501
def to_s
  to_hash.to_s
end