Class: SkypeR::Object::Call

Inherits:
Base
  • Object
show all
Defined in:
lib/skyper/object.rb

Overview

CALL object

The CALL object has the following properties:

* TIMESTAMP - time when call was placed (UNIX timestamp), for example CALL 17 TIMESTAMP 1078958218
* PARTNER_HANDLE - for example CALL 17 PARTNER_HANDLE mike
* PARTNER_DISPNAME - for example CALL 17 PARTNER_DISPNAME Mike Mann
* TARGET_IDENTITY - This property is set when you a) have a SkypeIn number and b) receive an incoming PSTN call. The value of call's target identity property is then set to your own SkypeIn number. This property is not set if the incoming call is P2P. This property was introduced in API version 3.1
* CONF_ID - if the CONF_ID>0 the call is a conference call, for example: CALL 17 CONF_ID 0
* TYPE - call type, for example: CALL 17 TYPE OUTGOING_PSTN . Possible values:
      o INCOMING_PSTN - incoming call from PSTN
      o OUTGOING_PSTN - outgoing call to PSTN
      o INCOMING_P2P - incoming call from P2P
      o OUTGOING_P2P - outgoing call to P2P 
* STATUS - call status, for example: CALL 17 STATUS FAILED . Possible values:
      o UNPLACED - call was never placed
      o ROUTING - call is currently being routed
      o EARLYMEDIA - with pstn it is possible that before a call is established, early media is played. For example it can be a calling tone or a waiting message such as all operators are busy.
      o FAILED - call failed - try to get a FAILUREREASON for more information.
      o RINGING - currently ringing
      o INPROGRESS - call is in progress
      o ONHOLD - call is placed on hold
      o FINISHED - call is finished
      o MISSED - call was missed
      o REFUSED - call was refused
      o BUSY - destination was busy
      o CANCELLED (Protocol 2)
      o TRANSFERRING - Refer to ALTER CALL TRANSFER command. Added in protocol 7 (API version 3.0)
      o TRANSFERRED - Refer to ALTER CALL TRANSFER command. Added in protocol 7 (API version 3.0)
      o VM_BUFFERING_GREETING - voicemail greeting is being downloaded
      o VM_PLAYING_GREETING - voicemail greeting is being played
      o VM_RECORDING - voicemail is being recorded
      o VM_UPLOADING - voicemail recording is finished and uploaded into server
      o VM_SENT - voicemail has successfully been sent
      o VM_CANCELLED - leaving voicemail has been cancelled
      o VM_FAILED - leaving voicemail failed; check FAILUREREASON
      o WAITING_REDIAL_COMMAND - This status is set when your outgoing call to PSTN gets rejected by remote party. This state was added in version 3.5 (protocol 8).
      o REDIAL_PENDING - This status is set when you press redial button on the Call Phones tab of the Skype interface. This state was added in version 3.5 (protocol 8). 
* VIDEO_STATUS - possible values:
      o VIDEO_NONE
      o VIDEO_SEND_ENABLED
      o VIDEO_RECV_ENABLED
      o VIDEO_BOTH_ENABLED 
* VIDEO_SEND_STATUS and VIDEO_RECEIVE_STATUS - possible values:
      o NOT_AVAILABLE - the client does not have video capability because video is disabled or a webcam is unplugged).
      o AVAILABLE - the client is video-capable but the video is not running (can occur during a manual send).
      o STARTING - the video is sending but is not yet running at full speed.
      o REJECTED - the receiver rejects the video feed (can occur during a manual receive).
      o RUNNING - the video is actively running.
      o STOPPING - the active video is in the process of stopping but has not halted yet.
      o PAUSED - the video call is placed on hold. 
* FAILUREREASON - example: CALL 17 FAILUREREASON 1 (numeric).
* SUBJECT - not used.
* PSTN_NUMBER - example: CALL 17 PSTN_NUMBER 372123123 .
* DURATION - example: CALL 17 DURATION 0 .
* PSTN_STATUS - error string from gateway, in the case of a PSTN call, for example: CALL 26 PSTN_STATUS 6500 PSTN connection creation timeout .
* CONF_PARTICIPANTS_COUNT - number of non-hosts in the case of a conference call. Possible values are:
      o 0 - call is not a conference. For the host, CONF_PARTICIPANTS_COUNT is always 0.
      o 1 - call is a former conference.
      o 2, 3, 4 - call is a conference. Note that from 2.5 and upwards, Skype API manages conference participation in a slightly different manner. In newer versions, after the call is finished, the CONF_PARTICIPANTS_COUNT reports highest number of participants the call had at any given time. 
* CONF_PARTICIPANT n - the username of the nth participant in a conference call, the call type and status and the displayname of participants who are not the host. For example: CALL 59 CONF_PARTICIPANT 1 echo123 INCOMING_P2P INPROGRESS Echo Test Service .
* VM_DURATION
* VM_ALLOWED_DURATION - maximum duration in seconds allowed to leave voicemail
* RATE – expressed as cost per minute (added in protocol 6).
* RATE_CURRENCY - EUR|USD.. This property gets populated from currency selected in Skype account details - PSTN_BALANCE_CURRENCY property of the PROFILE object. However, the value of PSTN_BALANCE_CURRENCY can change in time (added in protocol 6).
* RATE_PRECISION – the number of times to divide RATE by 10 to get the full currency unit. For example, a RATE of 1234 with RATE_PRECISION of 2 amounts to 12.34 (added in protocol 6).
* INPUT - New in API version 2.6 Refer to Voice Streams section for more information. Can have following values:
      o SOUNDCARD="default" - default is currently the only acceptable value.
      o PORT="port_no" - the ID of the audio port (1..65535)
      o FILE="filename.wav" - the path and name of the audio file. 
* OUTPUT - can have all the same values as INPUT property. Refer to Voice Streams section for more information. New in API version 2.6
* CAPTURE_MIC - can have all the same values as INPUT and OUTPUT properties. Refer to Voice Streams section for more information. New in API version 2.6
* VAA_INPUT_STATUS - true|false, indicates if voice input is enabled. New in API version 2.6
* FORWARDED_BY - Contains identity of the user who forwarded a call. If the user who forwarded the call could not be identified then this property will be set to "?". New in API version 2.6
* TRANSFER_ACTIVE - Refer to ALTER CALL TRANSFER command. Added in protocol 7 (API version 3.0)
* TRANSFER_STATUS - Refer to ALTER CALL TRANSFER command. Added in protocol 7 (API version 3.0)
* TRANSFERRED_BY - Refer to ALTER CALL TRANSFER command. Added in protocol 7 (API version 3.0)
* TRANSFERRED_TO - Refer to ALTER CALL TRANSFER command. Added in protocol 7 (API version 3.0)

Notes

* Status values for voicemails ( VM_xxx ) and VM_DURATION/VM_ALLOWED_DURATION apply to calls which are forwarded into voicemail. This feature was introduced in protocol 5.

Most call properties are read-only. The following properties are read-write and can be modified with the SET command:

* STATUS - for call control. Possible values:
      o ONHOLD - hold call
      o INPROGRESS - answer or resume call
      o FINISHED - hang up call 
* SEEN - sets call as seen, so that a missed call is seen and can be removed from the missed calls list.
* DTMF - sends VALUE as DTMF. Permitted symbols in VALUE are: {0..9,#,*}.
* JOIN_CONFERENCE - joins call with another call into conference. VALUE is the ID of another call.
* START_VIDEO_SEND - starts sending video on a call.
* STOP_VIDEO_SEND - stops sending video on a call.
* START_VIDEO_RECEIVE - starts receiving video on a call.
* STOP_VIDEO_RECEIVE - stops receiving video on a call.

Constant Summary collapse

PROPERTIES = 
%w{TIMESTAMP  PARTNER_HANDLE   PARTNER_DISPNAME  TARGET_IDENTITY  CONF_ID  TYPE  STATUS  VIDEO_STATUS  VIDEO_SEND_STATUS  FAILUREREASON  SUBJECT  PSTN_NUMBER  DURATION  PSTN_STATUS  CONF_PARTICIPANTS_COUNT  CONF_PARTICIPANT  VM_DURATION  VM_ALLOWED_DURATION  RATE  RATE_CURRENCY  RATE_PRECISION  INPUT  OUTPUT  CAPTURE_MIC  VAA_INPUT_STATUS  FORWARDED_BY  TRANSFER_ACTIVE  TRANSFER_STATUS  TRANSFERRED_BY  TRANSFERRED_TO}

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Base

#update_attributes

Constructor Details

#initialize ⇒ Call

Returns a new instance of Call.



265
266
 
# File 'lib/skyper/object.rb', line 265

def initialize
end

Instance Attribute Details

#capture_mic ⇒ Object

Returns the value of attribute capture_mic.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def capture_mic
  @capture_mic
end

#conf_id ⇒ Object

Returns the value of attribute conf_id.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def conf_id
  @conf_id
end

#conf_participant ⇒ Object

Returns the value of attribute conf_participant.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def conf_participant
  @conf_participant
end

#conf_participants_count ⇒ Object

Returns the value of attribute conf_participants_count.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def conf_participants_count
  @conf_participants_count
end

#duration ⇒ Object

Returns the value of attribute duration.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def duration
  @duration
end

#failurereason ⇒ Object

Returns the value of attribute failurereason.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def failurereason
  @failurereason
end

#forwarded_by ⇒ Object

Returns the value of attribute forwarded_by.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def forwarded_by
  @forwarded_by
end

#input ⇒ Object

Returns the value of attribute input.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def input
  @input
end

#output ⇒ Object

Returns the value of attribute output.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def output
  @output
end

#partner_dispname ⇒ Object

Returns the value of attribute partner_dispname.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def partner_dispname
  @partner_dispname
end

#partner_handle ⇒ Object

Returns the value of attribute partner_handle.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def partner_handle
  @partner_handle
end

#pstn_number ⇒ Object

Returns the value of attribute pstn_number.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def pstn_number
  @pstn_number
end

#pstn_status ⇒ Object

Returns the value of attribute pstn_status.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def pstn_status
  @pstn_status
end

#rate ⇒ Object

Returns the value of attribute rate.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def rate
  @rate
end

#rate_currency ⇒ Object

Returns the value of attribute rate_currency.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def rate_currency
  @rate_currency
end

#rate_precision ⇒ Object

Returns the value of attribute rate_precision.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def rate_precision
  @rate_precision
end

#status ⇒ Object

Returns the value of attribute status.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def status
  @status
end

#subject ⇒ Object

Returns the value of attribute subject.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def subject
  @subject
end

#target_identity ⇒ Object

Returns the value of attribute target_identity.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def target_identity
  @target_identity
end

#timestamp ⇒ Object

Returns the value of attribute timestamp.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def timestamp
  @timestamp
end

#transfer_active ⇒ Object

Returns the value of attribute transfer_active.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def transfer_active
  @transfer_active
end

#transfer_status ⇒ Object

Returns the value of attribute transfer_status.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def transfer_status
  @transfer_status
end

#transferred_by ⇒ Object

Returns the value of attribute transferred_by.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def transferred_by
  @transferred_by
end

#transferred_to ⇒ Object

Returns the value of attribute transferred_to.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def transferred_to
  @transferred_to
end

#type ⇒ Object

Returns the value of attribute type.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def type
  @type
end

#vaa_input_status ⇒ Object

Returns the value of attribute vaa_input_status.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def vaa_input_status
  @vaa_input_status
end

#video_send_status ⇒ Object

Returns the value of attribute video_send_status.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def video_send_status
  @video_send_status
end

#video_status ⇒ Object

Returns the value of attribute video_status.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def video_status
  @video_status
end

#vm_allowed_duration ⇒ Object

Returns the value of attribute vm_allowed_duration.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def vm_allowed_duration
  @vm_allowed_duration
end

#vm_duration ⇒ Object

Returns the value of attribute vm_duration.



262
263
264
 
# File 'lib/skyper/object.rb', line 262

def vm_duration
  @vm_duration
end