bandwidth-sdk 10.0.0 → 11.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +11 -0
- data/Gemfile.lock +102 -0
- data/README.md +204 -139
- data/Rakefile +30 -0
- data/bandwidth-sdk.gemspec +40 -0
- data/bandwidth.yml +5626 -0
- data/coverage/.last_run.json +5 -0
- data/coverage/.resultset.json +9761 -0
- data/coverage/.resultset.json.lock +0 -0
- data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc.png +0 -0
- data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_asc_disabled.png +0 -0
- data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_both.png +0 -0
- data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc.png +0 -0
- data/coverage/assets/0.12.3/DataTables-1.10.20/images/sort_desc_disabled.png +0 -0
- data/coverage/assets/0.12.3/application.css +1 -0
- data/coverage/assets/0.12.3/application.js +7 -0
- data/coverage/assets/0.12.3/colorbox/border.png +0 -0
- data/coverage/assets/0.12.3/colorbox/controls.png +0 -0
- data/coverage/assets/0.12.3/colorbox/loading.gif +0 -0
- data/coverage/assets/0.12.3/colorbox/loading_background.png +0 -0
- data/coverage/assets/0.12.3/favicon_green.png +0 -0
- data/coverage/assets/0.12.3/favicon_red.png +0 -0
- data/coverage/assets/0.12.3/favicon_yellow.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_flat_0_aaaaaa_40x100.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_flat_75_ffffff_40x100.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_glass_55_fbf9ee_1x400.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_glass_65_ffffff_1x400.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_glass_75_dadada_1x400.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_glass_75_e6e6e6_1x400.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_glass_95_fef1ec_1x400.png +0 -0
- data/coverage/assets/0.12.3/images/ui-bg_highlight-soft_75_cccccc_1x100.png +0 -0
- data/coverage/assets/0.12.3/images/ui-icons_222222_256x240.png +0 -0
- data/coverage/assets/0.12.3/images/ui-icons_2e83ff_256x240.png +0 -0
- data/coverage/assets/0.12.3/images/ui-icons_454545_256x240.png +0 -0
- data/coverage/assets/0.12.3/images/ui-icons_888888_256x240.png +0 -0
- data/coverage/assets/0.12.3/images/ui-icons_cd0a0a_256x240.png +0 -0
- data/coverage/assets/0.12.3/loading.gif +0 -0
- data/coverage/assets/0.12.3/magnify.png +0 -0
- data/coverage/index.html +108271 -0
- data/custom_templates/Gemfile.mustache +11 -0
- data/custom_templates/README.mustache +173 -0
- data/custom_templates/gem.mustache +99 -0
- data/custom_templates/gemspec.mustache +37 -0
- data/docs/AccountStatistics.md +20 -0
- data/docs/AnswerCallback.md +44 -0
- data/docs/BridgeCompleteCallback.md +48 -0
- data/docs/BridgeTargetCompleteCallback.md +42 -0
- data/docs/CallDirectionEnum.md +15 -0
- data/docs/CallRecordingMetadata.md +52 -0
- data/docs/CallState.md +52 -0
- data/docs/CallStateEnum.md +15 -0
- data/docs/CallbackMethodEnum.md +15 -0
- data/docs/CallsApi.md +304 -0
- data/docs/CodeRequest.md +28 -0
- data/docs/Conference.md +32 -0
- data/docs/ConferenceCompletedCallback.md +26 -0
- data/docs/ConferenceCreatedCallback.md +26 -0
- data/docs/ConferenceMember.md +28 -0
- data/docs/ConferenceMemberExitCallback.md +32 -0
- data/docs/ConferenceMemberJoinCallback.md +32 -0
- data/docs/ConferenceRecordingAvailableCallback.md +44 -0
- data/docs/ConferenceRecordingMetadata.md +38 -0
- data/docs/ConferenceRedirectCallback.md +26 -0
- data/docs/ConferenceStateEnum.md +15 -0
- data/docs/ConferencesApi.md +688 -0
- data/docs/CreateCall.md +56 -0
- data/docs/CreateCallResponse.md +58 -0
- data/docs/CreateLookupResponse.md +20 -0
- data/docs/CreateMessageRequestError.md +22 -0
- data/docs/CreateParticipantRequest.md +24 -0
- data/docs/CreateParticipantResponse.md +20 -0
- data/docs/DeferredResult.md +20 -0
- data/docs/DeviceApiVersionEnum.md +15 -0
- data/docs/DisconenctCallback.md +50 -0
- data/docs/DisconnectCallback.md +50 -0
- data/docs/Diversion.md +30 -0
- data/docs/DtmfCallback.md +50 -0
- data/docs/FieldError.md +20 -0
- data/docs/FileFormatEnum.md +15 -0
- data/docs/ForbiddenRequest.md +18 -0
- data/docs/GatherCallback.md +52 -0
- data/docs/InboundMessageCallback.md +26 -0
- data/docs/InboundMessageCallbackMessage.md +40 -0
- data/docs/InitiateCallback.md +40 -0
- data/docs/ListMessageDirectionEnum.md +15 -0
- data/docs/ListMessageItem.md +50 -0
- data/docs/LookupRequest.md +18 -0
- data/docs/LookupResult.md +34 -0
- data/docs/LookupStatus.md +24 -0
- data/docs/LookupStatusEnum.md +15 -0
- data/docs/MFAApi.md +226 -0
- data/docs/MachineDetectionCompleteCallback.md +44 -0
- data/docs/MachineDetectionConfiguration.md +46 -0
- data/docs/MachineDetectionModeEnum.md +15 -0
- data/docs/MachineDetectionResult.md +20 -0
- data/docs/Media.md +22 -0
- data/docs/MediaApi.md +307 -0
- data/docs/Message.md +42 -0
- data/docs/MessageDeliveredCallback.md +26 -0
- data/docs/MessageDeliveredCallbackMessage.md +40 -0
- data/docs/MessageDirectionEnum.md +15 -0
- data/docs/MessageFailedCallback.md +28 -0
- data/docs/MessageFailedCallbackMessage.md +40 -0
- data/docs/MessageRequest.md +32 -0
- data/docs/MessageSendingCallback.md +26 -0
- data/docs/MessageSendingCallbackMessage.md +40 -0
- data/docs/MessageStatusEnum.md +15 -0
- data/docs/MessageTypeEnum.md +15 -0
- data/docs/MessagesApi.md +183 -0
- data/docs/MessagesList.md +22 -0
- data/docs/MessagingCodeResponse.md +18 -0
- data/docs/MessagingRequestError.md +20 -0
- data/docs/MfaForbiddenRequestError.md +18 -0
- data/docs/MfaRequestError.md +20 -0
- data/docs/MfaUnauthorizedRequestError.md +18 -0
- data/docs/PageInfo.md +24 -0
- data/docs/Participant.md +30 -0
- data/docs/ParticipantSubscription.md +20 -0
- data/docs/ParticipantsApi.md +227 -0
- data/docs/PhoneNumberLookupApi.md +153 -0
- data/docs/PriorityEnum.md +15 -0
- data/docs/PublishPermissionsEnum.md +15 -0
- data/docs/RecordingAvailableCallback.md +60 -0
- data/docs/RecordingCompleteCallback.md +60 -0
- data/docs/RecordingStateEnum.md +15 -0
- data/docs/RecordingsApi.md +758 -0
- data/docs/RedirectCallback.md +48 -0
- data/docs/RedirectMethodEnum.md +15 -0
- data/docs/RequestError.md +20 -0
- data/docs/Session.md +20 -0
- data/docs/SessionsApi.md +605 -0
- data/docs/StatisticsApi.md +78 -0
- data/docs/StirShaken.md +22 -0
- data/docs/Subscriptions.md +20 -0
- data/docs/Tag.md +20 -0
- data/docs/TnLookupRequestError.md +18 -0
- data/docs/TranscribeRecording.md +30 -0
- data/docs/Transcription.md +20 -0
- data/docs/TranscriptionAvailableCallback.md +58 -0
- data/docs/TranscriptionList.md +18 -0
- data/docs/TranscriptionMetadata.md +24 -0
- data/docs/TransferAnswerCallback.md +46 -0
- data/docs/TransferCompleteCallback.md +52 -0
- data/docs/TransferDisconnectCallback.md +56 -0
- data/docs/UnauthorizedRequest.md +18 -0
- data/docs/UpdateCall.md +36 -0
- data/docs/UpdateCallRecording.md +18 -0
- data/docs/UpdateConference.md +34 -0
- data/docs/UpdateConferenceMember.md +22 -0
- data/docs/VerifyCodeRequest.md +24 -0
- data/docs/VerifyCodeResponse.md +18 -0
- data/docs/VoiceApiError.md +22 -0
- data/docs/VoiceCodeResponse.md +18 -0
- data/git_push.sh +57 -0
- data/lib/bandwidth-sdk/api/calls_api.rb +325 -0
- data/lib/bandwidth-sdk/api/conferences_api.rb +717 -0
- data/lib/bandwidth-sdk/api/media_api.rb +312 -0
- data/lib/bandwidth-sdk/api/messages_api.rb +204 -0
- data/lib/bandwidth-sdk/api/mfa_api.rb +244 -0
- data/lib/bandwidth-sdk/api/phone_number_lookup_api.rb +165 -0
- data/lib/bandwidth-sdk/api/recordings_api.rb +782 -0
- data/lib/bandwidth-sdk/api/statistics_api.rb +85 -0
- data/lib/bandwidth-sdk/api_client.rb +428 -0
- data/lib/bandwidth-sdk/api_error.rb +58 -0
- data/lib/bandwidth-sdk/configuration.rb +591 -0
- data/lib/bandwidth-sdk/models/account_statistics.rb +223 -0
- data/lib/bandwidth-sdk/models/answer_callback.rb +368 -0
- data/lib/bandwidth-sdk/models/bridge_complete_callback.rb +390 -0
- data/lib/bandwidth-sdk/models/bridge_target_complete_callback.rb +358 -0
- data/lib/bandwidth-sdk/models/bxml/bxml.rb +11 -0
- data/lib/bandwidth-sdk/models/bxml/nestable_verb.rb +46 -0
- data/lib/bandwidth-sdk/models/bxml/response.rb +11 -0
- data/lib/bandwidth-sdk/models/bxml/root.rb +47 -0
- data/lib/bandwidth-sdk/models/bxml/verb.rb +50 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/bridge.rb +28 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/conference.rb +28 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/custom_param.rb +16 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/forward.rb +20 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/gather.rb +42 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/hangup.rb +10 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/pause.rb +15 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/pause_recording.rb +10 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/phone_number.rb +26 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/play_audio.rb +17 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/record.rb +32 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/redirect.rb +23 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/resume_recording.rb +10 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/ring.rb +16 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/send_dtmf.rb +17 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/sip_uri.rb +27 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/speak_sentence.rb +25 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/start_gather.rb +19 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/start_recording.rb +24 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/start_stream.rb +28 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/start_transcription.rb +29 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_gather.rb +10 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_recording.rb +10 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_stream.rb +15 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stop_transcription.rb +15 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/stream_param.rb +16 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/tag.rb +11 -0
- data/lib/bandwidth-sdk/models/bxml/verbs/transfer.rb +34 -0
- data/lib/bandwidth-sdk/models/call_direction_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/call_recording_metadata.rb +404 -0
- data/lib/bandwidth-sdk/models/call_state.rb +416 -0
- data/lib/bandwidth-sdk/models/call_state_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/callback_method_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/code_request.rb +434 -0
- data/lib/bandwidth-sdk/models/conference.rb +313 -0
- data/lib/bandwidth-sdk/models/conference_completed_callback.rb +255 -0
- data/lib/bandwidth-sdk/models/conference_created_callback.rb +255 -0
- data/lib/bandwidth-sdk/models/conference_member.rb +266 -0
- data/lib/bandwidth-sdk/models/conference_member_exit_callback.rb +285 -0
- data/lib/bandwidth-sdk/models/conference_member_join_callback.rb +285 -0
- data/lib/bandwidth-sdk/models/conference_recording_available_callback.rb +367 -0
- data/lib/bandwidth-sdk/models/conference_recording_metadata.rb +335 -0
- data/lib/bandwidth-sdk/models/conference_redirect_callback.rb +255 -0
- data/lib/bandwidth-sdk/models/conference_state_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/create_call.rb +687 -0
- data/lib/bandwidth-sdk/models/create_call_response.rb +559 -0
- data/lib/bandwidth-sdk/models/create_lookup_response.rb +245 -0
- data/lib/bandwidth-sdk/models/create_message_request_error.rb +246 -0
- data/lib/bandwidth-sdk/models/deferred_result.rb +221 -0
- data/lib/bandwidth-sdk/models/disconenct_callback.rb +405 -0
- data/lib/bandwidth-sdk/models/disconnect_callback.rb +400 -0
- data/lib/bandwidth-sdk/models/diversion.rb +273 -0
- data/lib/bandwidth-sdk/models/dtmf_callback.rb +398 -0
- data/lib/bandwidth-sdk/models/field_error.rb +223 -0
- data/lib/bandwidth-sdk/models/file_format_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/gather_callback.rb +408 -0
- data/lib/bandwidth-sdk/models/inbound_message_callback.rb +284 -0
- data/lib/bandwidth-sdk/models/inbound_message_callback_message.rb +411 -0
- data/lib/bandwidth-sdk/models/initiate_callback.rb +343 -0
- data/lib/bandwidth-sdk/models/list_message_direction_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/list_message_item.rb +398 -0
- data/lib/bandwidth-sdk/models/lookup_request.rb +222 -0
- data/lib/bandwidth-sdk/models/lookup_result.rb +294 -0
- data/lib/bandwidth-sdk/models/lookup_status.rb +269 -0
- data/lib/bandwidth-sdk/models/lookup_status_enum.rb +42 -0
- data/lib/bandwidth-sdk/models/machine_detection_complete_callback.rb +368 -0
- data/lib/bandwidth-sdk/models/machine_detection_configuration.rb +493 -0
- data/lib/bandwidth-sdk/models/machine_detection_mode_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/machine_detection_result.rb +224 -0
- data/lib/bandwidth-sdk/models/media.rb +230 -0
- data/lib/bandwidth-sdk/models/message.rb +377 -0
- data/lib/bandwidth-sdk/models/message_delivered_callback.rb +284 -0
- data/lib/bandwidth-sdk/models/message_delivered_callback_message.rb +418 -0
- data/lib/bandwidth-sdk/models/message_direction_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/message_failed_callback.rb +300 -0
- data/lib/bandwidth-sdk/models/message_failed_callback_message.rb +425 -0
- data/lib/bandwidth-sdk/models/message_request.rb +358 -0
- data/lib/bandwidth-sdk/models/message_sending_callback.rb +284 -0
- data/lib/bandwidth-sdk/models/message_sending_callback_message.rb +425 -0
- data/lib/bandwidth-sdk/models/message_status_enum.rb +46 -0
- data/lib/bandwidth-sdk/models/message_type_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/messages_list.rb +233 -0
- data/lib/bandwidth-sdk/models/messaging_code_response.rb +213 -0
- data/lib/bandwidth-sdk/models/messaging_request_error.rb +235 -0
- data/lib/bandwidth-sdk/models/mfa_forbidden_request_error.rb +213 -0
- data/lib/bandwidth-sdk/models/mfa_request_error.rb +223 -0
- data/lib/bandwidth-sdk/models/mfa_unauthorized_request_error.rb +213 -0
- data/lib/bandwidth-sdk/models/page_info.rb +243 -0
- data/lib/bandwidth-sdk/models/priority_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/recording_available_callback.rb +447 -0
- data/lib/bandwidth-sdk/models/recording_complete_callback.rb +448 -0
- data/lib/bandwidth-sdk/models/recording_state_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/redirect_callback.rb +388 -0
- data/lib/bandwidth-sdk/models/redirect_method_enum.rb +40 -0
- data/lib/bandwidth-sdk/models/stir_shaken.rb +233 -0
- data/lib/bandwidth-sdk/models/tag.rb +221 -0
- data/lib/bandwidth-sdk/models/tn_lookup_request_error.rb +213 -0
- data/lib/bandwidth-sdk/models/transcribe_recording.rb +360 -0
- data/lib/bandwidth-sdk/models/transcription.rb +223 -0
- data/lib/bandwidth-sdk/models/transcription_available_callback.rb +436 -0
- data/lib/bandwidth-sdk/models/transcription_list.rb +214 -0
- data/lib/bandwidth-sdk/models/transcription_metadata.rb +244 -0
- data/lib/bandwidth-sdk/models/transfer_answer_callback.rb +378 -0
- data/lib/bandwidth-sdk/models/transfer_complete_callback.rb +410 -0
- data/lib/bandwidth-sdk/models/transfer_disconnect_callback.rb +430 -0
- data/lib/bandwidth-sdk/models/update_call.rb +413 -0
- data/lib/bandwidth-sdk/models/update_call_recording.rb +241 -0
- data/lib/bandwidth-sdk/models/update_conference.rb +387 -0
- data/lib/bandwidth-sdk/models/update_conference_member.rb +236 -0
- data/lib/bandwidth-sdk/models/verify_code_request.rb +341 -0
- data/lib/bandwidth-sdk/models/verify_code_response.rb +213 -0
- data/lib/bandwidth-sdk/models/voice_api_error.rb +231 -0
- data/lib/bandwidth-sdk/models/voice_code_response.rb +213 -0
- data/lib/bandwidth-sdk/version.rb +15 -0
- data/lib/bandwidth-sdk.rb +170 -0
- data/openapi-config.yml +12 -0
- data/openapitools.json +7 -0
- data/spec/api/calls_api_spec.rb +230 -0
- data/spec/api/conferences_api_spec.rb +393 -0
- data/spec/api/media_api_spec.rb +129 -0
- data/spec/api/messages_api_spec.rb +193 -0
- data/spec/api/mfa_api_spec.rb +130 -0
- data/spec/api/phone_number_lookup_api_spec.rb +100 -0
- data/spec/api/recordings_api_spec.rb +395 -0
- data/spec/api/statistics_api_spec.rb +45 -0
- data/spec/api_client_spec.rb +377 -0
- data/spec/api_error_spec.rb +23 -0
- data/spec/call_utils.rb +74 -0
- data/spec/configuration_spec.rb +190 -0
- data/spec/fixtures/ruby_cat.jpeg +0 -0
- data/spec/integration/calls_api_integration_spec.rb +202 -0
- data/spec/integration/conferences_api_integration_spec.rb +169 -0
- data/spec/integration/media_api_integration_spec.rb +92 -0
- data/spec/integration/messages_api_integration_spec.rb +138 -0
- data/spec/integration/mfa_api_integration_spec.rb +117 -0
- data/spec/integration/phone_number_lookup_api_integration_spec.rb +96 -0
- data/spec/integration/recordings_api_integration_spec.rb +226 -0
- data/spec/integration/statistics_api_integration_spec.rb +58 -0
- data/spec/models/bxml/bxml_spec.rb +16 -0
- data/spec/models/bxml/nestable_verb_spec.rb +11 -0
- data/spec/models/bxml/response_spec.rb +16 -0
- data/spec/models/bxml/verb_spec.rb +15 -0
- data/spec/models/bxml/verbs/bridge_spec.rb +58 -0
- data/spec/models/bxml/verbs/conference_spec.rb +58 -0
- data/spec/models/bxml/verbs/custom_param_spec.rb +36 -0
- data/spec/models/bxml/verbs/forward_spec.rb +44 -0
- data/spec/models/bxml/verbs/gather_spec.rb +86 -0
- data/spec/models/bxml/verbs/hangup_spec.rb +16 -0
- data/spec/models/bxml/verbs/pause_recording_spec.rb +16 -0
- data/spec/models/bxml/verbs/pause_spec.rb +34 -0
- data/spec/models/bxml/verbs/phone_number_spec.rb +54 -0
- data/spec/models/bxml/verbs/play_audio_spec.rb +36 -0
- data/spec/models/bxml/verbs/record_spec.rb +68 -0
- data/spec/models/bxml/verbs/redirect_spec.rb +50 -0
- data/spec/models/bxml/verbs/resume_recording_spec.rb +16 -0
- data/spec/models/bxml/verbs/ring_spec.rb +36 -0
- data/spec/models/bxml/verbs/send_dtmf_spec.rb +36 -0
- data/spec/models/bxml/verbs/sip_uri_spec.rb +56 -0
- data/spec/models/bxml/verbs/speak_sentence_spec.rb +38 -0
- data/spec/models/bxml/verbs/start_gather_spec.rb +42 -0
- data/spec/models/bxml/verbs/start_recording_spec.rb +52 -0
- data/spec/models/bxml/verbs/start_stream_spec.rb +72 -0
- data/spec/models/bxml/verbs/start_transcription_spec.rb +74 -0
- data/spec/models/bxml/verbs/stop_gather_spec.rb +16 -0
- data/spec/models/bxml/verbs/stop_recording_spec.rb +16 -0
- data/spec/models/bxml/verbs/stop_stream_spec.rb +34 -0
- data/spec/models/bxml/verbs/stop_transcription_spec.rb +34 -0
- data/spec/models/bxml/verbs/stream_param_spec.rb +36 -0
- data/spec/models/bxml/verbs/tag_spec.rb +16 -0
- data/spec/models/bxml/verbs/transfer_spec.rb +84 -0
- data/spec/models/call_state_enum_spec.rb +16 -0
- data/spec/models/call_state_spec.rb +168 -0
- data/spec/models/deferred_result_spec.rb +74 -0
- data/spec/models/message_spec.rb +138 -0
- data/spec/models/verify_code_request_spec.rb +126 -0
- data/spec/spec_helper.rb +171 -0
- metadata +430 -276
- data/LICENSE +0 -28
- data/lib/bandwidth/api_helper.rb +0 -280
- data/lib/bandwidth/client.rb +0 -75
- data/lib/bandwidth/configuration.rb +0 -209
- data/lib/bandwidth/exceptions/api_exception.rb +0 -20
- data/lib/bandwidth/http/api_response.rb +0 -38
- data/lib/bandwidth/http/auth/messaging_basic_auth.rb +0 -22
- data/lib/bandwidth/http/auth/multi_factor_auth_basic_auth.rb +0 -22
- data/lib/bandwidth/http/auth/phone_number_lookup_basic_auth.rb +0 -22
- data/lib/bandwidth/http/auth/voice_basic_auth.rb +0 -22
- data/lib/bandwidth/http/auth/web_rtc_basic_auth.rb +0 -22
- data/lib/bandwidth/http/faraday_client.rb +0 -73
- data/lib/bandwidth/http/http_call_back.rb +0 -24
- data/lib/bandwidth/http/http_client.rb +0 -104
- data/lib/bandwidth/http/http_method_enum.rb +0 -13
- data/lib/bandwidth/http/http_request.rb +0 -50
- data/lib/bandwidth/http/http_response.rb +0 -29
- data/lib/bandwidth/messaging_lib/messaging/client.rb +0 -60
- data/lib/bandwidth/messaging_lib/messaging/controllers/api_controller.rb +0 -491
- data/lib/bandwidth/messaging_lib/messaging/controllers/base_controller.rb +0 -47
- data/lib/bandwidth/messaging_lib/messaging/exceptions/messaging_exception.rb +0 -37
- data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_callback_message.rb +0 -100
- data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message.rb +0 -164
- data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_message_item.rb +0 -203
- data/lib/bandwidth/messaging_lib/messaging/models/bandwidth_messages_list.rb +0 -79
- data/lib/bandwidth/messaging_lib/messaging/models/deferred_result.rb +0 -60
- data/lib/bandwidth/messaging_lib/messaging/models/media.rb +0 -70
- data/lib/bandwidth/messaging_lib/messaging/models/message_request.rb +0 -111
- data/lib/bandwidth/messaging_lib/messaging/models/page_info.rb +0 -82
- data/lib/bandwidth/messaging_lib/messaging/models/priority_enum.rb +0 -19
- data/lib/bandwidth/messaging_lib/messaging/models/tag.rb +0 -60
- data/lib/bandwidth/messaging_lib/messaging.rb +0 -25
- data/lib/bandwidth/models/base_model.rb +0 -58
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/client.rb +0 -60
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/controllers/base_controller.rb +0 -47
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/controllers/mfa_controller.rb +0 -214
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/error_with_request_exception.rb +0 -37
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/forbidden_request_exception.rb +0 -32
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/exceptions/unauthorized_request_exception.rb +0 -32
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_code_request_schema.rb +0 -103
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_messaging_response.rb +0 -50
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_verify_code_response.rb +0 -50
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_verify_request_schema.rb +0 -94
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth/models/two_factor_voice_response.rb +0 -50
- data/lib/bandwidth/multi_factor_auth_lib/multi_factor_auth.rb +0 -23
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/client.rb +0 -60
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/controllers/api_controller.rb +0 -1553
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/controllers/base_controller.rb +0 -47
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/exceptions/accounts_tnlookup400_error_exception.rb +0 -32
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_request.rb +0 -50
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_response.rb +0 -61
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/order_status.rb +0 -95
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup/models/result.rb +0 -132
- data/lib/bandwidth/phone_number_lookup_lib/phone_number_lookup.rb +0 -20
- data/lib/bandwidth/utilities/date_time_helper.rb +0 -156
- data/lib/bandwidth/utilities/file_wrapper.rb +0 -16
- data/lib/bandwidth/voice_lib/bxml/bxml.rb +0 -36
- data/lib/bandwidth/voice_lib/bxml/response.rb +0 -39
- data/lib/bandwidth/voice_lib/bxml/verbs/bridge.rb +0 -28
- data/lib/bandwidth/voice_lib/bxml/verbs/conference.rb +0 -32
- data/lib/bandwidth/voice_lib/bxml/verbs/forward.rb +0 -18
- data/lib/bandwidth/voice_lib/bxml/verbs/gather.rb +0 -49
- data/lib/bandwidth/voice_lib/bxml/verbs/hangup.rb +0 -14
- data/lib/bandwidth/voice_lib/bxml/verbs/pause.rb +0 -15
- data/lib/bandwidth/voice_lib/bxml/verbs/pause_recording.rb +0 -14
- data/lib/bandwidth/voice_lib/bxml/verbs/phone_number.rb +0 -24
- data/lib/bandwidth/voice_lib/bxml/verbs/play_audio.rb +0 -17
- data/lib/bandwidth/voice_lib/bxml/verbs/record.rb +0 -33
- data/lib/bandwidth/voice_lib/bxml/verbs/redirect.rb +0 -24
- data/lib/bandwidth/voice_lib/bxml/verbs/resume_recording.rb +0 -14
- data/lib/bandwidth/voice_lib/bxml/verbs/ring.rb +0 -16
- data/lib/bandwidth/voice_lib/bxml/verbs/send_dtmf.rb +0 -16
- data/lib/bandwidth/voice_lib/bxml/verbs/sip_uri.rb +0 -25
- data/lib/bandwidth/voice_lib/bxml/verbs/speak_sentence.rb +0 -18
- data/lib/bandwidth/voice_lib/bxml/verbs/start_gather.rb +0 -20
- data/lib/bandwidth/voice_lib/bxml/verbs/start_recording.rb +0 -25
- data/lib/bandwidth/voice_lib/bxml/verbs/stop_gather.rb +0 -14
- data/lib/bandwidth/voice_lib/bxml/verbs/stop_recording.rb +0 -14
- data/lib/bandwidth/voice_lib/bxml/verbs/tag.rb +0 -13
- data/lib/bandwidth/voice_lib/bxml/verbs/transfer.rb +0 -48
- data/lib/bandwidth/voice_lib/bxml/verbs/xml_verb.rb +0 -26
- data/lib/bandwidth/voice_lib/voice/client.rb +0 -60
- data/lib/bandwidth/voice_lib/voice/controllers/api_controller.rb +0 -1820
- data/lib/bandwidth/voice_lib/voice/controllers/base_controller.rb +0 -47
- data/lib/bandwidth/voice_lib/voice/exceptions/api_error_exception.rb +0 -42
- data/lib/bandwidth/voice_lib/voice/models/answer_fallback_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/answer_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/call_callback.rb +0 -343
- data/lib/bandwidth/voice_lib/voice/models/call_recording_metadata.rb +0 -250
- data/lib/bandwidth/voice_lib/voice/models/call_state.rb +0 -301
- data/lib/bandwidth/voice_lib/voice/models/callback_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/conference_callback.rb +0 -211
- data/lib/bandwidth/voice_lib/voice/models/conference_event_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/conference_member_state.rb +0 -103
- data/lib/bandwidth/voice_lib/voice/models/conference_recording_metadata.rb +0 -173
- data/lib/bandwidth/voice_lib/voice/models/conference_state.rb +0 -153
- data/lib/bandwidth/voice_lib/voice/models/create_call_request.rb +0 -236
- data/lib/bandwidth/voice_lib/voice/models/create_call_response.rb +0 -266
- data/lib/bandwidth/voice_lib/voice/models/direction_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/disconnect_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/diversion.rb +0 -80
- data/lib/bandwidth/voice_lib/voice/models/fallback_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/file_format_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/machine_detection_configuration.rb +0 -231
- data/lib/bandwidth/voice_lib/voice/models/mode_enum.rb +0 -20
- data/lib/bandwidth/voice_lib/voice/models/modify_call_recording_request.rb +0 -48
- data/lib/bandwidth/voice_lib/voice/models/modify_call_request.rb +0 -156
- data/lib/bandwidth/voice_lib/voice/models/modify_conference_request.rb +0 -144
- data/lib/bandwidth/voice_lib/voice/models/redirect_fallback_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/redirect_method_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/state1_enum.rb +0 -20
- data/lib/bandwidth/voice_lib/voice/models/state_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/status_enum.rb +0 -17
- data/lib/bandwidth/voice_lib/voice/models/transcribe_recording_request.rb +0 -108
- data/lib/bandwidth/voice_lib/voice/models/transcript.rb +0 -60
- data/lib/bandwidth/voice_lib/voice/models/transcription.rb +0 -80
- data/lib/bandwidth/voice_lib/voice/models/transcription_metadata.rb +0 -89
- data/lib/bandwidth/voice_lib/voice/models/transcription_response.rb +0 -59
- data/lib/bandwidth/voice_lib/voice.rb +0 -48
- data/lib/bandwidth/web_rtc_lib/utils/web_rtc_transfer.rb +0 -18
- data/lib/bandwidth/web_rtc_lib/web_rtc/client.rb +0 -60
- data/lib/bandwidth/web_rtc_lib/web_rtc/controllers/api_controller.rb +0 -703
- data/lib/bandwidth/web_rtc_lib/web_rtc/controllers/base_controller.rb +0 -47
- data/lib/bandwidth/web_rtc_lib/web_rtc/exceptions/error_exception.rb +0 -37
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/accounts_participants_response.rb +0 -62
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/device_api_version_enum.rb +0 -17
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/participant.rb +0 -115
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/participant_subscription.rb +0 -48
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/publish_permission_enum.rb +0 -17
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/session.rb +0 -60
- data/lib/bandwidth/web_rtc_lib/web_rtc/models/subscriptions.rb +0 -71
- data/lib/bandwidth/web_rtc_lib/web_rtc.rb +0 -22
- data/lib/bandwidth.rb +0 -73
- data/test/controllers/controller_test_base.rb +0 -21
- data/test/http_response_catcher.rb +0 -19
- data/test/integration/test_integration.rb +0 -691
- data/test/test_helper.rb +0 -94
data/docs/CallsApi.md
ADDED
|
@@ -0,0 +1,304 @@
|
|
|
1
|
+
# Bandwidth::CallsApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**create_call**](CallsApi.md#create_call) | **POST** /accounts/{accountId}/calls | Create Call |
|
|
8
|
+
| [**get_call_state**](CallsApi.md#get_call_state) | **GET** /accounts/{accountId}/calls/{callId} | Get Call State Information |
|
|
9
|
+
| [**update_call**](CallsApi.md#update_call) | **POST** /accounts/{accountId}/calls/{callId} | Update Call |
|
|
10
|
+
| [**update_call_bxml**](CallsApi.md#update_call_bxml) | **PUT** /accounts/{accountId}/calls/{callId}/bxml | Update Call BXML |
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## create_call
|
|
14
|
+
|
|
15
|
+
> <CreateCallResponse> create_call(account_id, create_call)
|
|
16
|
+
|
|
17
|
+
Create Call
|
|
18
|
+
|
|
19
|
+
Creates an outbound phone call. All calls are initially queued. Your outbound calls will initiated at a specific dequeueing rate, enabling your application to \"fire and forget\" when creating calls. Queued calls may not be modified until they are dequeued and placed, but may be removed from your queue on demand. <b>Please note:</b> Calls submitted to your queue will be placed approximately in order, but exact ordering is not guaranteed.
|
|
20
|
+
|
|
21
|
+
### Examples
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'time'
|
|
25
|
+
require 'bandwidth-sdk'
|
|
26
|
+
# setup authorization
|
|
27
|
+
Bandwidth.configure do |config|
|
|
28
|
+
# Configure HTTP basic authorization: Basic
|
|
29
|
+
config.username = 'YOUR USERNAME'
|
|
30
|
+
config.password = 'YOUR PASSWORD'
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
api_instance = Bandwidth::CallsApi.new
|
|
34
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
|
35
|
+
create_call = Bandwidth::CreateCall.new({to: '+19195551234', from: '+19195554321', application_id: '1234-qwer-5679-tyui', answer_url: 'https://www.myCallbackServer.example/webhooks/answer'}) # CreateCall | JSON object containing information to create an outbound call
|
|
36
|
+
|
|
37
|
+
begin
|
|
38
|
+
# Create Call
|
|
39
|
+
result = api_instance.create_call(account_id, create_call)
|
|
40
|
+
p result
|
|
41
|
+
rescue Bandwidth::ApiError => e
|
|
42
|
+
puts "Error when calling CallsApi->create_call: #{e}"
|
|
43
|
+
end
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
#### Using the create_call_with_http_info variant
|
|
47
|
+
|
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
|
49
|
+
|
|
50
|
+
> <Array(<CreateCallResponse>, Integer, Hash)> create_call_with_http_info(account_id, create_call)
|
|
51
|
+
|
|
52
|
+
```ruby
|
|
53
|
+
begin
|
|
54
|
+
# Create Call
|
|
55
|
+
data, status_code, headers = api_instance.create_call_with_http_info(account_id, create_call)
|
|
56
|
+
p status_code # => 2xx
|
|
57
|
+
p headers # => { ... }
|
|
58
|
+
p data # => <CreateCallResponse>
|
|
59
|
+
rescue Bandwidth::ApiError => e
|
|
60
|
+
puts "Error when calling CallsApi->create_call_with_http_info: #{e}"
|
|
61
|
+
end
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### Parameters
|
|
65
|
+
|
|
66
|
+
| Name | Type | Description | Notes |
|
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
|
68
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
|
69
|
+
| **create_call** | [**CreateCall**](CreateCall.md) | JSON object containing information to create an outbound call | |
|
|
70
|
+
|
|
71
|
+
### Return type
|
|
72
|
+
|
|
73
|
+
[**CreateCallResponse**](CreateCallResponse.md)
|
|
74
|
+
|
|
75
|
+
### Authorization
|
|
76
|
+
|
|
77
|
+
[Basic](../README.md#Basic)
|
|
78
|
+
|
|
79
|
+
### HTTP request headers
|
|
80
|
+
|
|
81
|
+
- **Content-Type**: application/json
|
|
82
|
+
- **Accept**: application/json
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
## get_call_state
|
|
86
|
+
|
|
87
|
+
> <CallState> get_call_state(account_id, call_id)
|
|
88
|
+
|
|
89
|
+
Get Call State Information
|
|
90
|
+
|
|
91
|
+
Retrieve the current state of a specific call. This information is near-realtime, so it may take a few minutes for your call to be accessible using this endpoint. **Note**: Call information is kept for 7 days after the calls are hung up. If you attempt to retrieve information for a call that is older than 7 days, you will get an HTTP 404 response.
|
|
92
|
+
|
|
93
|
+
### Examples
|
|
94
|
+
|
|
95
|
+
```ruby
|
|
96
|
+
require 'time'
|
|
97
|
+
require 'bandwidth-sdk'
|
|
98
|
+
# setup authorization
|
|
99
|
+
Bandwidth.configure do |config|
|
|
100
|
+
# Configure HTTP basic authorization: Basic
|
|
101
|
+
config.username = 'YOUR USERNAME'
|
|
102
|
+
config.password = 'YOUR PASSWORD'
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
api_instance = Bandwidth::CallsApi.new
|
|
106
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
|
107
|
+
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
|
|
108
|
+
|
|
109
|
+
begin
|
|
110
|
+
# Get Call State Information
|
|
111
|
+
result = api_instance.get_call_state(account_id, call_id)
|
|
112
|
+
p result
|
|
113
|
+
rescue Bandwidth::ApiError => e
|
|
114
|
+
puts "Error when calling CallsApi->get_call_state: #{e}"
|
|
115
|
+
end
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
#### Using the get_call_state_with_http_info variant
|
|
119
|
+
|
|
120
|
+
This returns an Array which contains the response data, status code and headers.
|
|
121
|
+
|
|
122
|
+
> <Array(<CallState>, Integer, Hash)> get_call_state_with_http_info(account_id, call_id)
|
|
123
|
+
|
|
124
|
+
```ruby
|
|
125
|
+
begin
|
|
126
|
+
# Get Call State Information
|
|
127
|
+
data, status_code, headers = api_instance.get_call_state_with_http_info(account_id, call_id)
|
|
128
|
+
p status_code # => 2xx
|
|
129
|
+
p headers # => { ... }
|
|
130
|
+
p data # => <CallState>
|
|
131
|
+
rescue Bandwidth::ApiError => e
|
|
132
|
+
puts "Error when calling CallsApi->get_call_state_with_http_info: #{e}"
|
|
133
|
+
end
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
|
|
138
|
+
| Name | Type | Description | Notes |
|
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
|
140
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
|
141
|
+
| **call_id** | **String** | Programmable Voice API Call ID. | |
|
|
142
|
+
|
|
143
|
+
### Return type
|
|
144
|
+
|
|
145
|
+
[**CallState**](CallState.md)
|
|
146
|
+
|
|
147
|
+
### Authorization
|
|
148
|
+
|
|
149
|
+
[Basic](../README.md#Basic)
|
|
150
|
+
|
|
151
|
+
### HTTP request headers
|
|
152
|
+
|
|
153
|
+
- **Content-Type**: Not defined
|
|
154
|
+
- **Accept**: application/json
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
## update_call
|
|
158
|
+
|
|
159
|
+
> update_call(account_id, call_id, update_call)
|
|
160
|
+
|
|
161
|
+
Update Call
|
|
162
|
+
|
|
163
|
+
Interrupts and redirects a call to a different URL that should return a BXML document.
|
|
164
|
+
|
|
165
|
+
### Examples
|
|
166
|
+
|
|
167
|
+
```ruby
|
|
168
|
+
require 'time'
|
|
169
|
+
require 'bandwidth-sdk'
|
|
170
|
+
# setup authorization
|
|
171
|
+
Bandwidth.configure do |config|
|
|
172
|
+
# Configure HTTP basic authorization: Basic
|
|
173
|
+
config.username = 'YOUR USERNAME'
|
|
174
|
+
config.password = 'YOUR PASSWORD'
|
|
175
|
+
end
|
|
176
|
+
|
|
177
|
+
api_instance = Bandwidth::CallsApi.new
|
|
178
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
|
179
|
+
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
|
|
180
|
+
update_call = Bandwidth::UpdateCall.new # UpdateCall | JSON object containing information to redirect an existing call to a new BXML document
|
|
181
|
+
|
|
182
|
+
begin
|
|
183
|
+
# Update Call
|
|
184
|
+
api_instance.update_call(account_id, call_id, update_call)
|
|
185
|
+
rescue Bandwidth::ApiError => e
|
|
186
|
+
puts "Error when calling CallsApi->update_call: #{e}"
|
|
187
|
+
end
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
#### Using the update_call_with_http_info variant
|
|
191
|
+
|
|
192
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
193
|
+
|
|
194
|
+
> <Array(nil, Integer, Hash)> update_call_with_http_info(account_id, call_id, update_call)
|
|
195
|
+
|
|
196
|
+
```ruby
|
|
197
|
+
begin
|
|
198
|
+
# Update Call
|
|
199
|
+
data, status_code, headers = api_instance.update_call_with_http_info(account_id, call_id, update_call)
|
|
200
|
+
p status_code # => 2xx
|
|
201
|
+
p headers # => { ... }
|
|
202
|
+
p data # => nil
|
|
203
|
+
rescue Bandwidth::ApiError => e
|
|
204
|
+
puts "Error when calling CallsApi->update_call_with_http_info: #{e}"
|
|
205
|
+
end
|
|
206
|
+
```
|
|
207
|
+
|
|
208
|
+
### Parameters
|
|
209
|
+
|
|
210
|
+
| Name | Type | Description | Notes |
|
|
211
|
+
| ---- | ---- | ----------- | ----- |
|
|
212
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
|
213
|
+
| **call_id** | **String** | Programmable Voice API Call ID. | |
|
|
214
|
+
| **update_call** | [**UpdateCall**](UpdateCall.md) | JSON object containing information to redirect an existing call to a new BXML document | |
|
|
215
|
+
|
|
216
|
+
### Return type
|
|
217
|
+
|
|
218
|
+
nil (empty response body)
|
|
219
|
+
|
|
220
|
+
### Authorization
|
|
221
|
+
|
|
222
|
+
[Basic](../README.md#Basic)
|
|
223
|
+
|
|
224
|
+
### HTTP request headers
|
|
225
|
+
|
|
226
|
+
- **Content-Type**: application/json
|
|
227
|
+
- **Accept**: application/json
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
## update_call_bxml
|
|
231
|
+
|
|
232
|
+
> update_call_bxml(account_id, call_id, body)
|
|
233
|
+
|
|
234
|
+
Update Call BXML
|
|
235
|
+
|
|
236
|
+
Interrupts and replaces an active call's BXML document.
|
|
237
|
+
|
|
238
|
+
### Examples
|
|
239
|
+
|
|
240
|
+
```ruby
|
|
241
|
+
require 'time'
|
|
242
|
+
require 'bandwidth-sdk'
|
|
243
|
+
# setup authorization
|
|
244
|
+
Bandwidth.configure do |config|
|
|
245
|
+
# Configure HTTP basic authorization: Basic
|
|
246
|
+
config.username = 'YOUR USERNAME'
|
|
247
|
+
config.password = 'YOUR PASSWORD'
|
|
248
|
+
end
|
|
249
|
+
|
|
250
|
+
api_instance = Bandwidth::CallsApi.new
|
|
251
|
+
account_id = '9900000' # String | Your Bandwidth Account ID.
|
|
252
|
+
call_id = 'c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85' # String | Programmable Voice API Call ID.
|
|
253
|
+
body = '<?xml version=\"1.0\" encoding=\"UTF-8\"?>
|
|
254
|
+
<Bxml>
|
|
255
|
+
<SpeakSentence>This is a test sentence.</SpeakSentence>
|
|
256
|
+
</Bxml>' # String |
|
|
257
|
+
|
|
258
|
+
begin
|
|
259
|
+
# Update Call BXML
|
|
260
|
+
api_instance.update_call_bxml(account_id, call_id, body)
|
|
261
|
+
rescue Bandwidth::ApiError => e
|
|
262
|
+
puts "Error when calling CallsApi->update_call_bxml: #{e}"
|
|
263
|
+
end
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
#### Using the update_call_bxml_with_http_info variant
|
|
267
|
+
|
|
268
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
269
|
+
|
|
270
|
+
> <Array(nil, Integer, Hash)> update_call_bxml_with_http_info(account_id, call_id, body)
|
|
271
|
+
|
|
272
|
+
```ruby
|
|
273
|
+
begin
|
|
274
|
+
# Update Call BXML
|
|
275
|
+
data, status_code, headers = api_instance.update_call_bxml_with_http_info(account_id, call_id, body)
|
|
276
|
+
p status_code # => 2xx
|
|
277
|
+
p headers # => { ... }
|
|
278
|
+
p data # => nil
|
|
279
|
+
rescue Bandwidth::ApiError => e
|
|
280
|
+
puts "Error when calling CallsApi->update_call_bxml_with_http_info: #{e}"
|
|
281
|
+
end
|
|
282
|
+
```
|
|
283
|
+
|
|
284
|
+
### Parameters
|
|
285
|
+
|
|
286
|
+
| Name | Type | Description | Notes |
|
|
287
|
+
| ---- | ---- | ----------- | ----- |
|
|
288
|
+
| **account_id** | **String** | Your Bandwidth Account ID. | |
|
|
289
|
+
| **call_id** | **String** | Programmable Voice API Call ID. | |
|
|
290
|
+
| **body** | **String** | | |
|
|
291
|
+
|
|
292
|
+
### Return type
|
|
293
|
+
|
|
294
|
+
nil (empty response body)
|
|
295
|
+
|
|
296
|
+
### Authorization
|
|
297
|
+
|
|
298
|
+
[Basic](../README.md#Basic)
|
|
299
|
+
|
|
300
|
+
### HTTP request headers
|
|
301
|
+
|
|
302
|
+
- **Content-Type**: application/xml
|
|
303
|
+
- **Accept**: application/json
|
|
304
|
+
|
data/docs/CodeRequest.md
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Bandwidth::CodeRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **to** | **String** | The phone number to send the mfa code to. | |
|
|
8
|
+
| **from** | **String** | The application phone number, the sender of the mfa code. | |
|
|
9
|
+
| **application_id** | **String** | The application unique ID, obtained from Bandwidth. | |
|
|
10
|
+
| **scope** | **String** | An optional field to denote what scope or action the mfa code is addressing. If not supplied, defaults to \"2FA\". | [optional] |
|
|
11
|
+
| **message** | **String** | The message format of the mfa code. There are three values that the system will replace \"{CODE}\", \"{NAME}\", \"{SCOPE}\". The \"{SCOPE}\" and \"{NAME} value template are optional, while \"{CODE}\" must be supplied. As the name would suggest, code will be replace with the actual mfa code. Name is replaced with the application name, configured during provisioning of mfa. The scope value is the same value sent during the call and partitioned by the server. | |
|
|
12
|
+
| **digits** | **Integer** | The number of digits for your mfa code. The valid number ranges from 2 to 8, inclusively. | |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'bandwidth-sdk'
|
|
18
|
+
|
|
19
|
+
instance = Bandwidth::CodeRequest.new(
|
|
20
|
+
to: +19195551234,
|
|
21
|
+
from: +19195554321,
|
|
22
|
+
application_id: 66fd98ae-ac8d-a00f-7fcd-ba3280aeb9b1,
|
|
23
|
+
scope: 2FA,
|
|
24
|
+
message: Your temporary {NAME} {SCOPE} code is {CODE},
|
|
25
|
+
digits: 6
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
data/docs/Conference.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Bandwidth::Conference
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | The Bandwidth-generated conference ID. | [optional] |
|
|
8
|
+
| **name** | **String** | The name of the conference, as specified by your application. | [optional] |
|
|
9
|
+
| **created_time** | **Time** | The time the conference was initiated, in ISO 8601 format. | [optional] |
|
|
10
|
+
| **completed_time** | **Time** | The time the conference was terminated, in ISO 8601 format. | [optional] |
|
|
11
|
+
| **conference_event_url** | **String** | The URL to send the conference-related events. | [optional] |
|
|
12
|
+
| **conference_event_method** | [**CallbackMethodEnum**](CallbackMethodEnum.md) | | [optional][default to 'POST'] |
|
|
13
|
+
| **tag** | **String** | The custom string attached to the conference that will be sent with callbacks. | [optional] |
|
|
14
|
+
| **active_members** | [**Array<ConferenceMember>**](ConferenceMember.md) | A list of active members of the conference. Omitted if this is a response to the [Get Conferences endpoint](/apis/voice#tag/Conferences/operation/listConferences). | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'bandwidth-sdk'
|
|
20
|
+
|
|
21
|
+
instance = Bandwidth::Conference.new(
|
|
22
|
+
id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
|
23
|
+
name: my-conference-name,
|
|
24
|
+
created_time: 2022-06-17T22:19:40.375Z,
|
|
25
|
+
completed_time: 2022-06-17T22:20Z,
|
|
26
|
+
conference_event_url: https://myServer.example/bandwidth/webhooks/conferenceEvent,
|
|
27
|
+
conference_event_method: null,
|
|
28
|
+
tag: my custom tag,
|
|
29
|
+
active_members: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Bandwidth::ConferenceCompletedCallback
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
|
+
| **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
|
|
9
|
+
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
|
10
|
+
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
|
11
|
+
| **tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'bandwidth-sdk'
|
|
17
|
+
|
|
18
|
+
instance = Bandwidth::ConferenceCompletedCallback.new(
|
|
19
|
+
event_type: bridgeComplete,
|
|
20
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
|
21
|
+
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
|
22
|
+
name: my-conference-name,
|
|
23
|
+
tag: exampleTag
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Bandwidth::ConferenceCreatedCallback
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
|
+
| **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
|
|
9
|
+
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
|
10
|
+
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
|
11
|
+
| **tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'bandwidth-sdk'
|
|
17
|
+
|
|
18
|
+
instance = Bandwidth::ConferenceCreatedCallback.new(
|
|
19
|
+
event_type: bridgeComplete,
|
|
20
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
|
21
|
+
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
|
22
|
+
name: my-conference-name,
|
|
23
|
+
tag: exampleTag
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# Bandwidth::ConferenceMember
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **call_id** | **String** | The call id associated with the event. | [optional] |
|
|
8
|
+
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
|
9
|
+
| **member_url** | **String** | A URL that may be used to retrieve information about or update the state of this conference member. This is the URL of this member's [Get Conference Member](/apis/voice/#operation/getConferenceMember) endpoint and [Modify Conference Member](/apis/voice/#operation/updateConferenceMember) endpoint. | [optional] |
|
|
10
|
+
| **mute** | **Boolean** | Whether or not this member is currently muted. Members who are muted are still able to hear other participants. If used in a PUT request, updates this member's mute status. Has no effect if omitted. | [optional] |
|
|
11
|
+
| **hold** | **Boolean** | Whether or not this member is currently on hold. Members who are on hold are not able to hear or speak in the conference. If used in a PUT request, updates this member's hold status. Has no effect if omitted. | [optional] |
|
|
12
|
+
| **call_ids_to_coach** | **Array<String>** | If this member had a value set for `callIdsToCoach` in its [Conference](/docs/voice/bxml/conference) verb or this list was added with a previous PUT request to modify the member, this is that list of calls. If present in a PUT request, modifies the calls that this member is coaching. Has no effect if omitted. See the documentation for the [Conference](/docs/voice/bxml/conference) verb for more details about coaching. Note that this will not add the matching calls to the conference; each call must individually execute a Conference verb to join. | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'bandwidth-sdk'
|
|
18
|
+
|
|
19
|
+
instance = Bandwidth::ConferenceMember.new(
|
|
20
|
+
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
21
|
+
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
|
22
|
+
member_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/members/c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
23
|
+
mute: false,
|
|
24
|
+
hold: false,
|
|
25
|
+
call_ids_to_coach: ["c-25ac29a2-1331029c-2cb0-4a07-b215-b22865662d85"]
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Bandwidth::ConferenceMemberExitCallback
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
|
+
| **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
|
|
9
|
+
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
|
10
|
+
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
|
11
|
+
| **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
|
|
12
|
+
| **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
|
|
13
|
+
| **call_id** | **String** | The call id associated with the event. | [optional] |
|
|
14
|
+
| **tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'bandwidth-sdk'
|
|
20
|
+
|
|
21
|
+
instance = Bandwidth::ConferenceMemberExitCallback.new(
|
|
22
|
+
event_type: bridgeComplete,
|
|
23
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
|
24
|
+
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
|
25
|
+
name: my-conference-name,
|
|
26
|
+
from: +15555555555,
|
|
27
|
+
to: +15555555555,
|
|
28
|
+
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
29
|
+
tag: exampleTag
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Bandwidth::ConferenceMemberJoinCallback
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
|
+
| **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
|
|
9
|
+
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
|
10
|
+
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
|
11
|
+
| **from** | **String** | The provided identifier of the caller: can be a phone number in E.164 format (e.g. +15555555555) or one of Private, Restricted, Unavailable, or Anonymous. | [optional] |
|
|
12
|
+
| **to** | **String** | The phone number that received the call, in E.164 format (e.g. +15555555555). | [optional] |
|
|
13
|
+
| **call_id** | **String** | The call id associated with the event. | [optional] |
|
|
14
|
+
| **tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'bandwidth-sdk'
|
|
20
|
+
|
|
21
|
+
instance = Bandwidth::ConferenceMemberJoinCallback.new(
|
|
22
|
+
event_type: bridgeComplete,
|
|
23
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
|
24
|
+
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
|
25
|
+
name: my-conference-name,
|
|
26
|
+
from: +15555555555,
|
|
27
|
+
to: +15555555555,
|
|
28
|
+
call_id: c-15ac29a2-1331029c-2cb0-4a07-b215-b22865662d85,
|
|
29
|
+
tag: exampleTag
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Bandwidth::ConferenceRecordingAvailableCallback
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
|
+
| **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
|
|
9
|
+
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
|
10
|
+
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
|
11
|
+
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
|
12
|
+
| **recording_id** | **String** | The unique ID of this recording | [optional] |
|
|
13
|
+
| **channels** | **Integer** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] |
|
|
14
|
+
| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
|
|
15
|
+
| **end_time** | **Time** | The time that the recording ended in ISO-8601 format | [optional] |
|
|
16
|
+
| **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
|
|
17
|
+
| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] |
|
|
18
|
+
| **media_url** | **String** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] |
|
|
19
|
+
| **tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] |
|
|
20
|
+
| **status** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```ruby
|
|
25
|
+
require 'bandwidth-sdk'
|
|
26
|
+
|
|
27
|
+
instance = Bandwidth::ConferenceRecordingAvailableCallback.new(
|
|
28
|
+
event_type: bridgeComplete,
|
|
29
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
|
30
|
+
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
|
31
|
+
name: my-conference-name,
|
|
32
|
+
account_id: 920012,
|
|
33
|
+
recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
|
|
34
|
+
channels: 1,
|
|
35
|
+
start_time: 2022-06-17T22:19:40.375Z,
|
|
36
|
+
end_time: 2022-06-17T22:20Z,
|
|
37
|
+
duration: PT13.67S,
|
|
38
|
+
file_format: null,
|
|
39
|
+
media_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media,
|
|
40
|
+
tag: exampleTag,
|
|
41
|
+
status: completed
|
|
42
|
+
)
|
|
43
|
+
```
|
|
44
|
+
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# Bandwidth::ConferenceRecordingMetadata
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | The user account associated with the call. | [optional] |
|
|
8
|
+
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
|
9
|
+
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
|
10
|
+
| **recording_id** | **String** | The unique ID of this recording | [optional] |
|
|
11
|
+
| **duration** | **String** | The duration of the recording in ISO-8601 format | [optional] |
|
|
12
|
+
| **channels** | **Integer** | Always `1` for conference recordings; multi-channel recordings are not supported on conferences. | [optional] |
|
|
13
|
+
| **start_time** | **Time** | Time the call was started, in ISO 8601 format. | [optional] |
|
|
14
|
+
| **end_time** | **Time** | The time that the recording ended in ISO-8601 format | [optional] |
|
|
15
|
+
| **file_format** | [**FileFormatEnum**](FileFormatEnum.md) | | [optional] |
|
|
16
|
+
| **status** | **String** | The current status of the process. For recording, current possible values are 'processing', 'partial', 'complete', 'deleted', and 'error'. For transcriptions, current possible values are 'none', 'processing', 'available', 'error', 'timeout', 'file-size-too-big', and 'file-size-too-small'. Additional states may be added in the future, so your application must be tolerant of unknown values. | [optional] |
|
|
17
|
+
| **media_url** | **String** | The URL that can be used to download the recording. Only present if the recording is finished and may be downloaded. | [optional] |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
```ruby
|
|
22
|
+
require 'bandwidth-sdk'
|
|
23
|
+
|
|
24
|
+
instance = Bandwidth::ConferenceRecordingMetadata.new(
|
|
25
|
+
account_id: 920012,
|
|
26
|
+
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
|
27
|
+
name: my-conference-name,
|
|
28
|
+
recording_id: r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833,
|
|
29
|
+
duration: PT13.67S,
|
|
30
|
+
channels: 1,
|
|
31
|
+
start_time: 2022-06-17T22:19:40.375Z,
|
|
32
|
+
end_time: 2022-06-17T22:20Z,
|
|
33
|
+
file_format: null,
|
|
34
|
+
status: completed,
|
|
35
|
+
media_url: https://voice.bandwidth.com/api/v2/accounts/9900000/conferences/conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9/recordings/r-fbe05094-9fd2afe9-bf5b-4c68-820a-41a01c1c5833/media
|
|
36
|
+
)
|
|
37
|
+
```
|
|
38
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Bandwidth::ConferenceRedirectCallback
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **event_type** | **String** | The event type, value can be one of the following: answer, bridgeComplete, bridgeTargetComplete, conferenceCreated, conferenceRedirect, conferenceMemberJoin, conferenceMemberExit, conferenceCompleted, conferenceRecordingAvailable, disconnect, dtmf, gather, initiate, machineDetectionComplete, recordingComplete, recordingAvailable, redirect, transcriptionAvailable, transferAnswer, transferComplete, transferDisconnect. | [optional] |
|
|
8
|
+
| **event_time** | **Time** | The approximate UTC date and time when the event was generated by the Bandwidth server, in ISO 8601 format. This may not be exactly the time of event execution. | [optional] |
|
|
9
|
+
| **conference_id** | **String** | The unique, Bandwidth-generated ID of the conference that was recorded | [optional] |
|
|
10
|
+
| **name** | **String** | The user-specified name of the conference that was recorded | [optional] |
|
|
11
|
+
| **tag** | **String** | (optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present. | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'bandwidth-sdk'
|
|
17
|
+
|
|
18
|
+
instance = Bandwidth::ConferenceRedirectCallback.new(
|
|
19
|
+
event_type: bridgeComplete,
|
|
20
|
+
event_time: 2022-06-17T22:19:40.375Z,
|
|
21
|
+
conference_id: conf-fe23a767-a75a5b77-20c5-4cca-b581-cbbf0776eca9,
|
|
22
|
+
name: my-conference-name,
|
|
23
|
+
tag: exampleTag
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Bandwidth::ConferenceStateEnum
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'bandwidth-sdk'
|
|
12
|
+
|
|
13
|
+
instance = Bandwidth::ConferenceStateEnum.new()
|
|
14
|
+
```
|
|
15
|
+
|