class Twilio::ConferencesApi
- Twilio::ConferencesApi
- Reference
- Object
Defined in:
twilio/api/conferences_api.crConstant Summary
-
CREATE_PARTICIPANT_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
CREATE_PARTICIPANT_MAX_LENGTH_FOR_BYOC =
34
-
CREATE_PARTICIPANT_MAX_LENGTH_FOR_CALL_SID_TO_COACH =
34
-
CREATE_PARTICIPANT_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
CREATE_PARTICIPANT_MIN_LENGTH_FOR_BYOC =
34
-
CREATE_PARTICIPANT_MIN_LENGTH_FOR_CALL_SID_TO_COACH =
34
-
CREATE_PARTICIPANT_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
CREATE_PARTICIPANT_PATTERN_FOR_BYOC =
/^BY[0-9a-fA-F]{32}$/
-
CREATE_PARTICIPANT_PATTERN_FOR_CALL_SID_TO_COACH =
/^CA[0-9a-fA-F]{32}$/
-
DELETE_CONFERENCE_RECORDING_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
DELETE_CONFERENCE_RECORDING_MAX_LENGTH_FOR_CONFERENCE_SID =
34
-
DELETE_CONFERENCE_RECORDING_MAX_LENGTH_FOR_SID =
34
-
DELETE_CONFERENCE_RECORDING_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
DELETE_CONFERENCE_RECORDING_MIN_LENGTH_FOR_CONFERENCE_SID =
34
-
DELETE_CONFERENCE_RECORDING_MIN_LENGTH_FOR_SID =
34
-
DELETE_CONFERENCE_RECORDING_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
DELETE_CONFERENCE_RECORDING_PATTERN_FOR_CONFERENCE_SID =
/^CF[0-9a-fA-F]{32}$/
-
DELETE_CONFERENCE_RECORDING_PATTERN_FOR_SID =
/^RE[0-9a-fA-F]{32}$/
-
DELETE_PARTICIPANT_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
DELETE_PARTICIPANT_MAX_LENGTH_FOR_CONFERENCE_SID =
34
-
DELETE_PARTICIPANT_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
DELETE_PARTICIPANT_MIN_LENGTH_FOR_CONFERENCE_SID =
34
-
DELETE_PARTICIPANT_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
DELETE_PARTICIPANT_PATTERN_FOR_CONFERENCE_SID =
/^CF[0-9a-fA-F]{32}$/
-
FETCH_CONFERENCE_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
FETCH_CONFERENCE_MAX_LENGTH_FOR_SID =
34
-
FETCH_CONFERENCE_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
FETCH_CONFERENCE_MIN_LENGTH_FOR_SID =
34
-
FETCH_CONFERENCE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
FETCH_CONFERENCE_PATTERN_FOR_SID =
/^CF[0-9a-fA-F]{32}$/
-
FETCH_CONFERENCE_RECORDING_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
FETCH_CONFERENCE_RECORDING_MAX_LENGTH_FOR_CONFERENCE_SID =
34
-
FETCH_CONFERENCE_RECORDING_MAX_LENGTH_FOR_SID =
34
-
FETCH_CONFERENCE_RECORDING_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
FETCH_CONFERENCE_RECORDING_MIN_LENGTH_FOR_CONFERENCE_SID =
34
-
FETCH_CONFERENCE_RECORDING_MIN_LENGTH_FOR_SID =
34
-
FETCH_CONFERENCE_RECORDING_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
FETCH_CONFERENCE_RECORDING_PATTERN_FOR_CONFERENCE_SID =
/^CF[0-9a-fA-F]{32}$/
-
FETCH_CONFERENCE_RECORDING_PATTERN_FOR_SID =
/^RE[0-9a-fA-F]{32}$/
-
FETCH_PARTICIPANT_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
FETCH_PARTICIPANT_MAX_LENGTH_FOR_CONFERENCE_SID =
34
-
FETCH_PARTICIPANT_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
FETCH_PARTICIPANT_MIN_LENGTH_FOR_CONFERENCE_SID =
34
-
FETCH_PARTICIPANT_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
FETCH_PARTICIPANT_PATTERN_FOR_CONFERENCE_SID =
/^CF[0-9a-fA-F]{32}$/
-
LIST_CONFERENCE_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_CONFERENCE_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_CONFERENCE_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_CONFERENCE_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_CONFERENCE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_CONFERENCE_RECORDING_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_CONFERENCE_RECORDING_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_CONFERENCE_RECORDING_MAX_LENGTH_FOR_CONFERENCE_SID =
34
-
LIST_CONFERENCE_RECORDING_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_CONFERENCE_RECORDING_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_CONFERENCE_RECORDING_MIN_LENGTH_FOR_CONFERENCE_SID =
34
-
LIST_CONFERENCE_RECORDING_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_CONFERENCE_RECORDING_PATTERN_FOR_CONFERENCE_SID =
/^CF[0-9a-fA-F]{32}$/
-
LIST_PARTICIPANT_MAX_FOR_PAGE_SIZE =
Int32.new("1000")
-
LIST_PARTICIPANT_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_PARTICIPANT_MAX_LENGTH_FOR_CONFERENCE_SID =
34
-
LIST_PARTICIPANT_MIN_FOR_PAGE_SIZE =
Int32.new("1")
-
LIST_PARTICIPANT_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
LIST_PARTICIPANT_MIN_LENGTH_FOR_CONFERENCE_SID =
34
-
LIST_PARTICIPANT_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
LIST_PARTICIPANT_PATTERN_FOR_CONFERENCE_SID =
/^CF[0-9a-fA-F]{32}$/
-
UPDATE_CONFERENCE_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
UPDATE_CONFERENCE_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
UPDATE_CONFERENCE_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
UPDATE_CONFERENCE_RECORDING_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
UPDATE_CONFERENCE_RECORDING_MAX_LENGTH_FOR_CONFERENCE_SID =
34
-
UPDATE_CONFERENCE_RECORDING_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
UPDATE_CONFERENCE_RECORDING_MIN_LENGTH_FOR_CONFERENCE_SID =
34
-
UPDATE_CONFERENCE_RECORDING_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
UPDATE_CONFERENCE_RECORDING_PATTERN_FOR_CONFERENCE_SID =
/^CF[0-9a-fA-F]{32}$/
-
UPDATE_PARTICIPANT_MAX_LENGTH_FOR_ACCOUNT_SID =
34
-
UPDATE_PARTICIPANT_MAX_LENGTH_FOR_CALL_SID_TO_COACH =
34
-
UPDATE_PARTICIPANT_MAX_LENGTH_FOR_CONFERENCE_SID =
34
-
UPDATE_PARTICIPANT_MIN_LENGTH_FOR_ACCOUNT_SID =
34
-
UPDATE_PARTICIPANT_MIN_LENGTH_FOR_CALL_SID_TO_COACH =
34
-
UPDATE_PARTICIPANT_MIN_LENGTH_FOR_CONFERENCE_SID =
34
-
UPDATE_PARTICIPANT_PATTERN_FOR_ACCOUNT_SID =
/^AC[0-9a-fA-F]{32}$/
-
UPDATE_PARTICIPANT_PATTERN_FOR_CALL_SID_TO_COACH =
/^CA[0-9a-fA-F]{32}$/
-
UPDATE_PARTICIPANT_PATTERN_FOR_CONFERENCE_SID =
/^CF[0-9a-fA-F]{32}$/
Constructors
Instance Method Summary
- #account_sid : String
- #account_sid=(account_sid : String)
- #api_client : ApiClient
- #api_client=(api_client : ApiClient)
-
#build_api_request_for_create_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, from : String | Nil = nil, to : String | Nil = nil, amd_status_callback : String | Nil = nil, amd_status_callback_method : Twilio::HttpMethod | Nil = nil, beep : String | Nil = nil, byoc : String | Nil = nil, call_reason : String | Nil = nil, call_sid_to_coach : String | Nil = nil, caller_id : String | Nil = nil, coaching : Bool | Nil = nil, conference_record : String | Nil = nil, conference_recording_status_callback : String | Nil = nil, conference_recording_status_callback_event : Array(String) | Nil = nil, conference_recording_status_callback_method : Twilio::HttpMethod | Nil = nil, conference_status_callback : String | Nil = nil, conference_status_callback_event : Array(String) | Nil = nil, conference_status_callback_method : Twilio::HttpMethod | Nil = nil, conference_trim : String | Nil = nil, early_media : Bool | Nil = nil, end_conference_on_exit : Bool | Nil = nil, jitter_buffer_size : String | Nil = nil, label : String | Nil = nil, machine_detection : String | Nil = nil, machine_detection_silence_timeout : Int32 | Nil = nil, machine_detection_speech_end_threshold : Int32 | Nil = nil, machine_detection_speech_threshold : Int32 | Nil = nil, machine_detection_timeout : Int32 | Nil = nil, max_participants : Int32 | Nil = nil, muted : Bool | Nil = nil, record : Bool | Nil = nil, recording_channels : String | Nil = nil, recording_status_callback : String | Nil = nil, recording_status_callback_event : Array(String) | Nil = nil, recording_status_callback_method : Twilio::HttpMethod | Nil = nil, recording_track : String | Nil = nil, region : String | Nil = nil, sip_auth_password : String | Nil = nil, sip_auth_username : String | Nil = nil, start_conference_on_enter : Bool | Nil = nil, status_callback : String | Nil = nil, status_callback_event : Array(String) | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, time_limit : Int32 | Nil = nil, timeout : Int32 | Nil = nil, wait_method : Twilio::HttpMethod | Nil = nil, wait_url : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_delete_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_delete_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_fetch_conference(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_fetch_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_fetch_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_conference(*, account_sid : String | Nil = @account_sid, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, date_updated : Time | Nil = nil, date_updated_before : Time | Nil = nil, date_updated_after : Time | Nil = nil, friendly_name : String | Nil = nil, status : Twilio::ConferenceEnumStatus | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_list_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, muted : Bool | Nil = nil, hold : Bool | Nil = nil, coaching : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_update_conference(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, announce_method : Twilio::HttpMethod | Nil = nil, announce_url : String | Nil = nil, status : Twilio::ConferenceEnumUpdateStatus | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_update_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil, status : Twilio::CallRecordingEnumStatus | Nil = nil, pause_behavior : String | Nil = nil) : Crest::Request
@return Crest::Request
-
#build_api_request_for_update_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil, announce_method : Twilio::HttpMethod | Nil = nil, announce_url : String | Nil = nil, beep_on_exit : Bool | Nil = nil, call_sid_to_coach : String | Nil = nil, coaching : Bool | Nil = nil, end_conference_on_exit : Bool | Nil = nil, hold : Bool | Nil = nil, hold_method : Twilio::HttpMethod | Nil = nil, hold_url : String | Nil = nil, muted : Bool | Nil = nil, wait_method : Twilio::HttpMethod | Nil = nil, wait_url : String | Nil = nil) : Crest::Request
@return Crest::Request
- #client_side_validation?(*args, **options)
- #client_side_validation?(*args, **options, &)
-
#create_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, from : String | Nil = nil, to : String | Nil = nil, amd_status_callback : String | Nil = nil, amd_status_callback_method : Twilio::HttpMethod | Nil = nil, beep : String | Nil = nil, byoc : String | Nil = nil, call_reason : String | Nil = nil, call_sid_to_coach : String | Nil = nil, caller_id : String | Nil = nil, coaching : Bool | Nil = nil, conference_record : String | Nil = nil, conference_recording_status_callback : String | Nil = nil, conference_recording_status_callback_event : Array(String) | Nil = nil, conference_recording_status_callback_method : Twilio::HttpMethod | Nil = nil, conference_status_callback : String | Nil = nil, conference_status_callback_event : Array(String) | Nil = nil, conference_status_callback_method : Twilio::HttpMethod | Nil = nil, conference_trim : String | Nil = nil, early_media : Bool | Nil = nil, end_conference_on_exit : Bool | Nil = nil, jitter_buffer_size : String | Nil = nil, label : String | Nil = nil, machine_detection : String | Nil = nil, machine_detection_silence_timeout : Int32 | Nil = nil, machine_detection_speech_end_threshold : Int32 | Nil = nil, machine_detection_speech_threshold : Int32 | Nil = nil, machine_detection_timeout : Int32 | Nil = nil, max_participants : Int32 | Nil = nil, muted : Bool | Nil = nil, record : Bool | Nil = nil, recording_channels : String | Nil = nil, recording_status_callback : String | Nil = nil, recording_status_callback_event : Array(String) | Nil = nil, recording_status_callback_method : Twilio::HttpMethod | Nil = nil, recording_track : String | Nil = nil, region : String | Nil = nil, sip_auth_password : String | Nil = nil, sip_auth_username : String | Nil = nil, start_conference_on_enter : Bool | Nil = nil, status_callback : String | Nil = nil, status_callback_event : Array(String) | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, time_limit : Int32 | Nil = nil, timeout : Int32 | Nil = nil, wait_method : Twilio::HttpMethod | Nil = nil, wait_url : String | Nil = nil) : Twilio::ConferenceParticipant
@required @param account_sid [String?] The SID of the Account that will create the resource.
-
#create_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, from : String | Nil = nil, to : String | Nil = nil, amd_status_callback : String | Nil = nil, amd_status_callback_method : Twilio::HttpMethod | Nil = nil, beep : String | Nil = nil, byoc : String | Nil = nil, call_reason : String | Nil = nil, call_sid_to_coach : String | Nil = nil, caller_id : String | Nil = nil, coaching : Bool | Nil = nil, conference_record : String | Nil = nil, conference_recording_status_callback : String | Nil = nil, conference_recording_status_callback_event : Array(String) | Nil = nil, conference_recording_status_callback_method : Twilio::HttpMethod | Nil = nil, conference_status_callback : String | Nil = nil, conference_status_callback_event : Array(String) | Nil = nil, conference_status_callback_method : Twilio::HttpMethod | Nil = nil, conference_trim : String | Nil = nil, early_media : Bool | Nil = nil, end_conference_on_exit : Bool | Nil = nil, jitter_buffer_size : String | Nil = nil, label : String | Nil = nil, machine_detection : String | Nil = nil, machine_detection_silence_timeout : Int32 | Nil = nil, machine_detection_speech_end_threshold : Int32 | Nil = nil, machine_detection_speech_threshold : Int32 | Nil = nil, machine_detection_timeout : Int32 | Nil = nil, max_participants : Int32 | Nil = nil, muted : Bool | Nil = nil, record : Bool | Nil = nil, recording_channels : String | Nil = nil, recording_status_callback : String | Nil = nil, recording_status_callback_event : Array(String) | Nil = nil, recording_status_callback_method : Twilio::HttpMethod | Nil = nil, recording_track : String | Nil = nil, region : String | Nil = nil, sip_auth_password : String | Nil = nil, sip_auth_username : String | Nil = nil, start_conference_on_enter : Bool | Nil = nil, status_callback : String | Nil = nil, status_callback_event : Array(String) | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, time_limit : Int32 | Nil = nil, timeout : Int32 | Nil = nil, wait_method : Twilio::HttpMethod | Nil = nil, wait_url : String | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account that will create the resource.
-
#create_participant_with_http_info(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, from : String | Nil = nil, to : String | Nil = nil, amd_status_callback : String | Nil = nil, amd_status_callback_method : Twilio::HttpMethod | Nil = nil, beep : String | Nil = nil, byoc : String | Nil = nil, call_reason : String | Nil = nil, call_sid_to_coach : String | Nil = nil, caller_id : String | Nil = nil, coaching : Bool | Nil = nil, conference_record : String | Nil = nil, conference_recording_status_callback : String | Nil = nil, conference_recording_status_callback_event : Array(String) | Nil = nil, conference_recording_status_callback_method : Twilio::HttpMethod | Nil = nil, conference_status_callback : String | Nil = nil, conference_status_callback_event : Array(String) | Nil = nil, conference_status_callback_method : Twilio::HttpMethod | Nil = nil, conference_trim : String | Nil = nil, early_media : Bool | Nil = nil, end_conference_on_exit : Bool | Nil = nil, jitter_buffer_size : String | Nil = nil, label : String | Nil = nil, machine_detection : String | Nil = nil, machine_detection_silence_timeout : Int32 | Nil = nil, machine_detection_speech_end_threshold : Int32 | Nil = nil, machine_detection_speech_threshold : Int32 | Nil = nil, machine_detection_timeout : Int32 | Nil = nil, max_participants : Int32 | Nil = nil, muted : Bool | Nil = nil, record : Bool | Nil = nil, recording_channels : String | Nil = nil, recording_status_callback : String | Nil = nil, recording_status_callback_event : Array(String) | Nil = nil, recording_status_callback_method : Twilio::HttpMethod | Nil = nil, recording_track : String | Nil = nil, region : String | Nil = nil, sip_auth_password : String | Nil = nil, sip_auth_username : String | Nil = nil, start_conference_on_enter : Bool | Nil = nil, status_callback : String | Nil = nil, status_callback_event : Array(String) | Nil = nil, status_callback_method : Twilio::HttpMethod | Nil = nil, time_limit : Int32 | Nil = nil, timeout : Int32 | Nil = nil, wait_method : Twilio::HttpMethod | Nil = nil, wait_url : String | Nil = nil) : Tuple(Twilio::ConferenceParticipant, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account that will create the resource.
- #debugging?(*args, **options)
- #debugging?(*args, **options, &)
-
#delete_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil) : Nil
Delete a recording from your account @required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to delete.
-
#delete_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Delete a recording from your account @required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to delete.
-
#delete_conference_recording_with_http_info(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String))
Delete a recording from your account @required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to delete.
-
#delete_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil) : Nil
Kick a participant from a given conference @required @param account_sid [String?] The SID of the Account that created the Participant resources to delete.
-
#delete_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Kick a participant from a given conference @required @param account_sid [String?] The SID of the Account that created the Participant resources to delete.
-
#delete_participant_with_http_info(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil) : Tuple(Nil, Int32, Hash(String, Array(String) | String))
Kick a participant from a given conference @required @param account_sid [String?] The SID of the Account that created the Participant resources to delete.
-
#fetch_conference(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Twilio::Conference
Fetch an instance of a conference @required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to fetch.
-
#fetch_conference(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch an instance of a conference @required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to fetch.
-
#fetch_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil) : Twilio::ConferenceConferenceRecording
Fetch an instance of a recording for a call @required @param account_sid [String?] The SID of the Account that created the Conference Recording resource to fetch.
-
#fetch_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch an instance of a recording for a call @required @param account_sid [String?] The SID of the Account that created the Conference Recording resource to fetch.
-
#fetch_conference_recording_with_http_info(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil) : Tuple(Twilio::ConferenceConferenceRecording, Int32, Hash(String, Array(String) | String))
Fetch an instance of a recording for a call @required @param account_sid [String?] The SID of the Account that created the Conference Recording resource to fetch.
-
#fetch_conference_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil) : Tuple(Twilio::Conference, Int32, Hash(String, Array(String) | String))
Fetch an instance of a conference @required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to fetch.
-
#fetch_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil) : Twilio::ConferenceParticipant
Fetch an instance of a participant @required @param account_sid [String?] The SID of the Account that created the Participant resource to fetch.
-
#fetch_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil, &block : Crest::Response -> ) : Nil
Fetch an instance of a participant @required @param account_sid [String?] The SID of the Account that created the Participant resource to fetch.
-
#fetch_participant_with_http_info(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil) : Tuple(Twilio::ConferenceParticipant, Int32, Hash(String, Array(String) | String))
Fetch an instance of a participant @required @param account_sid [String?] The SID of the Account that created the Participant resource to fetch.
-
#list_conference(*, account_sid : String | Nil = @account_sid, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, date_updated : Time | Nil = nil, date_updated_before : Time | Nil = nil, date_updated_after : Time | Nil = nil, friendly_name : String | Nil = nil, status : Twilio::ConferenceEnumStatus | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListConferenceResponse
Retrieve a list of conferences belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to read.
-
#list_conference(*, account_sid : String | Nil = @account_sid, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, date_updated : Time | Nil = nil, date_updated_before : Time | Nil = nil, date_updated_after : Time | Nil = nil, friendly_name : String | Nil = nil, status : Twilio::ConferenceEnumStatus | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a list of conferences belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to read.
-
#list_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListConferenceRecordingResponse
Retrieve a list of recordings belonging to the call used to make the request @required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to read.
-
#list_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a list of recordings belonging to the call used to make the request @required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to read.
-
#list_conference_recording_with_http_info(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListConferenceRecordingResponse, Int32, Hash(String, Array(String) | String))
Retrieve a list of recordings belonging to the call used to make the request @required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to read.
-
#list_conference_with_http_info(*, account_sid : String | Nil = @account_sid, date_created : Time | Nil = nil, date_created_before : Time | Nil = nil, date_created_after : Time | Nil = nil, date_updated : Time | Nil = nil, date_updated_before : Time | Nil = nil, date_updated_after : Time | Nil = nil, friendly_name : String | Nil = nil, status : Twilio::ConferenceEnumStatus | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListConferenceResponse, Int32, Hash(String, Array(String) | String))
Retrieve a list of conferences belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to read.
-
#list_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, muted : Bool | Nil = nil, hold : Bool | Nil = nil, coaching : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Twilio::ListParticipantResponse
Retrieve a list of participants belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Participant resources to read.
-
#list_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, muted : Bool | Nil = nil, hold : Bool | Nil = nil, coaching : Bool | Nil = nil, page_size : Int32 | Nil = nil, &block : Crest::Response -> ) : Nil
Retrieve a list of participants belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Participant resources to read.
-
#list_participant_with_http_info(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, muted : Bool | Nil = nil, hold : Bool | Nil = nil, coaching : Bool | Nil = nil, page_size : Int32 | Nil = nil) : Tuple(Twilio::ListParticipantResponse, Int32, Hash(String, Array(String) | String))
Retrieve a list of participants belonging to the account used to make the request @required @param account_sid [String?] The SID of the Account that created the Participant resources to read.
-
#update_conference(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, announce_method : Twilio::HttpMethod | Nil = nil, announce_url : String | Nil = nil, status : Twilio::ConferenceEnumUpdateStatus | Nil = nil) : Twilio::Conference
@required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to update.
-
#update_conference(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, announce_method : Twilio::HttpMethod | Nil = nil, announce_url : String | Nil = nil, status : Twilio::ConferenceEnumUpdateStatus | Nil = nil, &block : Crest::Response -> ) : Nil
@required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to update.
-
#update_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil, status : Twilio::CallRecordingEnumStatus | Nil = nil, pause_behavior : String | Nil = nil) : Twilio::ConferenceConferenceRecording
Changes the status of the recording to paused, stopped, or in-progress.
-
#update_conference_recording(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil, status : Twilio::CallRecordingEnumStatus | Nil = nil, pause_behavior : String | Nil = nil, &block : Crest::Response -> ) : Nil
Changes the status of the recording to paused, stopped, or in-progress.
-
#update_conference_recording_with_http_info(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, sid : String | Nil = nil, status : Twilio::CallRecordingEnumStatus | Nil = nil, pause_behavior : String | Nil = nil) : Tuple(Twilio::ConferenceConferenceRecording, Int32, Hash(String, Array(String) | String))
Changes the status of the recording to paused, stopped, or in-progress.
-
#update_conference_with_http_info(*, account_sid : String | Nil = @account_sid, sid : String | Nil = nil, announce_method : Twilio::HttpMethod | Nil = nil, announce_url : String | Nil = nil, status : Twilio::ConferenceEnumUpdateStatus | Nil = nil) : Tuple(Twilio::Conference, Int32, Hash(String, Array(String) | String))
@required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to update.
-
#update_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil, announce_method : Twilio::HttpMethod | Nil = nil, announce_url : String | Nil = nil, beep_on_exit : Bool | Nil = nil, call_sid_to_coach : String | Nil = nil, coaching : Bool | Nil = nil, end_conference_on_exit : Bool | Nil = nil, hold : Bool | Nil = nil, hold_method : Twilio::HttpMethod | Nil = nil, hold_url : String | Nil = nil, muted : Bool | Nil = nil, wait_method : Twilio::HttpMethod | Nil = nil, wait_url : String | Nil = nil) : Twilio::ConferenceParticipant
Update the properties of the participant @required @param account_sid [String?] The SID of the Account that created the Participant resources to update.
-
#update_participant(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil, announce_method : Twilio::HttpMethod | Nil = nil, announce_url : String | Nil = nil, beep_on_exit : Bool | Nil = nil, call_sid_to_coach : String | Nil = nil, coaching : Bool | Nil = nil, end_conference_on_exit : Bool | Nil = nil, hold : Bool | Nil = nil, hold_method : Twilio::HttpMethod | Nil = nil, hold_url : String | Nil = nil, muted : Bool | Nil = nil, wait_method : Twilio::HttpMethod | Nil = nil, wait_url : String | Nil = nil, &block : Crest::Response -> ) : Nil
Update the properties of the participant @required @param account_sid [String?] The SID of the Account that created the Participant resources to update.
-
#update_participant_with_http_info(*, account_sid : String | Nil = @account_sid, conference_sid : String | Nil = nil, call_sid : String | Nil = nil, announce_method : Twilio::HttpMethod | Nil = nil, announce_url : String | Nil = nil, beep_on_exit : Bool | Nil = nil, call_sid_to_coach : String | Nil = nil, coaching : Bool | Nil = nil, end_conference_on_exit : Bool | Nil = nil, hold : Bool | Nil = nil, hold_method : Twilio::HttpMethod | Nil = nil, hold_url : String | Nil = nil, muted : Bool | Nil = nil, wait_method : Twilio::HttpMethod | Nil = nil, wait_url : String | Nil = nil) : Tuple(Twilio::ConferenceParticipant, Int32, Hash(String, Array(String) | String))
Update the properties of the participant @required @param account_sid [String?] The SID of the Account that created the Participant resources to update.
Constructor Detail
Instance Method Detail
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@return Crest::Request
@required @param account_sid [String?] The SID of the Account that will create the resource.
@required @param conference_sid [String?] The SID of the participant's conference.
@required @param from [String?] The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in E.164 format (e.g., +16175551212). Client identifiers are formatted client:name
. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to
parameter is a phone number, from
must also be a phone number. If to
is sip address, this value of from
should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint.
@required @param to [String?] The phone number, SIP address, or Client identifier that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as sip:[email protected]
. Client identifiers are formatted client:name
. Custom parameters may also be specified.
@optional @param amd_status_callback [String?] The URL that we should call using the amd_status_callback_method
to notify customer application whether the call was answered by human, machine or fax.
@optional @param amd_status_callback_method [Twilio::HttpMethod?]
@optional @param beep [String?] Whether to play a notification beep to the conference when the participant joins. Can be: true
, false
, onEnter
, or onExit
. The default value is true
.
@optional @param byoc [String?] The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that byoc
is only meaningful when to
is a phone number; it will otherwise be ignored. (Beta)
@optional @param call_reason [String?] The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)
@optional @param call_sid_to_coach [String?] The SID of the participant who is being coached
. The participant being coached is the only participant who can hear the participant who is coaching
.
@optional @param caller_id [String?] The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in E.164 format (e.g., +16175551212). Client identifiers are formatted client:name
. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to
parameter is a phone number, callerId
must also be a phone number. If to
is sip address, this value of callerId
should be a username portion to be used to populate the From header that is passed to the SIP endpoint.
@optional @param coaching [Bool?] Whether the participant is coaching another call. Can be: true
or false
. If not present, defaults to false
unless call_sid_to_coach
is defined. If true
, call_sid_to_coach
must be defined.
@optional @param conference_record [String?] Whether to record the conference the participant is joining. Can be: true
, false
, record-from-start
, and do-not-record
. The default value is false
.
@optional @param conference_recording_status_callback [String?] The URL we should call using the conference_recording_status_callback_method
when the conference recording is available.
@optional @param conference_recording_status_callback_event [Array(String)?] The conference recording state changes that generate a call to conference_recording_status_callback
. Can be: in-progress
, completed
, failed
, and absent
. Separate multiple values with a space, ex: 'in-progress completed failed'
@optional @param conference_recording_status_callback_method [Twilio::HttpMethod?]
@optional @param conference_status_callback [String?] The URL we should call using the conference_status_callback_method
when the conference events in conference_status_callback_event
occur. Only the value set by the first participant to join the conference is used. Subsequent conference_status_callback
values are ignored.
@optional @param conference_status_callback_event [Array(String)?] The conference state changes that should generate a call to conference_status_callback
. Can be: start
, end
, join
, leave
, mute
, hold
, modify
, speaker
, and announcement
. Separate multiple values with a space. Defaults to start end
.
@optional @param conference_status_callback_method [Twilio::HttpMethod?]
@optional @param conference_trim [String?] Whether to trim leading and trailing silence from your recorded conference audio files. Can be: trim-silence
or do-not-trim
and defaults to trim-silence
.
@optional @param early_media [Bool?] Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: true
or false
and defaults to true
.
@optional @param end_conference_on_exit [Bool?] Whether to end the conference when the participant leaves. Can be: true
or false
and defaults to false
.
@optional @param jitter_buffer_size [String?] Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant's audio is mixed into the conference. Can be: off
, small
, medium
, and large
. Default to large
.
@optional @param label [String?] A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant.
@optional @param machine_detection [String?] Whether to detect if a human, answering machine, or fax has picked up the call. Can be: Enable
or DetectMessageEnd
. Use Enable
if you would like us to return AnsweredBy
as soon as the called party is identified. Use DetectMessageEnd
, if you would like to leave a message on an answering machine. If send_digits
is provided, this parameter is ignored. For more information, see Answering Machine Detection.
@optional @param machine_detection_silence_timeout [Int32?] The number of milliseconds of initial silence after which an unknown
AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.
@optional @param machine_detection_speech_end_threshold [Int32?] The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.
@optional @param machine_detection_speech_threshold [Int32?] The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.
@optional @param machine_detection_timeout [Int32?] The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with AnsweredBy
of unknown
. The default timeout is 30 seconds.
@optional @param max_participants [Int32?] The maximum number of participants in the conference. Can be a positive integer from 2
to 250
. The default value is 250
.
@optional @param muted [Bool?] Whether the agent is muted in the conference. Can be true
or false
and the default is false
.
@optional @param record [Bool?] Whether to record the participant and their conferences, including the time between conferences. Can be true
or false
and the default is false
.
@optional @param recording_channels [String?] The recording channels for the final recording. Can be: mono
or dual
and the default is mono
.
@optional @param recording_status_callback [String?] The URL that we should call using the recording_status_callback_method
when the recording status changes.
@optional @param recording_status_callback_event [Array(String)?] The recording state changes that should generate a call to recording_status_callback
. Can be: started
, in-progress
, paused
, resumed
, stopped
, completed
, failed
, and absent
. Separate multiple values with a space, ex: 'in-progress completed failed'
.
@optional @param recording_status_callback_method [Twilio::HttpMethod?]
@optional @param recording_track [String?] The audio track to record for the call. Can be: inbound
, outbound
or both
. The default is both
. inbound
records the audio that is received by Twilio. outbound
records the audio that is sent from Twilio. both
records the audio that is received and sent by Twilio.
@optional @param region [String?] The region where we should mix the recorded audio. Can be:us1
, ie1
, de1
, sg1
, br1
, au1
, or jp1
.
@optional @param sip_auth_password [String?] The SIP password for authentication.
@optional @param sip_auth_username [String?] The SIP username used for authentication.
@optional @param start_conference_on_enter [Bool?] Whether to start the conference when the participant joins, if it has not already started. Can be: true
or false
and the default is true
. If false
and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
@optional @param status_callback [String?] The URL we should call using the status_callback_method
to send status information to your application.
@optional @param status_callback_event [Array(String)?] The conference state changes that should generate a call to status_callback
. Can be: initiated
, ringing
, answered
, and completed
. Separate multiple values with a space. The default value is completed
.
@optional @param status_callback_method [Twilio::HttpMethod?]
@optional @param time_limit [Int32?] The maximum duration of the call in seconds. Constraints depend on account and configuration.
@optional @param timeout [Int32?] The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5
and 600
, inclusive. The default value is 60
. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds.
@optional @param wait_method [Twilio::HttpMethod?]
@optional @param wait_url [String?] The URL we should call using the wait_method
for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. Learn more about hold music.
@return [Twilio::ConferenceParticipant]
@required @param account_sid [String?] The SID of the Account that will create the resource.
@required @param conference_sid [String?] The SID of the participant's conference.
@required @param from [String?] The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in E.164 format (e.g., +16175551212). Client identifiers are formatted client:name
. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to
parameter is a phone number, from
must also be a phone number. If to
is sip address, this value of from
should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint.
@required @param to [String?] The phone number, SIP address, or Client identifier that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as sip:[email protected]
. Client identifiers are formatted client:name
. Custom parameters may also be specified.
@optional @param amd_status_callback [String?] The URL that we should call using the amd_status_callback_method
to notify customer application whether the call was answered by human, machine or fax.
@optional @param amd_status_callback_method [Twilio::HttpMethod?]
@optional @param beep [String?] Whether to play a notification beep to the conference when the participant joins. Can be: true
, false
, onEnter
, or onExit
. The default value is true
.
@optional @param byoc [String?] The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that byoc
is only meaningful when to
is a phone number; it will otherwise be ignored. (Beta)
@optional @param call_reason [String?] The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)
@optional @param call_sid_to_coach [String?] The SID of the participant who is being coached
. The participant being coached is the only participant who can hear the participant who is coaching
.
@optional @param caller_id [String?] The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in E.164 format (e.g., +16175551212). Client identifiers are formatted client:name
. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to
parameter is a phone number, callerId
must also be a phone number. If to
is sip address, this value of callerId
should be a username portion to be used to populate the From header that is passed to the SIP endpoint.
@optional @param coaching [Bool?] Whether the participant is coaching another call. Can be: true
or false
. If not present, defaults to false
unless call_sid_to_coach
is defined. If true
, call_sid_to_coach
must be defined.
@optional @param conference_record [String?] Whether to record the conference the participant is joining. Can be: true
, false
, record-from-start
, and do-not-record
. The default value is false
.
@optional @param conference_recording_status_callback [String?] The URL we should call using the conference_recording_status_callback_method
when the conference recording is available.
@optional @param conference_recording_status_callback_event [Array(String)?] The conference recording state changes that generate a call to conference_recording_status_callback
. Can be: in-progress
, completed
, failed
, and absent
. Separate multiple values with a space, ex: 'in-progress completed failed'
@optional @param conference_recording_status_callback_method [Twilio::HttpMethod?]
@optional @param conference_status_callback [String?] The URL we should call using the conference_status_callback_method
when the conference events in conference_status_callback_event
occur. Only the value set by the first participant to join the conference is used. Subsequent conference_status_callback
values are ignored.
@optional @param conference_status_callback_event [Array(String)?] The conference state changes that should generate a call to conference_status_callback
. Can be: start
, end
, join
, leave
, mute
, hold
, modify
, speaker
, and announcement
. Separate multiple values with a space. Defaults to start end
.
@optional @param conference_status_callback_method [Twilio::HttpMethod?]
@optional @param conference_trim [String?] Whether to trim leading and trailing silence from your recorded conference audio files. Can be: trim-silence
or do-not-trim
and defaults to trim-silence
.
@optional @param early_media [Bool?] Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: true
or false
and defaults to true
.
@optional @param end_conference_on_exit [Bool?] Whether to end the conference when the participant leaves. Can be: true
or false
and defaults to false
.
@optional @param jitter_buffer_size [String?] Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant's audio is mixed into the conference. Can be: off
, small
, medium
, and large
. Default to large
.
@optional @param label [String?] A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant.
@optional @param machine_detection [String?] Whether to detect if a human, answering machine, or fax has picked up the call. Can be: Enable
or DetectMessageEnd
. Use Enable
if you would like us to return AnsweredBy
as soon as the called party is identified. Use DetectMessageEnd
, if you would like to leave a message on an answering machine. If send_digits
is provided, this parameter is ignored. For more information, see Answering Machine Detection.
@optional @param machine_detection_silence_timeout [Int32?] The number of milliseconds of initial silence after which an unknown
AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.
@optional @param machine_detection_speech_end_threshold [Int32?] The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.
@optional @param machine_detection_speech_threshold [Int32?] The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.
@optional @param machine_detection_timeout [Int32?] The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with AnsweredBy
of unknown
. The default timeout is 30 seconds.
@optional @param max_participants [Int32?] The maximum number of participants in the conference. Can be a positive integer from 2
to 250
. The default value is 250
.
@optional @param muted [Bool?] Whether the agent is muted in the conference. Can be true
or false
and the default is false
.
@optional @param record [Bool?] Whether to record the participant and their conferences, including the time between conferences. Can be true
or false
and the default is false
.
@optional @param recording_channels [String?] The recording channels for the final recording. Can be: mono
or dual
and the default is mono
.
@optional @param recording_status_callback [String?] The URL that we should call using the recording_status_callback_method
when the recording status changes.
@optional @param recording_status_callback_event [Array(String)?] The recording state changes that should generate a call to recording_status_callback
. Can be: started
, in-progress
, paused
, resumed
, stopped
, completed
, failed
, and absent
. Separate multiple values with a space, ex: 'in-progress completed failed'
.
@optional @param recording_status_callback_method [Twilio::HttpMethod?]
@optional @param recording_track [String?] The audio track to record for the call. Can be: inbound
, outbound
or both
. The default is both
. inbound
records the audio that is received by Twilio. outbound
records the audio that is sent from Twilio. both
records the audio that is received and sent by Twilio.
@optional @param region [String?] The region where we should mix the recorded audio. Can be:us1
, ie1
, de1
, sg1
, br1
, au1
, or jp1
.
@optional @param sip_auth_password [String?] The SIP password for authentication.
@optional @param sip_auth_username [String?] The SIP username used for authentication.
@optional @param start_conference_on_enter [Bool?] Whether to start the conference when the participant joins, if it has not already started. Can be: true
or false
and the default is true
. If false
and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
@optional @param status_callback [String?] The URL we should call using the status_callback_method
to send status information to your application.
@optional @param status_callback_event [Array(String)?] The conference state changes that should generate a call to status_callback
. Can be: initiated
, ringing
, answered
, and completed
. Separate multiple values with a space. The default value is completed
.
@optional @param status_callback_method [Twilio::HttpMethod?]
@optional @param time_limit [Int32?] The maximum duration of the call in seconds. Constraints depend on account and configuration.
@optional @param timeout [Int32?] The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5
and 600
, inclusive. The default value is 60
. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds.
@optional @param wait_method [Twilio::HttpMethod?]
@optional @param wait_url [String?] The URL we should call using the wait_method
for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. Learn more about hold music.
@return nil
@required @param account_sid [String?] The SID of the Account that will create the resource.
@required @param conference_sid [String?] The SID of the participant's conference.
@required @param from [String?] The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in E.164 format (e.g., +16175551212). Client identifiers are formatted client:name
. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to
parameter is a phone number, from
must also be a phone number. If to
is sip address, this value of from
should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint.
@required @param to [String?] The phone number, SIP address, or Client identifier that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as sip:[email protected]
. Client identifiers are formatted client:name
. Custom parameters may also be specified.
@optional @param amd_status_callback [String?] The URL that we should call using the amd_status_callback_method
to notify customer application whether the call was answered by human, machine or fax.
@optional @param amd_status_callback_method [Twilio::HttpMethod?]
@optional @param beep [String?] Whether to play a notification beep to the conference when the participant joins. Can be: true
, false
, onEnter
, or onExit
. The default value is true
.
@optional @param byoc [String?] The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that byoc
is only meaningful when to
is a phone number; it will otherwise be ignored. (Beta)
@optional @param call_reason [String?] The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta)
@optional @param call_sid_to_coach [String?] The SID of the participant who is being coached
. The participant being coached is the only participant who can hear the participant who is coaching
.
@optional @param caller_id [String?] The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in E.164 format (e.g., +16175551212). Client identifiers are formatted client:name
. If using a phone number, it must be a Twilio number or a Verified outgoing caller id for your account. If the to
parameter is a phone number, callerId
must also be a phone number. If to
is sip address, this value of callerId
should be a username portion to be used to populate the From header that is passed to the SIP endpoint.
@optional @param coaching [Bool?] Whether the participant is coaching another call. Can be: true
or false
. If not present, defaults to false
unless call_sid_to_coach
is defined. If true
, call_sid_to_coach
must be defined.
@optional @param conference_record [String?] Whether to record the conference the participant is joining. Can be: true
, false
, record-from-start
, and do-not-record
. The default value is false
.
@optional @param conference_recording_status_callback [String?] The URL we should call using the conference_recording_status_callback_method
when the conference recording is available.
@optional @param conference_recording_status_callback_event [Array(String)?] The conference recording state changes that generate a call to conference_recording_status_callback
. Can be: in-progress
, completed
, failed
, and absent
. Separate multiple values with a space, ex: 'in-progress completed failed'
@optional @param conference_recording_status_callback_method [Twilio::HttpMethod?]
@optional @param conference_status_callback [String?] The URL we should call using the conference_status_callback_method
when the conference events in conference_status_callback_event
occur. Only the value set by the first participant to join the conference is used. Subsequent conference_status_callback
values are ignored.
@optional @param conference_status_callback_event [Array(String)?] The conference state changes that should generate a call to conference_status_callback
. Can be: start
, end
, join
, leave
, mute
, hold
, modify
, speaker
, and announcement
. Separate multiple values with a space. Defaults to start end
.
@optional @param conference_status_callback_method [Twilio::HttpMethod?]
@optional @param conference_trim [String?] Whether to trim leading and trailing silence from your recorded conference audio files. Can be: trim-silence
or do-not-trim
and defaults to trim-silence
.
@optional @param early_media [Bool?] Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: true
or false
and defaults to true
.
@optional @param end_conference_on_exit [Bool?] Whether to end the conference when the participant leaves. Can be: true
or false
and defaults to false
.
@optional @param jitter_buffer_size [String?] Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant's audio is mixed into the conference. Can be: off
, small
, medium
, and large
. Default to large
.
@optional @param label [String?] A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant.
@optional @param machine_detection [String?] Whether to detect if a human, answering machine, or fax has picked up the call. Can be: Enable
or DetectMessageEnd
. Use Enable
if you would like us to return AnsweredBy
as soon as the called party is identified. Use DetectMessageEnd
, if you would like to leave a message on an answering machine. If send_digits
is provided, this parameter is ignored. For more information, see Answering Machine Detection.
@optional @param machine_detection_silence_timeout [Int32?] The number of milliseconds of initial silence after which an unknown
AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.
@optional @param machine_detection_speech_end_threshold [Int32?] The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.
@optional @param machine_detection_speech_threshold [Int32?] The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.
@optional @param machine_detection_timeout [Int32?] The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with AnsweredBy
of unknown
. The default timeout is 30 seconds.
@optional @param max_participants [Int32?] The maximum number of participants in the conference. Can be a positive integer from 2
to 250
. The default value is 250
.
@optional @param muted [Bool?] Whether the agent is muted in the conference. Can be true
or false
and the default is false
.
@optional @param record [Bool?] Whether to record the participant and their conferences, including the time between conferences. Can be true
or false
and the default is false
.
@optional @param recording_channels [String?] The recording channels for the final recording. Can be: mono
or dual
and the default is mono
.
@optional @param recording_status_callback [String?] The URL that we should call using the recording_status_callback_method
when the recording status changes.
@optional @param recording_status_callback_event [Array(String)?] The recording state changes that should generate a call to recording_status_callback
. Can be: started
, in-progress
, paused
, resumed
, stopped
, completed
, failed
, and absent
. Separate multiple values with a space, ex: 'in-progress completed failed'
.
@optional @param recording_status_callback_method [Twilio::HttpMethod?]
@optional @param recording_track [String?] The audio track to record for the call. Can be: inbound
, outbound
or both
. The default is both
. inbound
records the audio that is received by Twilio. outbound
records the audio that is sent from Twilio. both
records the audio that is received and sent by Twilio.
@optional @param region [String?] The region where we should mix the recorded audio. Can be:us1
, ie1
, de1
, sg1
, br1
, au1
, or jp1
.
@optional @param sip_auth_password [String?] The SIP password for authentication.
@optional @param sip_auth_username [String?] The SIP username used for authentication.
@optional @param start_conference_on_enter [Bool?] Whether to start the conference when the participant joins, if it has not already started. Can be: true
or false
and the default is true
. If false
and the conference has not started, the participant is muted and hears background music until another participant starts the conference.
@optional @param status_callback [String?] The URL we should call using the status_callback_method
to send status information to your application.
@optional @param status_callback_event [Array(String)?] The conference state changes that should generate a call to status_callback
. Can be: initiated
, ringing
, answered
, and completed
. Separate multiple values with a space. The default value is completed
.
@optional @param status_callback_method [Twilio::HttpMethod?]
@optional @param time_limit [Int32?] The maximum duration of the call in seconds. Constraints depend on account and configuration.
@optional @param timeout [Int32?] The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between 5
and 600
, inclusive. The default value is 60
. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds.
@optional @param wait_method [Twilio::HttpMethod?]
@optional @param wait_url [String?] The URL we should call using the wait_method
for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. Learn more about hold music.
@return [Tuple(Twilio::ConferenceParticipant, Integer, Hash)] Twilio::ConferenceParticipant, response status code and response headers
Delete a recording from your account @required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to delete. @required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference Recording resource to delete. @return [Nil]
Delete a recording from your account @required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to delete. @required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference Recording resource to delete. @return nil
Delete a recording from your account @required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to delete. @required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to delete. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference Recording resource to delete. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers
Kick a participant from a given conference @required @param account_sid [String?] The SID of the Account that created the Participant resources to delete. @required @param conference_sid [String?] The SID of the conference with the participants to delete. @required @param call_sid [String?] The Call SID or label of the participant to delete. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. @return [Nil]
Kick a participant from a given conference @required @param account_sid [String?] The SID of the Account that created the Participant resources to delete. @required @param conference_sid [String?] The SID of the conference with the participants to delete. @required @param call_sid [String?] The Call SID or label of the participant to delete. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. @return nil
Kick a participant from a given conference @required @param account_sid [String?] The SID of the Account that created the Participant resources to delete. @required @param conference_sid [String?] The SID of the conference with the participants to delete. @required @param call_sid [String?] The Call SID or label of the participant to delete. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. @return [Tuple(Nil, Integer, Hash)] Nil, response status code and response headers
Fetch an instance of a conference @required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference resource to fetch @return [Twilio::Conference]
Fetch an instance of a conference @required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference resource to fetch @return nil
Fetch an instance of a recording for a call @required @param account_sid [String?] The SID of the Account that created the Conference Recording resource to fetch. @required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference Recording resource to fetch. @return [Twilio::ConferenceConferenceRecording]
Fetch an instance of a recording for a call @required @param account_sid [String?] The SID of the Account that created the Conference Recording resource to fetch. @required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference Recording resource to fetch. @return nil
Fetch an instance of a recording for a call @required @param account_sid [String?] The SID of the Account that created the Conference Recording resource to fetch. @required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference Recording resource to fetch. @return [Tuple(Twilio::ConferenceConferenceRecording, Integer, Hash)] Twilio::ConferenceConferenceRecording, response status code and response headers
Fetch an instance of a conference @required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to fetch. @required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference resource to fetch @return [Tuple(Twilio::Conference, Integer, Hash)] Twilio::Conference, response status code and response headers
Fetch an instance of a participant @required @param account_sid [String?] The SID of the Account that created the Participant resource to fetch. @required @param conference_sid [String?] The SID of the conference with the participant to fetch. @required @param call_sid [String?] The Call SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. @return [Twilio::ConferenceParticipant]
Fetch an instance of a participant @required @param account_sid [String?] The SID of the Account that created the Participant resource to fetch. @required @param conference_sid [String?] The SID of the conference with the participant to fetch. @required @param call_sid [String?] The Call SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. @return nil
Fetch an instance of a participant @required @param account_sid [String?] The SID of the Account that created the Participant resource to fetch. @required @param conference_sid [String?] The SID of the conference with the participant to fetch. @required @param call_sid [String?] The Call SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. @return [Tuple(Twilio::ConferenceParticipant, Integer, Hash)] Twilio::ConferenceParticipant, response status code and response headers
Retrieve a list of conferences belonging to the account used to make the request
@required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to read.
@optional @param date_created [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD
.
@optional @param date_created_before [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD
.
@optional @param date_created_after [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD
.
@optional @param date_updated [Time?] The date_updated
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD
.
@optional @param date_updated_before [Time?] The date_updated
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD
.
@optional @param date_updated_after [Time?] The date_updated
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD
.
@optional @param friendly_name [String?] The string that identifies the Conference resources to read.
@optional @param status [Twilio::ConferenceEnumStatus?] The status of the resources to read. Can be: init
, in-progress
, or completed
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Twilio::ListConferenceResponse]
Retrieve a list of conferences belonging to the account used to make the request
@required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to read.
@optional @param date_created [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD
.
@optional @param date_created_before [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD
.
@optional @param date_created_after [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD
.
@optional @param date_updated [Time?] The date_updated
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD
.
@optional @param date_updated_before [Time?] The date_updated
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD
.
@optional @param date_updated_after [Time?] The date_updated
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD
.
@optional @param friendly_name [String?] The string that identifies the Conference resources to read.
@optional @param status [Twilio::ConferenceEnumStatus?] The status of the resources to read. Can be: init
, in-progress
, or completed
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return nil
Retrieve a list of recordings belonging to the call used to make the request
@required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to read.
@required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to read.
@optional @param date_created [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD
will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD
returns recordings generated at or after midnight on a date.
@optional @param date_created_before [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD
will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD
returns recordings generated at or after midnight on a date.
@optional @param date_created_after [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD
will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD
returns recordings generated at or after midnight on a date.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Twilio::ListConferenceRecordingResponse]
Retrieve a list of recordings belonging to the call used to make the request
@required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to read.
@required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to read.
@optional @param date_created [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD
will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD
returns recordings generated at or after midnight on a date.
@optional @param date_created_before [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD
will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD
returns recordings generated at or after midnight on a date.
@optional @param date_created_after [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD
will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD
returns recordings generated at or after midnight on a date.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return nil
Retrieve a list of recordings belonging to the call used to make the request
@required @param account_sid [String?] The SID of the Account that created the Conference Recording resources to read.
@required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to read.
@optional @param date_created [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD
will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD
returns recordings generated at or after midnight on a date.
@optional @param date_created_before [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD
will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD
returns recordings generated at or after midnight on a date.
@optional @param date_created_after [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. You can also specify inequality: DateCreated<=YYYY-MM-DD
will return recordings generated at or before midnight on a given date, and DateCreated>=YYYY-MM-DD
returns recordings generated at or after midnight on a date.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Tuple(Twilio::ListConferenceRecordingResponse, Integer, Hash)] Twilio::ListConferenceRecordingResponse, response status code and response headers
Retrieve a list of conferences belonging to the account used to make the request
@required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to read.
@optional @param date_created [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD
.
@optional @param date_created_before [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD
.
@optional @param date_created_after [Time?] The date_created
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that started on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that started on or after midnight on a date, use >=YYYY-MM-DD
.
@optional @param date_updated [Time?] The date_updated
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD
.
@optional @param date_updated_before [Time?] The date_updated
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD
.
@optional @param date_updated_after [Time?] The date_updated
value, specified as YYYY-MM-DD
, of the resources to read. To read conferences that were last updated on or before midnight on a date, use <=YYYY-MM-DD
, and to specify conferences that were last updated on or after midnight on a given date, use >=YYYY-MM-DD
.
@optional @param friendly_name [String?] The string that identifies the Conference resources to read.
@optional @param status [Twilio::ConferenceEnumStatus?] The status of the resources to read. Can be: init
, in-progress
, or completed
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Tuple(Twilio::ListConferenceResponse, Integer, Hash)] Twilio::ListConferenceResponse, response status code and response headers
Retrieve a list of participants belonging to the account used to make the request
@required @param account_sid [String?] The SID of the Account that created the Participant resources to read.
@required @param conference_sid [String?] The SID of the conference with the participants to read.
@optional @param muted [Bool?] Whether to return only participants that are muted. Can be: true
or false
.
@optional @param hold [Bool?] Whether to return only participants that are on hold. Can be: true
or false
.
@optional @param coaching [Bool?] Whether to return only participants who are coaching another call. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Twilio::ListParticipantResponse]
Retrieve a list of participants belonging to the account used to make the request
@required @param account_sid [String?] The SID of the Account that created the Participant resources to read.
@required @param conference_sid [String?] The SID of the conference with the participants to read.
@optional @param muted [Bool?] Whether to return only participants that are muted. Can be: true
or false
.
@optional @param hold [Bool?] Whether to return only participants that are on hold. Can be: true
or false
.
@optional @param coaching [Bool?] Whether to return only participants who are coaching another call. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return nil
Retrieve a list of participants belonging to the account used to make the request
@required @param account_sid [String?] The SID of the Account that created the Participant resources to read.
@required @param conference_sid [String?] The SID of the conference with the participants to read.
@optional @param muted [Bool?] Whether to return only participants that are muted. Can be: true
or false
.
@optional @param hold [Bool?] Whether to return only participants that are on hold. Can be: true
or false
.
@optional @param coaching [Bool?] Whether to return only participants who are coaching another call. Can be: true
or false
.
@optional @param page_size [Int32?] How many resources to return in each list page. The default is 50, and the maximum is 1000.
@return [Tuple(Twilio::ListParticipantResponse, Integer, Hash)] Twilio::ListParticipantResponse, response status code and response headers
@required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference resource to update
@optional @param announce_method [Twilio::HttpMethod?]
@optional @param announce_url [String?] The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs.
@optional @param status [Twilio::ConferenceEnumUpdateStatus?]
@return [Twilio::Conference]
@required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference resource to update
@optional @param announce_method [Twilio::HttpMethod?]
@optional @param announce_url [String?] The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs.
@optional @param status [Twilio::ConferenceEnumUpdateStatus?]
@return nil
Changes the status of the recording to paused, stopped, or in-progress. Note: To use Twilio.CURRENT
, pass it as recording sid.
@required @param account_sid [String?] The SID of the Account that created the Conference Recording resource to update.
@required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use Twilio.CURRENT
to reference the current active recording.
@required @param status [Twilio::CallRecordingEnumStatus?]
@optional @param pause_behavior [String?] Whether to record during a pause. Can be: skip
or silence
and the default is silence
. skip
does not record during the pause period, while silence
will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting status
is set to paused
.
@return [Twilio::ConferenceConferenceRecording]
Changes the status of the recording to paused, stopped, or in-progress. Note: To use `Twilio.CURRENT`, pass it as recording sid.
@required @param account_sid [String?] The SID of the Account that created the Conference Recording resource to update.
@required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use Twilio.CURRENT
to reference the current active recording.
@required @param status [Twilio::CallRecordingEnumStatus?]
@optional @param pause_behavior [String?] Whether to record during a pause. Can be: skip
or silence
and the default is silence
. skip
does not record during the pause period, while silence
will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting status
is set to paused
.
@return nil
Changes the status of the recording to paused, stopped, or in-progress. Note: To use `Twilio.CURRENT`, pass it as recording sid.
@required @param account_sid [String?] The SID of the Account that created the Conference Recording resource to update.
@required @param conference_sid [String?] The Conference SID that identifies the conference associated with the recording to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use Twilio.CURRENT
to reference the current active recording.
@required @param status [Twilio::CallRecordingEnumStatus?]
@optional @param pause_behavior [String?] Whether to record during a pause. Can be: skip
or silence
and the default is silence
. skip
does not record during the pause period, while silence
will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting status
is set to paused
.
@return [Tuple(Twilio::ConferenceConferenceRecording, Integer, Hash)] Twilio::ConferenceConferenceRecording, response status code and response headers
@required @param account_sid [String?] The SID of the Account that created the Conference resource(s) to update.
@required @param sid [String?] The Twilio-provided string that uniquely identifies the Conference resource to update
@optional @param announce_method [Twilio::HttpMethod?]
@optional @param announce_url [String?] The URL we should call to announce something into the conference. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs.
@optional @param status [Twilio::ConferenceEnumUpdateStatus?]
@return [Tuple(Twilio::Conference, Integer, Hash)] Twilio::Conference, response status code and response headers
Update the properties of the participant
@required @param account_sid [String?] The SID of the Account that created the Participant resources to update.
@required @param conference_sid [String?] The SID of the conference with the participant to update.
@required @param call_sid [String?] The Call SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.
@optional @param announce_method [Twilio::HttpMethod?]
@optional @param announce_url [String?] The URL we call using the announce_method
for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs.
@optional @param beep_on_exit [Bool?] Whether to play a notification beep to the conference when the participant exits. Can be: true
or false
.
@optional @param call_sid_to_coach [String?] The SID of the participant who is being coached
. The participant being coached is the only participant who can hear the participant who is coaching
.
@optional @param coaching [Bool?] Whether the participant is coaching another call. Can be: true
or false
. If not present, defaults to false
unless call_sid_to_coach
is defined. If true
, call_sid_to_coach
must be defined.
@optional @param end_conference_on_exit [Bool?] Whether to end the conference when the participant leaves. Can be: true
or false
and defaults to false
.
@optional @param hold [Bool?] Whether the participant should be on hold. Can be: true
or false
. true
puts the participant on hold, and false
lets them rejoin the conference.
@optional @param hold_method [Twilio::HttpMethod?]
@optional @param hold_url [String?] The URL we call using the hold_method
for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs.
@optional @param muted [Bool?] Whether the participant should be muted. Can be true
or false
. true
will mute the participant, and false
will un-mute them. Anything value other than true
or false
is interpreted as false
.
@optional @param wait_method [Twilio::HttpMethod?]
@optional @param wait_url [String?] The URL we call using the wait_method
for the music to play while participants are waiting for the conference to start. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs. The default value is the URL of our standard hold music. Learn more about hold music.
@return [Twilio::ConferenceParticipant]
Update the properties of the participant
@required @param account_sid [String?] The SID of the Account that created the Participant resources to update.
@required @param conference_sid [String?] The SID of the conference with the participant to update.
@required @param call_sid [String?] The Call SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.
@optional @param announce_method [Twilio::HttpMethod?]
@optional @param announce_url [String?] The URL we call using the announce_method
for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs.
@optional @param beep_on_exit [Bool?] Whether to play a notification beep to the conference when the participant exits. Can be: true
or false
.
@optional @param call_sid_to_coach [String?] The SID of the participant who is being coached
. The participant being coached is the only participant who can hear the participant who is coaching
.
@optional @param coaching [Bool?] Whether the participant is coaching another call. Can be: true
or false
. If not present, defaults to false
unless call_sid_to_coach
is defined. If true
, call_sid_to_coach
must be defined.
@optional @param end_conference_on_exit [Bool?] Whether to end the conference when the participant leaves. Can be: true
or false
and defaults to false
.
@optional @param hold [Bool?] Whether the participant should be on hold. Can be: true
or false
. true
puts the participant on hold, and false
lets them rejoin the conference.
@optional @param hold_method [Twilio::HttpMethod?]
@optional @param hold_url [String?] The URL we call using the hold_method
for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs.
@optional @param muted [Bool?] Whether the participant should be muted. Can be true
or false
. true
will mute the participant, and false
will un-mute them. Anything value other than true
or false
is interpreted as false
.
@optional @param wait_method [Twilio::HttpMethod?]
@optional @param wait_url [String?] The URL we call using the wait_method
for the music to play while participants are waiting for the conference to start. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs. The default value is the URL of our standard hold music. Learn more about hold music.
@return nil
Update the properties of the participant
@required @param account_sid [String?] The SID of the Account that created the Participant resources to update.
@required @param conference_sid [String?] The SID of the conference with the participant to update.
@required @param call_sid [String?] The Call SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20.
@optional @param announce_method [Twilio::HttpMethod?]
@optional @param announce_url [String?] The URL we call using the announce_method
for an announcement to the participant. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs.
@optional @param beep_on_exit [Bool?] Whether to play a notification beep to the conference when the participant exits. Can be: true
or false
.
@optional @param call_sid_to_coach [String?] The SID of the participant who is being coached
. The participant being coached is the only participant who can hear the participant who is coaching
.
@optional @param coaching [Bool?] Whether the participant is coaching another call. Can be: true
or false
. If not present, defaults to false
unless call_sid_to_coach
is defined. If true
, call_sid_to_coach
must be defined.
@optional @param end_conference_on_exit [Bool?] Whether to end the conference when the participant leaves. Can be: true
or false
and defaults to false
.
@optional @param hold [Bool?] Whether the participant should be on hold. Can be: true
or false
. true
puts the participant on hold, and false
lets them rejoin the conference.
@optional @param hold_method [Twilio::HttpMethod?]
@optional @param hold_url [String?] The URL we call using the hold_method
for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs.
@optional @param muted [Bool?] Whether the participant should be muted. Can be true
or false
. true
will mute the participant, and false
will un-mute them. Anything value other than true
or false
is interpreted as false
.
@optional @param wait_method [Twilio::HttpMethod?]
@optional @param wait_url [String?] The URL we call using the wait_method
for the music to play while participants are waiting for the conference to start. The URL may return an MP3 file, a WAV file, or a TwiML document that contains <Play>
, <Say>
, <Pause>
, or <Redirect>
verbs. The default value is the URL of our standard hold music. Learn more about hold music.
@return [Tuple(Twilio::ConferenceParticipant, Integer, Hash)] Twilio::ConferenceParticipant, response status code and response headers