AddToConference.md

Freeclimb::AddToConference

Properties

Name	Type	Description	Notes
allow_call_control	Boolean	If `true`, Call control will be enabled for this Participant's Call leg.	[optional]
call_control_sequence	String	Defines a sequence of digits that, when entered by this caller, invokes the `callControlUrl`. Only digits plus '*', and '#' may be used.	[optional]
call_control_url	String	URL to be invoked when this Participant enters the digit sequence defined in the `callControlSequence` attribute.	[optional]
conference_id	String	ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result.
leave_conference_url	String	URL to be invoked when the Participant leaves the Conference.	[optional]
listen	Boolean	If `true`, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or `SetListen` PerCL command.	[optional]
notification_url	String	When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters.	[optional]
start_conf_on_enter	Boolean	Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants.	[optional]
talk	Boolean	If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command.	[optional]
dtmf_pass_through	Boolean	If `true`, the Participant joins the Conference with dtmfPassThrough privileges. This may be modified later via the REST API or `SetDTMFPassThrough` PerCL command.	[optional]

Example

require 'freeclimb'

instance = Freeclimb::AddToConference.new(
  allow_call_control: null,
  call_control_sequence: null,
  call_control_url: null,
  conference_id: null,
  leave_conference_url: null,
  listen: null,
  notification_url: null,
  start_conf_on_enter: null,
  talk: null,
  dtmf_pass_through: null
)