freeclimb 4.9.0 → 5.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/CHANGELOG.md +14 -0
- data/Gemfile.lock +34 -18
- data/README.md +43 -51
- data/docs/AddToConferenceNotificationWebhook.md +42 -0
- data/docs/AddToQueueNotificationWebhook.md +34 -0
- data/docs/BargeInReason.md +18 -0
- data/docs/CallControlWebhook.md +26 -0
- data/docs/CallEndedReason.md +38 -0
- data/docs/CallStatusWebhook.md +36 -0
- data/docs/CompletionResult.md +1 -1
- data/docs/CompletionResultStatus.md +17 -0
- data/docs/ConferenceRecordingStatusWebhook.md +42 -0
- data/docs/ConferenceResult.md +1 -1
- data/docs/ConferenceStatusWebhook.md +42 -0
- data/docs/CreateConference.md +1 -1
- data/docs/CreateConferenceRequest.md +1 -1
- data/docs/CreateConferenceWebhook.md +42 -0
- data/docs/DequeueWebhook.md +38 -0
- data/docs/GetDigitsReason.md +19 -0
- data/docs/GetDigitsWebhook.md +40 -0
- data/docs/GetSpeechWebhook.md +50 -0
- data/docs/InboundCallWebhook.md +36 -0
- data/docs/LeaveConferenceWebhook.md +34 -0
- data/docs/MachineDetectedWebhook.md +38 -0
- data/docs/MachineType.md +2 -2
- data/docs/MessageDeliveryWebhook.md +36 -0
- data/docs/MessageStatusWebhook.md +38 -0
- data/docs/OutDialApiConnectWebhook.md +36 -0
- data/docs/OutDialConnectWebhook.md +36 -0
- data/docs/OutDialStartWebhook.md +38 -0
- data/docs/QueueWaitWebhook.md +40 -0
- data/docs/RecordWebhook.md +50 -0
- data/docs/RedirectWebhook.md +36 -0
- data/docs/RemoveFromQueueNotificationWebhook.md +38 -0
- data/docs/SMSTenDLCBrand.md +6 -6
- data/docs/SMSTenDLCBrandAltBusinessIdType.md +19 -0
- data/docs/SMSTenDLCBrandEntityType.md +20 -0
- data/docs/SMSTenDLCBrandIdentityStatus.md +19 -0
- data/docs/SMSTenDLCBrandRelationship.md +20 -0
- data/docs/SMSTenDLCBrandStockExchange.md +42 -0
- data/docs/SMSTenDLCCampaign.md +1 -1
- data/docs/SMSTenDLCCampaignStatus.md +17 -0
- data/docs/SMSTenDLCPartnerCampaign.md +1 -1
- data/docs/SMSTenDLCPartnerCampaignStatus.md +17 -0
- data/docs/SMSTollFreeCampaign.md +1 -1
- data/docs/SMSTollFreeCampaignRegistrationStatus.md +20 -0
- data/docs/TranscribeReason.md +20 -0
- data/docs/TranscribeTermReason.md +17 -0
- data/docs/TranscribeUtterance.md +2 -2
- data/docs/TranscribeWebhook.md +62 -0
- data/docs/UpdateConferenceRequest.md +1 -1
- data/docs/Webhook.md +18 -0
- data/freeclimb.gemspec +1 -1
- data/lib/freeclimb/api/default_api.rb +18 -18
- data/lib/freeclimb/api_client.rb +1 -1
- data/lib/freeclimb/api_error.rb +1 -1
- data/lib/freeclimb/configuration.rb +1 -2
- data/lib/freeclimb/models/account_request.rb +1 -3
- data/lib/freeclimb/models/account_result.rb +23 -4
- data/lib/freeclimb/models/account_status.rb +1 -1
- data/lib/freeclimb/models/account_type.rb +1 -1
- data/lib/freeclimb/models/add_to_conference.rb +1 -4
- data/lib/freeclimb/models/add_to_conference_notification_webhook.rb +384 -0
- data/lib/freeclimb/models/{conference_participant_result_all_of.rb → add_to_queue_notification_webhook.rb} +112 -59
- data/lib/freeclimb/models/answered_by.rb +1 -1
- data/lib/freeclimb/models/application_list.rb +1 -4
- data/lib/freeclimb/models/application_request.rb +1 -3
- data/lib/freeclimb/models/application_result.rb +1 -4
- data/lib/freeclimb/models/available_number.rb +1 -3
- data/lib/freeclimb/models/available_number_list.rb +1 -4
- data/lib/freeclimb/models/barge_in_reason.rb +38 -0
- data/lib/freeclimb/models/buy_incoming_number_request.rb +1 -3
- data/lib/freeclimb/models/{recording_result_all_of.rb → call_control_webhook.rb} +57 -45
- data/lib/freeclimb/models/call_direction.rb +1 -1
- data/lib/freeclimb/models/call_ended_reason.rb +58 -0
- data/lib/freeclimb/models/call_list.rb +1 -4
- data/lib/freeclimb/models/call_result.rb +23 -4
- data/lib/freeclimb/models/call_status.rb +1 -1
- data/lib/freeclimb/models/call_status_webhook.rb +354 -0
- data/lib/freeclimb/models/capabilities.rb +1 -3
- data/lib/freeclimb/models/completion_request.rb +1 -3
- data/lib/freeclimb/models/completion_result.rb +2 -15
- data/lib/freeclimb/models/completion_result_status.rb +37 -0
- data/lib/freeclimb/models/conference_list.rb +1 -4
- data/lib/freeclimb/models/conference_participant_list.rb +1 -4
- data/lib/freeclimb/models/conference_participant_result.rb +1 -4
- data/lib/freeclimb/models/conference_recording_status_webhook.rb +384 -0
- data/lib/freeclimb/models/conference_result.rb +23 -6
- data/lib/freeclimb/models/conference_status.rb +1 -1
- data/lib/freeclimb/models/conference_status_webhook.rb +387 -0
- data/lib/freeclimb/models/create_conference.rb +23 -6
- data/lib/freeclimb/models/create_conference_request.rb +23 -5
- data/lib/freeclimb/models/create_conference_webhook.rb +387 -0
- data/lib/freeclimb/models/create_web_rtc_token.rb +1 -3
- data/lib/freeclimb/models/dequeue.rb +1 -3
- data/lib/freeclimb/models/dequeue_webhook.rb +365 -0
- data/lib/freeclimb/models/enqueue.rb +1 -4
- data/lib/freeclimb/models/filter_logs_request.rb +1 -3
- data/lib/freeclimb/models/get_digits.rb +1 -4
- data/lib/freeclimb/models/get_digits_reason.rb +39 -0
- data/lib/freeclimb/models/get_digits_webhook.rb +373 -0
- data/lib/freeclimb/models/get_speech.rb +23 -4
- data/lib/freeclimb/models/get_speech_reason.rb +1 -1
- data/lib/freeclimb/models/get_speech_webhook.rb +423 -0
- data/lib/freeclimb/models/grammar_file_built_in.rb +1 -1
- data/lib/freeclimb/models/grammar_type.rb +1 -1
- data/lib/freeclimb/models/hangup.rb +1 -4
- data/lib/freeclimb/models/if_machine.rb +1 -1
- data/lib/freeclimb/models/inbound_call_webhook.rb +355 -0
- data/lib/freeclimb/models/incoming_number_list.rb +1 -4
- data/lib/freeclimb/models/incoming_number_request.rb +1 -3
- data/lib/freeclimb/models/incoming_number_result.rb +1 -4
- data/lib/freeclimb/models/language.rb +1 -1
- data/lib/freeclimb/models/{conference_result_all_of.rb → leave_conference_webhook.rb} +110 -89
- data/lib/freeclimb/models/log_level.rb +1 -1
- data/lib/freeclimb/models/log_list.rb +1 -4
- data/lib/freeclimb/models/log_result.rb +23 -3
- data/lib/freeclimb/models/{call_result_all_of.rb → machine_detected_webhook.rb} +96 -119
- data/lib/freeclimb/models/machine_type.rb +3 -3
- data/lib/freeclimb/models/make_call_request.rb +1 -3
- data/lib/freeclimb/models/{message_result_all_of.rb → message_delivery_webhook.rb} +71 -87
- data/lib/freeclimb/models/message_direction.rb +1 -1
- data/lib/freeclimb/models/message_request.rb +1 -4
- data/lib/freeclimb/models/message_result.rb +23 -4
- data/lib/freeclimb/models/message_status.rb +1 -1
- data/lib/freeclimb/models/{incoming_number_result_all_of.rb → message_status_webhook.rb} +117 -107
- data/lib/freeclimb/models/messages_list.rb +1 -4
- data/lib/freeclimb/models/mutable_resource_model.rb +1 -3
- data/lib/freeclimb/models/out_dial.rb +23 -4
- data/lib/freeclimb/models/out_dial_api_connect_webhook.rb +355 -0
- data/lib/freeclimb/models/out_dial_connect_webhook.rb +355 -0
- data/lib/freeclimb/models/out_dial_start_webhook.rb +366 -0
- data/lib/freeclimb/models/pagination_model.rb +1 -3
- data/lib/freeclimb/models/park.rb +1 -4
- data/lib/freeclimb/models/pause.rb +1 -4
- data/lib/freeclimb/models/percl_command.rb +3 -5
- data/lib/freeclimb/models/percl_script.rb +2 -4
- data/lib/freeclimb/models/play.rb +2 -5
- data/lib/freeclimb/models/play_beep.rb +1 -1
- data/lib/freeclimb/models/play_early_media.rb +2 -5
- data/lib/freeclimb/models/queue_list.rb +2 -5
- data/lib/freeclimb/models/queue_member.rb +1 -3
- data/lib/freeclimb/models/queue_member_list.rb +2 -5
- data/lib/freeclimb/models/queue_request.rb +1 -3
- data/lib/freeclimb/models/queue_result.rb +2 -5
- data/lib/freeclimb/models/queue_result_status.rb +1 -1
- data/lib/freeclimb/models/queue_wait_webhook.rb +375 -0
- data/lib/freeclimb/models/record_utterance.rb +2 -5
- data/lib/freeclimb/models/record_utterance_term_reason.rb +1 -1
- data/lib/freeclimb/models/record_webhook.rb +424 -0
- data/lib/freeclimb/models/recording_list.rb +2 -5
- data/lib/freeclimb/models/recording_result.rb +2 -5
- data/lib/freeclimb/models/redirect.rb +2 -5
- data/lib/freeclimb/models/redirect_webhook.rb +355 -0
- data/lib/freeclimb/models/reject.rb +2 -5
- data/lib/freeclimb/models/remove_from_conference.rb +1 -3
- data/lib/freeclimb/models/remove_from_queue_notification_webhook.rb +364 -0
- data/lib/freeclimb/models/request_type.rb +1 -1
- data/lib/freeclimb/models/say.rb +2 -5
- data/lib/freeclimb/models/send_digits.rb +2 -5
- data/lib/freeclimb/models/set_dtmf_pass_through.rb +2 -5
- data/lib/freeclimb/models/set_listen.rb +2 -5
- data/lib/freeclimb/models/set_talk.rb +2 -5
- data/lib/freeclimb/models/sms.rb +2 -5
- data/lib/freeclimb/models/sms_ten_dlc_brand.rb +6 -67
- data/lib/freeclimb/models/sms_ten_dlc_brand_alt_business_id_type.rb +39 -0
- data/lib/freeclimb/models/sms_ten_dlc_brand_entity_type.rb +40 -0
- data/lib/freeclimb/models/sms_ten_dlc_brand_identity_status.rb +39 -0
- data/lib/freeclimb/models/sms_ten_dlc_brand_relationship.rb +40 -0
- data/lib/freeclimb/models/sms_ten_dlc_brand_stock_exchange.rb +62 -0
- data/lib/freeclimb/models/sms_ten_dlc_brands_list_result.rb +2 -5
- data/lib/freeclimb/models/sms_ten_dlc_campaign.rb +2 -15
- data/lib/freeclimb/models/sms_ten_dlc_campaign_status.rb +37 -0
- data/lib/freeclimb/models/sms_ten_dlc_campaigns_list_result.rb +2 -5
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaign.rb +2 -15
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaign_brand.rb +1 -3
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaign_status.rb +37 -0
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaigns_list_result.rb +2 -5
- data/lib/freeclimb/models/sms_toll_free_campaign.rb +2 -15
- data/lib/freeclimb/models/sms_toll_free_campaign_registration_status.rb +40 -0
- data/lib/freeclimb/models/sms_toll_free_campaigns_list_result.rb +2 -5
- data/lib/freeclimb/models/start_record_call.rb +1 -3
- data/lib/freeclimb/models/terminate_conference.rb +1 -3
- data/lib/freeclimb/models/tfn.rb +1 -3
- data/lib/freeclimb/models/transcribe_reason.rb +40 -0
- data/lib/freeclimb/models/transcribe_term_reason.rb +37 -0
- data/lib/freeclimb/models/transcribe_utterance.rb +4 -7
- data/lib/freeclimb/models/{transcribe_utterance_all_of_record.rb → transcribe_utterance_record.rb} +8 -10
- data/lib/freeclimb/models/transcribe_webhook.rb +481 -0
- data/lib/freeclimb/models/unpark.rb +1 -3
- data/lib/freeclimb/models/update_call_request.rb +23 -3
- data/lib/freeclimb/models/update_call_request_status.rb +1 -1
- data/lib/freeclimb/models/update_conference_participant_request.rb +1 -3
- data/lib/freeclimb/models/update_conference_request.rb +23 -5
- data/lib/freeclimb/models/update_conference_request_status.rb +1 -1
- data/lib/freeclimb/models/{call_list_all_of.rb → webhook.rb} +18 -17
- data/lib/freeclimb/utils/request_verifier.rb +51 -51
- data/lib/freeclimb/utils/signature_information.rb +34 -34
- data/lib/freeclimb/version.rb +2 -2
- data/lib/freeclimb.rb +41 -49
- data/openapi.json +1734 -681
- data/package.json +3 -1
- data/spec/api/default_api_spec.rb +61 -35
- data/spec/factories.rb +78 -78
- data/spec/models/account_request_spec.rb +55 -17
- data/spec/models/account_result_spec.rb +304 -80
- data/spec/models/account_status_spec.rb +1 -1
- data/spec/models/account_type_spec.rb +1 -1
- data/spec/models/add_to_conference_notification_webhook_spec.rb +866 -0
- data/spec/models/add_to_conference_spec.rb +251 -38
- data/spec/models/add_to_queue_notification_webhook_spec.rb +643 -0
- data/spec/models/answered_by_spec.rb +1 -1
- data/spec/models/application_list_spec.rb +181 -39
- data/spec/models/application_request_spec.rb +160 -32
- data/spec/models/application_result_spec.rb +286 -50
- data/spec/models/available_number_list_spec.rb +181 -39
- data/spec/models/available_number_spec.rb +160 -32
- data/spec/models/barge_in_reason_spec.rb +77 -0
- data/spec/models/buy_incoming_number_request_spec.rb +76 -20
- data/spec/models/call_control_webhook_spec.rb +385 -0
- data/spec/models/call_direction_spec.rb +1 -1
- data/spec/models/call_ended_reason_spec.rb +397 -0
- data/spec/models/call_list_spec.rb +181 -39
- data/spec/models/call_result_spec.rb +551 -122
- data/spec/models/call_status_spec.rb +1 -1
- data/spec/models/call_status_webhook_spec.rb +793 -0
- data/spec/models/capabilities_spec.rb +118 -26
- data/spec/models/completion_request_spec.rb +35 -15
- data/spec/models/completion_result_spec.rb +91 -45
- data/spec/models/completion_result_status_spec.rb +61 -0
- data/spec/models/conference_list_spec.rb +181 -39
- data/spec/models/conference_participant_list_spec.rb +181 -39
- data/spec/models/conference_participant_result_spec.rb +272 -41
- data/spec/models/conference_recording_status_webhook_spec.rb +866 -0
- data/spec/models/conference_result_spec.rb +367 -89
- data/spec/models/conference_status_spec.rb +1 -1
- data/spec/models/conference_status_webhook_spec.rb +866 -0
- data/spec/models/create_conference_request_spec.rb +148 -44
- data/spec/models/create_conference_spec.rb +169 -47
- data/spec/models/create_conference_webhook_spec.rb +866 -0
- data/spec/models/create_web_rtc_token_spec.rb +76 -20
- data/spec/models/dequeue_spec.rb +1 -1
- data/spec/models/dequeue_webhook_spec.rb +743 -0
- data/spec/models/enqueue_spec.rb +97 -23
- data/spec/models/filter_logs_request_spec.rb +34 -14
- data/spec/models/get_digits_reason_spec.rb +93 -0
- data/spec/models/get_digits_spec.rb +202 -42
- data/spec/models/get_digits_webhook_spec.rb +815 -0
- data/spec/models/get_speech_reason_spec.rb +1 -1
- data/spec/models/get_speech_spec.rb +308 -66
- data/spec/models/get_speech_webhook_spec.rb +1072 -0
- data/spec/models/grammar_file_built_in_spec.rb +1 -1
- data/spec/models/grammar_type_spec.rb +1 -1
- data/spec/models/hangup_spec.rb +34 -14
- data/spec/models/if_machine_spec.rb +1 -1
- data/spec/models/inbound_call_webhook_spec.rb +692 -0
- data/spec/models/incoming_number_list_spec.rb +181 -39
- data/spec/models/incoming_number_request_spec.rb +76 -20
- data/spec/models/incoming_number_result_spec.rb +370 -62
- data/spec/models/language_spec.rb +1 -1
- data/spec/models/leave_conference_webhook_spec.rb +643 -0
- data/spec/models/log_level_spec.rb +1 -1
- data/spec/models/log_list_spec.rb +181 -39
- data/spec/models/log_result_spec.rb +190 -50
- data/spec/models/machine_detected_webhook_spec.rb +758 -0
- data/spec/models/machine_type_spec.rb +10 -10
- data/spec/models/make_call_request_spec.rb +223 -41
- data/spec/models/message_delivery_webhook_spec.rb +630 -0
- data/spec/models/message_direction_spec.rb +1 -1
- data/spec/models/message_request_spec.rb +202 -38
- data/spec/models/message_result_spec.rb +375 -74
- data/spec/models/message_status_spec.rb +1 -1
- data/spec/models/message_status_webhook_spec.rb +732 -0
- data/spec/models/messages_list_spec.rb +181 -39
- data/spec/models/mutable_resource_model_spec.rb +97 -23
- data/spec/models/out_dial_api_connect_webhook_spec.rb +692 -0
- data/spec/models/out_dial_connect_webhook_spec.rb +692 -0
- data/spec/models/out_dial_spec.rb +253 -59
- data/spec/models/out_dial_start_webhook_spec.rb +741 -0
- data/spec/models/pagination_model_spec.rb +160 -32
- data/spec/models/park_spec.rb +76 -20
- data/spec/models/pause_spec.rb +34 -14
- data/spec/models/percl_command_spec.rb +34 -14
- data/spec/models/percl_script_spec.rb +34 -18
- data/spec/models/play_beep_spec.rb +1 -1
- data/spec/models/play_early_media_spec.rb +34 -14
- data/spec/models/play_spec.rb +76 -20
- data/spec/models/queue_list_spec.rb +181 -39
- data/spec/models/queue_member_list_spec.rb +181 -39
- data/spec/models/queue_member_spec.rb +118 -26
- data/spec/models/queue_request_spec.rb +55 -17
- data/spec/models/queue_result_spec.rb +244 -44
- data/spec/models/queue_result_status_spec.rb +1 -1
- data/spec/models/queue_wait_webhook_spec.rb +794 -0
- data/spec/models/record_utterance_spec.rb +160 -32
- data/spec/models/record_utterance_term_reason_spec.rb +1 -1
- data/spec/models/record_webhook_spec.rb +1062 -0
- data/spec/models/recording_list_spec.rb +181 -39
- data/spec/models/recording_result_spec.rb +202 -38
- data/spec/models/redirect_spec.rb +34 -14
- data/spec/models/redirect_webhook_spec.rb +692 -0
- data/spec/models/reject_spec.rb +34 -14
- data/spec/models/remove_from_conference_spec.rb +1 -1
- data/spec/models/remove_from_queue_notification_webhook_spec.rb +768 -0
- data/spec/models/request_type_spec.rb +1 -1
- data/spec/models/say_spec.rb +97 -23
- data/spec/models/send_digits_spec.rb +76 -20
- data/spec/models/set_dtmf_pass_through_spec.rb +34 -14
- data/spec/models/set_listen_spec.rb +34 -14
- data/spec/models/set_talk_spec.rb +34 -14
- data/spec/models/sms_spec.rb +97 -23
- data/spec/models/sms_ten_dlc_brand_alt_business_id_type_spec.rb +93 -0
- data/spec/models/sms_ten_dlc_brand_entity_type_spec.rb +109 -0
- data/spec/models/sms_ten_dlc_brand_identity_status_spec.rb +93 -0
- data/spec/models/sms_ten_dlc_brand_relationship_spec.rb +109 -0
- data/spec/models/sms_ten_dlc_brand_spec.rb +933 -378
- data/spec/models/sms_ten_dlc_brand_stock_exchange_spec.rb +461 -0
- data/spec/models/sms_ten_dlc_brands_list_result_spec.rb +181 -39
- data/spec/models/sms_ten_dlc_campaign_spec.rb +820 -164
- data/spec/models/sms_ten_dlc_campaign_status_spec.rb +61 -0
- data/spec/models/sms_ten_dlc_campaigns_list_result_spec.rb +181 -39
- data/spec/models/sms_ten_dlc_partner_campaign_brand_spec.rb +251 -51
- data/spec/models/sms_ten_dlc_partner_campaign_spec.rb +713 -183
- data/spec/models/sms_ten_dlc_partner_campaign_status_spec.rb +61 -0
- data/spec/models/sms_ten_dlc_partner_campaigns_list_result_spec.rb +181 -39
- data/spec/models/sms_toll_free_campaign_registration_status_spec.rb +109 -0
- data/spec/models/sms_toll_free_campaign_spec.rb +200 -69
- data/spec/models/sms_toll_free_campaigns_list_result_spec.rb +181 -39
- data/spec/models/start_record_call_spec.rb +1 -1
- data/spec/models/terminate_conference_spec.rb +1 -1
- data/spec/models/tfn_spec.rb +34 -14
- data/spec/models/transcribe_reason_spec.rb +109 -0
- data/spec/models/transcribe_term_reason_spec.rb +61 -0
- data/spec/models/{transcribe_utterance_all_of_record_spec.rb → transcribe_utterance_record_spec.rb} +99 -43
- data/spec/models/transcribe_utterance_spec.rb +155 -45
- data/spec/models/transcribe_webhook_spec.rb +1373 -0
- data/spec/models/unpark_spec.rb +1 -1
- data/spec/models/update_call_request_spec.rb +64 -32
- data/spec/models/update_call_request_status_spec.rb +1 -1
- data/spec/models/update_conference_participant_request_spec.rb +104 -17
- data/spec/models/update_conference_request_spec.rb +136 -56
- data/spec/models/update_conference_request_status_spec.rb +1 -1
- data/spec/models/webhook_spec.rb +176 -0
- data/spec/quickstart_spec.rb +7 -7
- data/spec/spec_helper.rb +1 -1
- data/spec/utils/request_verifier_spec.rb +123 -123
- data/spec/utils/signature_information_spec.rb +36 -36
- data/yarn.lock +91 -91
- metadata +157 -100
- data/docs/AccountResultAllOf.md +0 -30
- data/docs/AddToConferenceAllOf.md +0 -36
- data/docs/ApplicationListAllOf.md +0 -18
- data/docs/ApplicationResultAllOf.md +0 -34
- data/docs/AvailableNumberListAllOf.md +0 -18
- data/docs/CallListAllOf.md +0 -18
- data/docs/CallResultAllOf.md +0 -48
- data/docs/ConferenceListAllOf.md +0 -18
- data/docs/ConferenceParticipantListAllOf.md +0 -18
- data/docs/ConferenceParticipantResultAllOf.md +0 -30
- data/docs/ConferenceResultAllOf.md +0 -36
- data/docs/CreateConferenceAllOf.md +0 -28
- data/docs/EnqueueAllOf.md +0 -24
- data/docs/GetDigitsAllOf.md +0 -34
- data/docs/GetSpeechAllOf.md +0 -42
- data/docs/HangupAllOf.md +0 -18
- data/docs/IncomingNumberListAllOf.md +0 -18
- data/docs/IncomingNumberResultAllOf.md +0 -42
- data/docs/LogListAllOf.md +0 -18
- data/docs/MessageRequestAllOf.md +0 -26
- data/docs/MessageResultAllOf.md +0 -40
- data/docs/MessagesListAllOf.md +0 -18
- data/docs/OutDialAllOf.md +0 -36
- data/docs/ParkAllOf.md +0 -22
- data/docs/PauseAllOf.md +0 -18
- data/docs/PlayAllOf.md +0 -22
- data/docs/PlayEarlyMediaAllOf.md +0 -18
- data/docs/QueueListAllOf.md +0 -18
- data/docs/QueueMemberListAllOf.md +0 -18
- data/docs/QueueResultAllOf.md +0 -30
- data/docs/RecordUtteranceAllOf.md +0 -30
- data/docs/RecordingListAllOf.md +0 -18
- data/docs/RecordingResultAllOf.md +0 -26
- data/docs/RedirectAllOf.md +0 -18
- data/docs/RejectAllOf.md +0 -18
- data/docs/RemoveFromConferenceAllOf.md +0 -18
- data/docs/SMSTenDLCBrandsListResultAllOf.md +0 -18
- data/docs/SMSTenDLCCampaignsListResultAllOf.md +0 -18
- data/docs/SMSTenDLCPartnerCampaignsListResultAllOf.md +0 -18
- data/docs/SMSTollFreeCampaignsListResultAllOf.md +0 -18
- data/docs/SayAllOf.md +0 -24
- data/docs/SendDigitsAllOf.md +0 -22
- data/docs/SetDTMFPassThroughAllOf.md +0 -18
- data/docs/SetListenAllOf.md +0 -18
- data/docs/SetTalkAllOf.md +0 -18
- data/docs/SmsAllOf.md +0 -24
- data/docs/TerminateConferenceAllOf.md +0 -18
- data/docs/TranscribeUtteranceAllOf.md +0 -28
- data/docs/TranscribeUtteranceAllOfRecord.md +0 -22
- data/lib/freeclimb/models/account_result_all_of.rb +0 -289
- data/lib/freeclimb/models/add_to_conference_all_of.rb +0 -318
- data/lib/freeclimb/models/application_list_all_of.rb +0 -226
- data/lib/freeclimb/models/application_result_all_of.rb +0 -313
- data/lib/freeclimb/models/available_number_list_all_of.rb +0 -226
- data/lib/freeclimb/models/conference_list_all_of.rb +0 -226
- data/lib/freeclimb/models/conference_participant_list_all_of.rb +0 -226
- data/lib/freeclimb/models/create_conference_all_of.rb +0 -280
- data/lib/freeclimb/models/enqueue_all_of.rb +0 -266
- data/lib/freeclimb/models/get_digits_all_of.rb +0 -310
- data/lib/freeclimb/models/get_speech_all_of.rb +0 -354
- data/lib/freeclimb/models/hangup_all_of.rb +0 -224
- data/lib/freeclimb/models/incoming_number_list_all_of.rb +0 -226
- data/lib/freeclimb/models/log_list_all_of.rb +0 -226
- data/lib/freeclimb/models/message_request_all_of.rb +0 -279
- data/lib/freeclimb/models/messages_list_all_of.rb +0 -227
- data/lib/freeclimb/models/out_dial_all_of.rb +0 -329
- data/lib/freeclimb/models/park_all_of.rb +0 -252
- data/lib/freeclimb/models/pause_all_of.rb +0 -228
- data/lib/freeclimb/models/play_all_of.rb +0 -248
- data/lib/freeclimb/models/play_early_media_all_of.rb +0 -228
- data/lib/freeclimb/models/queue_list_all_of.rb +0 -226
- data/lib/freeclimb/models/queue_member_list_all_of.rb +0 -226
- data/lib/freeclimb/models/queue_result_all_of.rb +0 -291
- data/lib/freeclimb/models/record_utterance_all_of.rb +0 -288
- data/lib/freeclimb/models/recording_list_all_of.rb +0 -226
- data/lib/freeclimb/models/redirect_all_of.rb +0 -228
- data/lib/freeclimb/models/reject_all_of.rb +0 -224
- data/lib/freeclimb/models/say_all_of.rb +0 -260
- data/lib/freeclimb/models/send_digits_all_of.rb +0 -248
- data/lib/freeclimb/models/set_dtmf_pass_through_all_of.rb +0 -224
- data/lib/freeclimb/models/set_listen_all_of.rb +0 -224
- data/lib/freeclimb/models/set_talk_all_of.rb +0 -224
- data/lib/freeclimb/models/sms_all_of.rb +0 -266
- data/lib/freeclimb/models/sms_ten_dlc_brands_list_result_all_of.rb +0 -226
- data/lib/freeclimb/models/sms_ten_dlc_campaigns_list_result_all_of.rb +0 -226
- data/lib/freeclimb/models/sms_ten_dlc_partner_campaigns_list_result_all_of.rb +0 -226
- data/lib/freeclimb/models/sms_toll_free_campaigns_list_result_all_of.rb +0 -226
- data/lib/freeclimb/models/transcribe_utterance_all_of.rb +0 -281
data/openapi.json
CHANGED
@@ -22,7 +22,6 @@
|
|
22
22
|
"in": "path",
|
23
23
|
"description": "ID of the account",
|
24
24
|
"required": true,
|
25
|
-
"x-account-id": true,
|
26
25
|
"schema": {
|
27
26
|
"type": "string"
|
28
27
|
}
|
@@ -84,8 +83,6 @@
|
|
84
83
|
"AccountStatus": {
|
85
84
|
"type": "string",
|
86
85
|
"enum": ["closed", "suspended", "active"],
|
87
|
-
"x-enum-varnames": ["CLOSED", "SUSPENDED", "ACTIVE"],
|
88
|
-
"x-enum": true,
|
89
86
|
"description": "The status of this account. It is one of: active, suspended, or closed.",
|
90
87
|
"nullable": true
|
91
88
|
},
|
@@ -93,24 +90,18 @@
|
|
93
90
|
"type": "string",
|
94
91
|
"description": "The type of this account. It is one of: trial or full.",
|
95
92
|
"enum": ["trial", "full"],
|
96
|
-
"x-enum": true,
|
97
|
-
"x-enum-varnames": ["TRIAL", "FULL"],
|
98
93
|
"nullable": true
|
99
94
|
},
|
100
95
|
"AnsweredBy": {
|
101
96
|
"type": "string",
|
102
97
|
"nullable": true,
|
103
98
|
"enum": ["human", "machine"],
|
104
|
-
"x-enum-varnames": ["HUMAN", "MACHINE"],
|
105
|
-
"x-enum": true,
|
106
99
|
"description": "If this Call was initiated with answering machine detection, either `human` or `machine`. Empty otherwise."
|
107
100
|
},
|
108
101
|
"CallDirection": {
|
109
102
|
"type": "string",
|
110
103
|
"nullable": true,
|
111
104
|
"enum": ["inbound", "outboundAPI", "outboundDial"],
|
112
|
-
"x-enum-varnames": ["INBOUND", "OUTBOUND_API", "OUTBOUND_DIAL"],
|
113
|
-
"x-enum": true,
|
114
105
|
"description": "Direction of the Call. `inbound` for Calls into FreeClimb, `outboundAPI` for Calls initiated via the REST API, `outboundDial` for Calls initiated by the `OutDial` PerCL command."
|
115
106
|
},
|
116
107
|
"CallStatus": {
|
@@ -126,25 +117,52 @@
|
|
126
117
|
"busy",
|
127
118
|
"noAnswer"
|
128
119
|
],
|
129
|
-
"x-enum-varnames": [
|
130
|
-
"QUEUED",
|
131
|
-
"RINGING",
|
132
|
-
"IN_PROGRESS",
|
133
|
-
"CANCELED",
|
134
|
-
"COMPLETED",
|
135
|
-
"FAILED",
|
136
|
-
"BUSY",
|
137
|
-
"NO_ANSWER"
|
138
|
-
],
|
139
|
-
"x-enum": true,
|
140
120
|
"description": "* `queued` – Call is ready and waiting in line before going out. * `ringing` – Call is currently ringing. * `inProgress` – Call was answered and is currently in progress. * `canceled` – Call was hung up while it was queued or ringing. * `completed` – Call was answered and has ended normally. * `busy` – Caller received a busy signal. * `failed` – Call could not be completed as dialed, most likely because the phone number was non-existent. * `noAnswer` – Call ended without being answered."
|
141
121
|
},
|
122
|
+
"CallEndedReason": {
|
123
|
+
"type": "string",
|
124
|
+
"nullable": true,
|
125
|
+
"enum": [
|
126
|
+
"busy",
|
127
|
+
"failed",
|
128
|
+
"noAnswer",
|
129
|
+
"callCanceled",
|
130
|
+
"farEndHangup",
|
131
|
+
"appHangup",
|
132
|
+
"appReject",
|
133
|
+
"appNoPercl",
|
134
|
+
"appInvalidPercl",
|
135
|
+
"conferenceTerminated",
|
136
|
+
"conferenceEmptied",
|
137
|
+
"removedFromConference",
|
138
|
+
"machineDetected",
|
139
|
+
"webhookFailed",
|
140
|
+
"webhookInvalidResponse",
|
141
|
+
"voiceDisabled",
|
142
|
+
"configErrorNoApplication",
|
143
|
+
"configErrorNoVoiceUrl",
|
144
|
+
"maxRedirectsError",
|
145
|
+
"perclProcessingError",
|
146
|
+
"internalError",
|
147
|
+
"grpcHangup",
|
148
|
+
"maxDuration"
|
149
|
+
],
|
150
|
+
"description": "Enhanced status for the Call with additional information where available."
|
151
|
+
},
|
152
|
+
"GetDigitsReason": {
|
153
|
+
"type": "string",
|
154
|
+
"enum": [
|
155
|
+
"finishKey",
|
156
|
+
"timeout",
|
157
|
+
"maxDigits",
|
158
|
+
"tone"
|
159
|
+
],
|
160
|
+
"description": "This field explains how the GetDigits action ended. The value is one of the below: •finishKey - The finish key as specified had been pressed by the caller. Digit string has all keys up to, but not including, the finish key. •timeout - The timeout limit was reached prior to any other criteria being met. If any digits were collected, they will be included. •maxDigits - The maximum number of digits was reached and digit collection ended. •tone - Answering machine or fax tone detection occurred, interrupting digit collection. Any digits received up to this point are included in this webhook."
|
161
|
+
},
|
142
162
|
"ConferenceStatus": {
|
143
163
|
"type": "string",
|
144
164
|
"nullable": true,
|
145
165
|
"enum": ["empty", "populated", "inProgress", "terminated"],
|
146
|
-
"x-enum-varnames": ["EMPTY", "POPULATED", "IN_PROGRESS", "TERMINATED"],
|
147
|
-
"x-enum": true,
|
148
166
|
"description": "The status of the Conference. One of: creating, empty, populated, inProgress, or terminated."
|
149
167
|
},
|
150
168
|
"GetSpeechReason": {
|
@@ -156,16 +174,7 @@
|
|
156
174
|
"noInput",
|
157
175
|
"noMatch",
|
158
176
|
"recognition"
|
159
|
-
]
|
160
|
-
"x-enum-varnames": [
|
161
|
-
"ERROR",
|
162
|
-
"HANGUP",
|
163
|
-
"DIGIT",
|
164
|
-
"NO_INPUT",
|
165
|
-
"NO_MATCH",
|
166
|
-
"RECOGNITION"
|
167
|
-
],
|
168
|
-
"x-enum": true
|
177
|
+
]
|
169
178
|
},
|
170
179
|
"GrammarFileBuiltIn": {
|
171
180
|
"type": "string",
|
@@ -185,39 +194,17 @@
|
|
185
194
|
"DIG11",
|
186
195
|
"UP_TO_20_DIGIT_SEQUENCE",
|
187
196
|
"VERSAY_YESNO"
|
188
|
-
]
|
189
|
-
"x-enum-varnames": [
|
190
|
-
"ALPHNUM6",
|
191
|
-
"ANY_DIG",
|
192
|
-
"DIG1",
|
193
|
-
"DIG2",
|
194
|
-
"DIG3",
|
195
|
-
"DIG4",
|
196
|
-
"DIG5",
|
197
|
-
"DIG6",
|
198
|
-
"DIG7",
|
199
|
-
"DIG8",
|
200
|
-
"DIG9",
|
201
|
-
"DIG10",
|
202
|
-
"DIG11",
|
203
|
-
"UP_TO_20_DIGIT_SEQUENCE",
|
204
|
-
"VERSAY_YESNO"
|
205
|
-
],
|
206
|
-
"x-enum": true
|
197
|
+
]
|
207
198
|
},
|
208
199
|
"GrammarType": {
|
209
200
|
"type": "string",
|
210
201
|
"enum": ["URL", "BUILTIN"],
|
211
202
|
"nullable": true,
|
212
|
-
"x-enum-varnames": ["URL", "BUILT_IN"],
|
213
|
-
"x-enum": true,
|
214
203
|
"description": "The grammar file type to use for speech recognition. A value of 'URL' indicates the grammarFile attribute specifies a URL that points to the grammar file. A value of `BUILTIN` indicates the grammarFile attribute specifies the name of one of the platform built-in grammar files."
|
215
204
|
},
|
216
205
|
"IfMachine": {
|
217
206
|
"type": "string",
|
218
207
|
"enum": ["redirect", "hangup"],
|
219
|
-
"x-enum-varnames": ["REDIRECT", "HANGUP"],
|
220
|
-
"x-enum": true,
|
221
208
|
"description": "Specifies how FreeClimb should handle this OutDial if an answering machine answers the Call. Valid values: `redirect` invokes the ifMachineUrl for instructions. `hangup` hangs up the Call. The ifMachineUrl will not be invoked."
|
222
209
|
},
|
223
210
|
"Language": {
|
@@ -249,56 +236,21 @@
|
|
249
236
|
"zh-CN",
|
250
237
|
"zh-HK",
|
251
238
|
"zh-TW"
|
252
|
-
]
|
253
|
-
"x-enum-varnames": [
|
254
|
-
"CATALAN",
|
255
|
-
"DANISH",
|
256
|
-
"GERMAN",
|
257
|
-
"ENGLISH_AU",
|
258
|
-
"ENGLISH_CA",
|
259
|
-
"ENGLISH_UK",
|
260
|
-
"ENGLISH_IN",
|
261
|
-
"ENGLISH_US",
|
262
|
-
"ENGLISH_ES",
|
263
|
-
"ENGLISH_MX",
|
264
|
-
"FINNISH",
|
265
|
-
"FRENCH_CA",
|
266
|
-
"FRENCH_FR",
|
267
|
-
"ITALIAN",
|
268
|
-
"JAPANESE",
|
269
|
-
"KOREAN",
|
270
|
-
"NORWEGIAN",
|
271
|
-
"DUTCH",
|
272
|
-
"POLISH",
|
273
|
-
"PORTUGESE_BR",
|
274
|
-
"PORTUGESE_PT",
|
275
|
-
"RUSSIAN",
|
276
|
-
"SWEDISH",
|
277
|
-
"CHINESE_CN",
|
278
|
-
"CHINESE_HK",
|
279
|
-
"CHINESE_TW"
|
280
|
-
],
|
281
|
-
"x-enum": true
|
239
|
+
]
|
282
240
|
},
|
283
241
|
"LogLevel": {
|
284
242
|
"type": "string",
|
285
243
|
"enum": ["info", "warning", "error"],
|
286
244
|
"nullable": true,
|
287
|
-
"x-enum-varnames": ["INFO", "WARNING", "ERROR"],
|
288
|
-
"x-enum": true,
|
289
245
|
"description": "Level of the log. Possible values are info, warning, and error."
|
290
246
|
},
|
291
247
|
"MachineType": {
|
292
248
|
"type": "string",
|
293
|
-
"enum": ["
|
294
|
-
"x-enum-varnames": ["ANSWERING_MACHINE", "FAX_MACHINE"],
|
295
|
-
"x-enum": true
|
249
|
+
"enum": ["answering machine", "fax modem"]
|
296
250
|
},
|
297
251
|
"MessageDirection": {
|
298
252
|
"type": "string",
|
299
|
-
"enum": ["inbound", "outbound"]
|
300
|
-
"x-enum-varnames": ["INBOUND", "OUTBOUND"],
|
301
|
-
"x-enum": true
|
253
|
+
"enum": ["inbound", "outbound"]
|
302
254
|
},
|
303
255
|
"MessageStatus": {
|
304
256
|
"type": "string",
|
@@ -316,43 +268,33 @@
|
|
316
268
|
"expired",
|
317
269
|
"deleted",
|
318
270
|
"unknown"
|
319
|
-
]
|
320
|
-
"x-enum-varnames": [
|
321
|
-
"NEW",
|
322
|
-
"QUEUED",
|
323
|
-
"REJECTED",
|
324
|
-
"SENDING",
|
325
|
-
"SENT",
|
326
|
-
"FAILED",
|
327
|
-
"RECEIVED",
|
328
|
-
"UNDELIVERED",
|
329
|
-
"EXPIRED",
|
330
|
-
"DELETED",
|
331
|
-
"UNKNOWN"
|
332
|
-
],
|
333
|
-
"x-enum": true
|
271
|
+
]
|
334
272
|
},
|
335
273
|
"PlayBeep": {
|
336
274
|
"type": "string",
|
337
275
|
"nullable": true,
|
338
276
|
"enum": ["always", "never", "entryOnly", "exitOnly"],
|
339
|
-
"
|
340
|
-
"x-enum": true,
|
341
|
-
"description": "Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` ",
|
342
|
-
"default": "always",
|
343
|
-
"x-enum-default-attr": "ALWAYS"
|
277
|
+
"description": "Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always` "
|
344
278
|
},
|
345
279
|
"QueueResultStatus": {
|
346
280
|
"type": "string",
|
347
|
-
"enum": ["queueFull", "dequeued", "hangup", "systemError"]
|
348
|
-
"x-enum-varnames": ["QUEUE_FULL", "DEQUEUED", "HANGUP", "SYSTEM_ERROR"],
|
349
|
-
"x-enum": true
|
281
|
+
"enum": ["queueFull", "dequeued", "hangup", "systemError"]
|
350
282
|
},
|
351
283
|
"RecordUtteranceTermReason": {
|
352
284
|
"type": "string",
|
353
|
-
"enum": ["finishKey", "timeout", "hangup", "maxLength"]
|
354
|
-
|
355
|
-
|
285
|
+
"enum": ["finishKey", "timeout", "hangup", "maxLength"]
|
286
|
+
},
|
287
|
+
"BargeInReason": {
|
288
|
+
"type": "string",
|
289
|
+
"enum": ["noBargeIn", "bargeInByDTMF", "bargeInByEnergy"]
|
290
|
+
},
|
291
|
+
"TranscribeTermReason": {
|
292
|
+
"type": "string",
|
293
|
+
"enum": ["error", "completed"]
|
294
|
+
},
|
295
|
+
"TranscribeReason": {
|
296
|
+
"type": "string",
|
297
|
+
"enum": ["internalError", "hangup", "maxLength", "digit", "noInput"]
|
356
298
|
},
|
357
299
|
"RequestType": {
|
358
300
|
"type": "string",
|
@@ -380,120 +322,1590 @@
|
|
380
322
|
"conferenceCallControl",
|
381
323
|
"messageDelivery",
|
382
324
|
"messageStatus"
|
383
|
-
]
|
384
|
-
"x-enum-varnames": [
|
385
|
-
"INBOUND_CALL",
|
386
|
-
"RECORD",
|
387
|
-
"GET_DIGITS",
|
388
|
-
"GET_SPEECH",
|
389
|
-
"REDIRECT",
|
390
|
-
"PAUSE",
|
391
|
-
"OUT_DIAL_START",
|
392
|
-
"OUT_DIAL_CONNECT",
|
393
|
-
"OUT_DIAL_API_CONNECT",
|
394
|
-
"MACHINE_DETECTED",
|
395
|
-
"DEQUEUE",
|
396
|
-
"QUEUE_WAIT",
|
397
|
-
"ADD_TO_QUEUE_NOTIFICATION",
|
398
|
-
"REMOVE_FROM_QUEUE_NOTIFICATION",
|
399
|
-
"CALL_STATUS",
|
400
|
-
"CREATE_CONFERENCE",
|
401
|
-
"CONFERENCE_STATUS",
|
402
|
-
"LEAVE_CONFERENCE",
|
403
|
-
"ADD_TO_CONFERENCE_NOTIFICATION",
|
404
|
-
"CONFERENCE_RECORDING_STATUS",
|
405
|
-
"CONFERENCE_CALL_CONTROL",
|
406
|
-
"MESSAGE_DELIVERY",
|
407
|
-
"MESSAGE_STATUS"
|
408
|
-
],
|
409
|
-
"x-enum": true
|
325
|
+
]
|
410
326
|
},
|
411
327
|
"UpdateCallRequestStatus": {
|
412
328
|
"type": "string",
|
413
329
|
"enum": ["canceled", "completed"],
|
414
|
-
"x-enum-varnames": ["CANCELED", "COMPLETED"],
|
415
|
-
"x-enum": true,
|
416
330
|
"description": "Either `canceled` or `completed`. Specifying `canceled` attempts to hang up calls that are queued without affecting calls already in progress. Specifying `completed` attempts to hang up a call already in progress."
|
417
331
|
},
|
418
332
|
"UpdateConferenceRequestStatus": {
|
419
333
|
"type": "string",
|
420
334
|
"enum": ["empty", "terminated"],
|
421
|
-
"x-enum-varnames": ["EMPTY", "TERMINATED"],
|
422
|
-
"x-enum": true,
|
423
335
|
"description": "New status of the conference. Valid values: `empty` or `terminated`. For more information, see **Status Parameter** below.**"
|
424
336
|
},
|
337
|
+
"SMSTollFreeCampaignRegistrationStatus": {
|
338
|
+
"type": "string",
|
339
|
+
"description": "Current toll-free campaign registration status.Possible values: UNREGISTERED,INITIATED,PENDING,DECLINED,REGISTERED. A newly created campaign defaults to INITIATED status. ",
|
340
|
+
"enum": [
|
341
|
+
"UNREGISTERED",
|
342
|
+
"INITIATED",
|
343
|
+
"PENDING",
|
344
|
+
"DECLINED",
|
345
|
+
"REGISTERED"
|
346
|
+
]
|
347
|
+
},
|
348
|
+
"SMSTenDLCCampaignStatus": {
|
349
|
+
"type": "string",
|
350
|
+
"description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
|
351
|
+
"enum": ["ACTIVE", "EXPIRED"]
|
352
|
+
},
|
353
|
+
"SMSTenDLCPartnerCampaignStatus": {
|
354
|
+
"type": "string",
|
355
|
+
"description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
|
356
|
+
"enum": ["ACTIVE", "EXPIRED"]
|
357
|
+
},
|
358
|
+
"SMSTenDLCBrandEntityType": {
|
359
|
+
"maxLength": 20,
|
360
|
+
"type": "string",
|
361
|
+
"description": "Entity type behind the brand. This is the form of business establishment.",
|
362
|
+
"enum": [
|
363
|
+
"PRIVATE_PROFIT",
|
364
|
+
"PUBLIC_PROFIT",
|
365
|
+
"NON_PROFIT",
|
366
|
+
"GOVERNMENT",
|
367
|
+
"SOLE_PROPRIETOR"
|
368
|
+
]
|
369
|
+
},
|
370
|
+
"SMSTenDLCBrandRelationship": {
|
371
|
+
"type": "string",
|
372
|
+
"description": "Brand relationship to the CSP",
|
373
|
+
"enum": [
|
374
|
+
"BASIC_ACCOUNT",
|
375
|
+
"SMALL_ACCOUNT",
|
376
|
+
"MEDIUM_ACCOUNT",
|
377
|
+
"LARGE_ACCOUNT",
|
378
|
+
"KEY_ACCOUNT"
|
379
|
+
]
|
380
|
+
},
|
381
|
+
"SMSTenDLCBrandStockExchange": {
|
382
|
+
"type": "string",
|
383
|
+
"description": "(Required for public company) stock exchange.",
|
384
|
+
"example": "NASDAQ",
|
385
|
+
"enum": [
|
386
|
+
"NONE",
|
387
|
+
"NASDAQ",
|
388
|
+
"NYSE",
|
389
|
+
"AMEX",
|
390
|
+
"AMX",
|
391
|
+
"ASX",
|
392
|
+
"B3",
|
393
|
+
"BME",
|
394
|
+
"BSE",
|
395
|
+
"FRA",
|
396
|
+
"ICEX",
|
397
|
+
"JPX",
|
398
|
+
"JSE",
|
399
|
+
"KRX",
|
400
|
+
"LON",
|
401
|
+
"NSE",
|
402
|
+
"OMX",
|
403
|
+
"SEHK",
|
404
|
+
"SGX",
|
405
|
+
"SSE",
|
406
|
+
"STO",
|
407
|
+
"SWX",
|
408
|
+
"SZSE",
|
409
|
+
"TSX",
|
410
|
+
"TWSE",
|
411
|
+
"VSE",
|
412
|
+
"OTHER"
|
413
|
+
]
|
414
|
+
},
|
415
|
+
"SMSTenDLCBrandAltBusinessIdType": {
|
416
|
+
"type": "string",
|
417
|
+
"enum": ["NONE", "DUNS", "GIIN", "LEI"],
|
418
|
+
"description": "The type of the Alternative business identifier"
|
419
|
+
},
|
420
|
+
"SMSTenDLCBrandIdentityStatus": {
|
421
|
+
"type": "string",
|
422
|
+
"description": "TCR assessment of the brand identification status.",
|
423
|
+
"enum": [
|
424
|
+
"SELF_DECLARED",
|
425
|
+
"UNVERIFIED",
|
426
|
+
"VERIFIED",
|
427
|
+
"VETTED_VERIFIED"
|
428
|
+
]
|
429
|
+
},
|
430
|
+
"CompletionResultStatus": {
|
431
|
+
"type": "string",
|
432
|
+
"description": "Completion result status. Possible values: success, no_context",
|
433
|
+
"enum": ["success", "no_context"]
|
434
|
+
},
|
435
|
+
"SMSTenDLCOptionalAttributes": {
|
436
|
+
"type": "object",
|
437
|
+
"description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names.",
|
438
|
+
"additionalProperties": true
|
439
|
+
},
|
425
440
|
"PerclScript": {
|
426
441
|
"type": "object",
|
427
442
|
"description": "A PerCL script to be returned to the FreeClimb servers in FreeClimb applications",
|
428
|
-
"x-percl-script": true,
|
429
443
|
"properties": {
|
430
444
|
"commands": {
|
431
445
|
"type": "array",
|
432
446
|
"description": "A JSON array of PerCL commands",
|
433
|
-
"x-is-list": true,
|
434
447
|
"items": {
|
435
448
|
"$ref": "#/components/schemas/PerclCommand"
|
436
449
|
}
|
437
450
|
}
|
438
|
-
}
|
451
|
+
}
|
452
|
+
},
|
453
|
+
"PerclCommand": {
|
454
|
+
"type": "object",
|
455
|
+
"description": "An individual command used in a PerCLScript.",
|
456
|
+
"discriminator": {
|
457
|
+
"propertyName": "command",
|
458
|
+
"mapping": {
|
459
|
+
"AddToConference": "#/components/schemas/AddToConference",
|
460
|
+
"CreateConference": "#/components/schemas/CreateConference",
|
461
|
+
"Dequeue": "#/components/schemas/Dequeue",
|
462
|
+
"Enqueue": "#/components/schemas/Enqueue",
|
463
|
+
"GetDigits": "#/components/schemas/GetDigits",
|
464
|
+
"GetSpeech": "#/components/schemas/GetSpeech",
|
465
|
+
"Hangup": "#/components/schemas/Hangup",
|
466
|
+
"OutDial": "#/components/schemas/OutDial",
|
467
|
+
"Pause": "#/components/schemas/Pause",
|
468
|
+
"Park": "#/components/schemas/Park",
|
469
|
+
"Play": "#/components/schemas/Play",
|
470
|
+
"PlayEarlyMedia": "#/components/schemas/PlayEarlyMedia",
|
471
|
+
"RecordUtterance": "#/components/schemas/RecordUtterance",
|
472
|
+
"Redirect": "#/components/schemas/Redirect",
|
473
|
+
"Reject": "#/components/schemas/Reject",
|
474
|
+
"RemoveFromConference": "#/components/schemas/RemoveFromConference",
|
475
|
+
"Say": "#/components/schemas/Say",
|
476
|
+
"SendDigits": "#/components/schemas/SendDigits",
|
477
|
+
"SetListen": "#/components/schemas/SetListen",
|
478
|
+
"SetTalk": "#/components/schemas/SetTalk",
|
479
|
+
"SetDTMFPassThrough": "#/components/schemas/SetDTMFPassThrough",
|
480
|
+
"Sms": "#/components/schemas/Sms",
|
481
|
+
"StartRecordCall": "#/components/schemas/StartRecordCall",
|
482
|
+
"TerminateConference": "#/components/schemas/TerminateConference",
|
483
|
+
"TranscribeUtterance": "#/components/schemas/TranscribeUtterance",
|
484
|
+
"Unpark": "#/components/schemas/Unpark"
|
485
|
+
}
|
486
|
+
},
|
487
|
+
"properties": {
|
488
|
+
"command": {
|
489
|
+
"type": "string",
|
490
|
+
"description": "Name of PerCL Command (this is automatically derived from mapping configuration and should not be manually supplied in any arguments)"
|
491
|
+
}
|
492
|
+
}
|
493
|
+
},
|
494
|
+
"Webhook": {
|
495
|
+
"type": "object",
|
496
|
+
"discriminator": {
|
497
|
+
"propertyName": "requestType",
|
498
|
+
"mapping": {
|
499
|
+
"addToConferenceNotification": "#/components/schemas/AddToConferenceNotificationWebhook",
|
500
|
+
"addToQueueNotification": "#/components/schemas/AddToQueueNotificationWebhook",
|
501
|
+
"callControl": "#/components/schemas/CallControlWebhook",
|
502
|
+
"callStatus": "#/components/schemas/CallStatusWebhook",
|
503
|
+
"conferenceRecordingStatus": "#/components/schemas/ConferenceRecordingStatusWebhook",
|
504
|
+
"conferenceStatus": "#/components/schemas/ConferenceStatusWebhook",
|
505
|
+
"createConference": "#/components/schemas/CreateConferenceWebhook",
|
506
|
+
"dequeue": "#/components/schemas/DequeueWebhook",
|
507
|
+
"getDigits": "#/components/schemas/GetDigitsWebhook",
|
508
|
+
"getSpeech": "#/components/schemas/GetSpeechWebhook",
|
509
|
+
"inboundCall": "#/components/schemas/InboundCallWebhook",
|
510
|
+
"leaveConference": "#/components/schemas/LeaveConferenceWebhook",
|
511
|
+
"machineDetected": "#/components/schemas/MachineDetectedWebhook",
|
512
|
+
"messageDelivery": "#/components/schemas/MessageDeliveryWebhook",
|
513
|
+
"messageStatus": "#/components/schemas/MessageStatusWebhook",
|
514
|
+
"outDialApiConnect": "#/components/schemas/OutDialApiConnectWebhook",
|
515
|
+
"outDialConnect": "#/components/schemas/OutDialConnectWebhook",
|
516
|
+
"outDialStart": "#/components/schemas/OutDialStartWebhook",
|
517
|
+
"queueWait": "#/components/schemas/QueueWaitWebhook",
|
518
|
+
"record": "#/components/schemas/RecordWebhook",
|
519
|
+
"redirect": "#/components/schemas/RedirectWebhook",
|
520
|
+
"removeFromQueueNotification": "#/components/schemas/RemoveFromQueueNotificationWebhook",
|
521
|
+
"transcribe": "#/components/schemas/TranscribeWebhook"
|
522
|
+
}
|
523
|
+
},
|
524
|
+
"properties": {
|
525
|
+
"requestType": {
|
526
|
+
"type": "string",
|
527
|
+
"description": "Type of webhook request"
|
528
|
+
}
|
529
|
+
}
|
530
|
+
},
|
531
|
+
"AddToConferenceNotificationWebhook": {
|
532
|
+
"description": "A Call has been bridged to a Conference and the AddToConference command’s notificationUrl is being invoked. This is a notification only; any PerCL returned will be ignored.",
|
533
|
+
"allOf": [
|
534
|
+
{
|
535
|
+
"$ref": "#/components/schemas/Webhook"
|
536
|
+
},
|
537
|
+
{
|
538
|
+
"type": "object",
|
539
|
+
"properties": {
|
540
|
+
"requestType": {
|
541
|
+
"type": "string",
|
542
|
+
"description": "Context or reason why this request is being made. Will be addToConferenceNotification - A Call has been bridged to a conference and the addToConference command’s notificationUrl is being invoked."
|
543
|
+
},
|
544
|
+
"callId": {
|
545
|
+
"type": "string",
|
546
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
547
|
+
},
|
548
|
+
"accountId": {
|
549
|
+
"type": "string",
|
550
|
+
"description": "Account ID associated with your account."
|
551
|
+
},
|
552
|
+
"from": {
|
553
|
+
"type": "string",
|
554
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
555
|
+
},
|
556
|
+
"to": {
|
557
|
+
"type": "string",
|
558
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
559
|
+
},
|
560
|
+
"callStatus": {
|
561
|
+
"$ref": "#/components/schemas/CallStatus"
|
562
|
+
},
|
563
|
+
"direction": {
|
564
|
+
"$ref": "#/components/schemas/CallDirection"
|
565
|
+
},
|
566
|
+
"conferenceId": {
|
567
|
+
"type": "string",
|
568
|
+
"description": "Unique ID of the Conference."
|
569
|
+
},
|
570
|
+
"queueId": {
|
571
|
+
"type": "string",
|
572
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
573
|
+
"nullable": true
|
574
|
+
},
|
575
|
+
"status": {
|
576
|
+
"$ref": "#/components/schemas/ConferenceStatus"
|
577
|
+
},
|
578
|
+
"recordingUrl": {
|
579
|
+
"type": "string",
|
580
|
+
"description": "URL of the Conference’s recorded audio. Populated only if a Recording exists and the Conference was emptied.",
|
581
|
+
"format": "uri"
|
582
|
+
},
|
583
|
+
"recordingId": {
|
584
|
+
"type": "string",
|
585
|
+
"description": "Unique ID of the Recording from this Conference. Populated only if a recording exists and the Conference was emptied."
|
586
|
+
},
|
587
|
+
"recordingDurationSec": {
|
588
|
+
"type": "integer",
|
589
|
+
"description": "Duration of the recorded audio (in seconds), rounded up to the nearest second. Populated only if a Recording exists and the Conference was emptied."
|
590
|
+
}
|
591
|
+
}
|
592
|
+
}
|
593
|
+
]
|
594
|
+
},
|
595
|
+
"AddToQueueNotificationWebhook": {
|
596
|
+
"description": "A Call has been added to a Queue and the Enqueue command’s notificationUrl is being invoked. This is a notification only; any PerCL returned will be ignored.",
|
597
|
+
"allOf": [
|
598
|
+
{
|
599
|
+
"$ref": "#/components/schemas/Webhook"
|
600
|
+
},
|
601
|
+
{
|
602
|
+
"type": "object",
|
603
|
+
"properties": {
|
604
|
+
"requestType": {
|
605
|
+
"type": "string",
|
606
|
+
"description": "Context or reason why this request is being made. Will be addToQueueNotification - A call has been added to a queue and the Enqueue command’s notificationUrl is being invoked."
|
607
|
+
},
|
608
|
+
"callId": {
|
609
|
+
"type": "string",
|
610
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
611
|
+
},
|
612
|
+
"accountId": {
|
613
|
+
"type": "string",
|
614
|
+
"description": "Account ID associated with your account."
|
615
|
+
},
|
616
|
+
"from": {
|
617
|
+
"type": "string",
|
618
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
619
|
+
},
|
620
|
+
"to": {
|
621
|
+
"type": "string",
|
622
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
623
|
+
},
|
624
|
+
"callStatus": {
|
625
|
+
"$ref": "#/components/schemas/CallStatus"
|
626
|
+
},
|
627
|
+
"direction": {
|
628
|
+
"$ref": "#/components/schemas/CallDirection"
|
629
|
+
},
|
630
|
+
"conferenceId": {
|
631
|
+
"type": "string",
|
632
|
+
"description": "Unique ID of the Conference."
|
633
|
+
},
|
634
|
+
"queueId": {
|
635
|
+
"type": "string",
|
636
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
637
|
+
"nullable": true
|
638
|
+
}
|
639
|
+
}
|
640
|
+
}
|
641
|
+
]
|
642
|
+
},
|
643
|
+
"CallControlWebhook": {
|
644
|
+
"description": "The digit sequence defined in the callControlSequence attribute of the AddToConference PerCL command has been entered by the Conference participant. A PerCL response is expected. If invalid PerCL is provided, the call leg which triggered this webhook will terminate.",
|
645
|
+
"allOf": [
|
646
|
+
{
|
647
|
+
"$ref": "#/components/schemas/Webhook"
|
648
|
+
},
|
649
|
+
{
|
650
|
+
"type": "object",
|
651
|
+
"properties": {
|
652
|
+
"requestType": {
|
653
|
+
"type": "string",
|
654
|
+
"description": "Context or reason why this request is being made. Will be callControl."
|
655
|
+
},
|
656
|
+
"callId": {
|
657
|
+
"type": "string",
|
658
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
659
|
+
},
|
660
|
+
"accountId": {
|
661
|
+
"type": "string",
|
662
|
+
"description": "Account ID associated with your account."
|
663
|
+
},
|
664
|
+
"conferenceId": {
|
665
|
+
"type": "string",
|
666
|
+
"description": "Unique ID of the Conference."
|
667
|
+
},
|
668
|
+
"digits": {
|
669
|
+
"type": "string",
|
670
|
+
"description": "String of digits entered by the participant."
|
671
|
+
}
|
672
|
+
}
|
673
|
+
}
|
674
|
+
]
|
675
|
+
},
|
676
|
+
"CallStatusWebhook": {
|
677
|
+
"description": "A Call has ended and the statusCallbackUrl is being invoked. This is a notification only; All PerCL commands will be ignored.",
|
678
|
+
"allOf": [
|
679
|
+
{
|
680
|
+
"$ref": "#/components/schemas/Webhook"
|
681
|
+
},
|
682
|
+
{
|
683
|
+
"type": "object",
|
684
|
+
"properties": {
|
685
|
+
"requestType": {
|
686
|
+
"type": "string",
|
687
|
+
"description": "Context or reason why this request is being made. Will be callStatus - A Call has ended and the statusCallbackUrl is being invoked."
|
688
|
+
},
|
689
|
+
"callId": {
|
690
|
+
"type": "string",
|
691
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
692
|
+
},
|
693
|
+
"accountId": {
|
694
|
+
"type": "string",
|
695
|
+
"description": "Account ID associated with your account."
|
696
|
+
},
|
697
|
+
"from": {
|
698
|
+
"type": "string",
|
699
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
700
|
+
},
|
701
|
+
"to": {
|
702
|
+
"type": "string",
|
703
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
704
|
+
},
|
705
|
+
"callStatus": {
|
706
|
+
"$ref": "#/components/schemas/CallStatus"
|
707
|
+
},
|
708
|
+
"callEndedReason": {
|
709
|
+
"$ref": "#/components/schemas/CallEndedReason"
|
710
|
+
},
|
711
|
+
"direction": {
|
712
|
+
"$ref": "#/components/schemas/CallDirection"
|
713
|
+
},
|
714
|
+
"conferenceId": {
|
715
|
+
"type": "string",
|
716
|
+
"description": "Unique ID of the Conference."
|
717
|
+
},
|
718
|
+
"queueId": {
|
719
|
+
"type": "string",
|
720
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
721
|
+
"nullable": true
|
722
|
+
}
|
723
|
+
}
|
724
|
+
}
|
725
|
+
]
|
726
|
+
},
|
727
|
+
"ConferenceRecordingStatusWebhook": {
|
728
|
+
"description": "The statusCallbackUrl request includes Recording information for a Conference that ended. This is a notification only; any PerCL returned will be ignored.",
|
729
|
+
"allOf": [
|
730
|
+
{
|
731
|
+
"$ref": "#/components/schemas/Webhook"
|
732
|
+
},
|
733
|
+
{
|
734
|
+
"type": "object",
|
735
|
+
"properties": {
|
736
|
+
"requestType": {
|
737
|
+
"type": "string",
|
738
|
+
"description": "Context or reason why this request is being made. Will be conferenceRecordingStatus - The statusCallbackUrl request includes Recording information for a Conference that ended."
|
739
|
+
},
|
740
|
+
"callId": {
|
741
|
+
"type": "string",
|
742
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
743
|
+
},
|
744
|
+
"accountId": {
|
745
|
+
"type": "string",
|
746
|
+
"description": "Account ID associated with your account."
|
747
|
+
},
|
748
|
+
"from": {
|
749
|
+
"type": "string",
|
750
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
751
|
+
},
|
752
|
+
"to": {
|
753
|
+
"type": "string",
|
754
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
755
|
+
},
|
756
|
+
"callStatus": {
|
757
|
+
"$ref": "#/components/schemas/CallStatus"
|
758
|
+
},
|
759
|
+
"direction": {
|
760
|
+
"$ref": "#/components/schemas/CallDirection"
|
761
|
+
},
|
762
|
+
"conferenceId": {
|
763
|
+
"type": "string",
|
764
|
+
"description": "Unique ID of the Conference."
|
765
|
+
},
|
766
|
+
"queueId": {
|
767
|
+
"type": "string",
|
768
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
769
|
+
"nullable": true
|
770
|
+
},
|
771
|
+
"status": {
|
772
|
+
"$ref": "#/components/schemas/ConferenceStatus"
|
773
|
+
},
|
774
|
+
"recordingUrl": {
|
775
|
+
"type": "string",
|
776
|
+
"description": "URL of the Conference’s recorded audio. Populated only if a Recording exists and the Conference was emptied.",
|
777
|
+
"format": "uri"
|
778
|
+
},
|
779
|
+
"recordingId": {
|
780
|
+
"type": "string",
|
781
|
+
"description": "Unique ID of the Recording from this Conference. Populated only if a recording exists and the Conference was emptied."
|
782
|
+
},
|
783
|
+
"recordingDurationSec": {
|
784
|
+
"type": "integer",
|
785
|
+
"description": "Duration of the recorded audio (in seconds), rounded up to the nearest second. Populated only if a Recording exists and the Conference was emptied."
|
786
|
+
}
|
787
|
+
}
|
788
|
+
}
|
789
|
+
]
|
790
|
+
},
|
791
|
+
"ConferenceStatusWebhook": {
|
792
|
+
"description": "The context or reason why this request is being made. Will be conferenceStatus - A Conference's status changed and its statusCallbackUrl is being invoked.",
|
793
|
+
"allOf": [
|
794
|
+
{
|
795
|
+
"$ref": "#/components/schemas/Webhook"
|
796
|
+
},
|
797
|
+
{
|
798
|
+
"type": "object",
|
799
|
+
"properties": {
|
800
|
+
"requestType": {
|
801
|
+
"type": "string",
|
802
|
+
"description": "Context or reason why this request is being made. Will be conferenceRecordingStatus - The statusCallbackUrl request includes Recording information for a Conference that ended."
|
803
|
+
},
|
804
|
+
"callId": {
|
805
|
+
"type": "string",
|
806
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
807
|
+
},
|
808
|
+
"accountId": {
|
809
|
+
"type": "string",
|
810
|
+
"description": "Account ID associated with your account."
|
811
|
+
},
|
812
|
+
"from": {
|
813
|
+
"type": "string",
|
814
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
815
|
+
},
|
816
|
+
"to": {
|
817
|
+
"type": "string",
|
818
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
819
|
+
},
|
820
|
+
"callStatus": {
|
821
|
+
"$ref": "#/components/schemas/CallStatus"
|
822
|
+
},
|
823
|
+
"direction": {
|
824
|
+
"$ref": "#/components/schemas/CallDirection"
|
825
|
+
},
|
826
|
+
"conferenceId": {
|
827
|
+
"type": "string",
|
828
|
+
"description": "Unique ID of the Conference."
|
829
|
+
},
|
830
|
+
"queueId": {
|
831
|
+
"type": "string",
|
832
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
833
|
+
"nullable": true
|
834
|
+
},
|
835
|
+
"status": {
|
836
|
+
"$ref": "#/components/schemas/ConferenceStatus"
|
837
|
+
},
|
838
|
+
"recordingUrl": {
|
839
|
+
"type": "string",
|
840
|
+
"description": "The URL of the Conference’s recorded audio. Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked.",
|
841
|
+
"format": "uri",
|
842
|
+
"nullable": true
|
843
|
+
},
|
844
|
+
"recordingId": {
|
845
|
+
"type": "string",
|
846
|
+
"description": "The unique ID of the Recording from this Conference. Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked.",
|
847
|
+
"nullable": true
|
848
|
+
},
|
849
|
+
"recordingDurationSec": {
|
850
|
+
"type": "integer",
|
851
|
+
"description": "The duration of the recorded audio rounded up to the nearest second (in seconds). Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked.",
|
852
|
+
"nullable": true
|
853
|
+
}
|
854
|
+
}
|
855
|
+
}
|
856
|
+
]
|
857
|
+
},
|
858
|
+
"CreateConferenceWebhook": {
|
859
|
+
"description": "A Conference has been created and its statusCallbackUrl or actionUrl is being invoked. A PerCL response is expected if the actionUrl is being invoked.",
|
860
|
+
"allOf": [
|
861
|
+
{
|
862
|
+
"$ref": "#/components/schemas/Webhook"
|
863
|
+
},
|
864
|
+
{
|
865
|
+
"type": "object",
|
866
|
+
"properties": {
|
867
|
+
"requestType": {
|
868
|
+
"type": "string",
|
869
|
+
"description": "Context or reason why this request is being made. Will be createConference - A Conference has been created and its statusCallbackUrl or actionUrl is being invoked."
|
870
|
+
},
|
871
|
+
"callId": {
|
872
|
+
"type": "string",
|
873
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
874
|
+
},
|
875
|
+
"accountId": {
|
876
|
+
"type": "string",
|
877
|
+
"description": "Account ID associated with your account."
|
878
|
+
},
|
879
|
+
"from": {
|
880
|
+
"type": "string",
|
881
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
882
|
+
},
|
883
|
+
"to": {
|
884
|
+
"type": "string",
|
885
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
886
|
+
},
|
887
|
+
"callStatus": {
|
888
|
+
"$ref": "#/components/schemas/CallStatus"
|
889
|
+
},
|
890
|
+
"direction": {
|
891
|
+
"$ref": "#/components/schemas/CallDirection"
|
892
|
+
},
|
893
|
+
"conferenceId": {
|
894
|
+
"type": "string",
|
895
|
+
"description": "Unique ID of the Conference."
|
896
|
+
},
|
897
|
+
"queueId": {
|
898
|
+
"type": "string",
|
899
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
900
|
+
"nullable": true
|
901
|
+
},
|
902
|
+
"status": {
|
903
|
+
"$ref": "#/components/schemas/ConferenceStatus"
|
904
|
+
},
|
905
|
+
"recordingUrl": {
|
906
|
+
"type": "string",
|
907
|
+
"description": "The URL of the Conference’s recorded audio. Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked.",
|
908
|
+
"format": "uri",
|
909
|
+
"nullable": true
|
910
|
+
},
|
911
|
+
"recordingId": {
|
912
|
+
"type": "string",
|
913
|
+
"description": "The unique ID of the Recording from this Conference. Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked.",
|
914
|
+
"nullable": true
|
915
|
+
},
|
916
|
+
"recordingDurationSec": {
|
917
|
+
"type": "integer",
|
918
|
+
"description": "The duration of the recorded audio rounded up to the nearest second (in seconds). Populated only if a Recording exists and the Conference was emptied. Present only if statusCallbackUrl is being invoked.",
|
919
|
+
"nullable": true
|
920
|
+
}
|
921
|
+
}
|
922
|
+
}
|
923
|
+
]
|
924
|
+
},
|
925
|
+
"DequeueWebhook": {
|
926
|
+
"description": "A queued call has been dequeued and the actionUrl of the corresponding Enqueue action is being invoked. A PerCL response is expected.",
|
927
|
+
"allOf": [
|
928
|
+
{
|
929
|
+
"$ref": "#/components/schemas/Webhook"
|
930
|
+
},
|
931
|
+
{
|
932
|
+
"type": "object",
|
933
|
+
"properties": {
|
934
|
+
"requestType": {
|
935
|
+
"type": "string",
|
936
|
+
"description": "Context or reason why this request is being made. Will be dequeue - A queued call has been dequeued and the actionUrl of the corresponding Enqueue action is being invoked."
|
937
|
+
},
|
938
|
+
"callId": {
|
939
|
+
"type": "string",
|
940
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
941
|
+
},
|
942
|
+
"accountId": {
|
943
|
+
"type": "string",
|
944
|
+
"description": "Account ID associated with your account."
|
945
|
+
},
|
946
|
+
"from": {
|
947
|
+
"type": "string",
|
948
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
949
|
+
},
|
950
|
+
"to": {
|
951
|
+
"type": "string",
|
952
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
953
|
+
},
|
954
|
+
"callStatus": {
|
955
|
+
"$ref": "#/components/schemas/CallStatus"
|
956
|
+
},
|
957
|
+
"direction": {
|
958
|
+
"$ref": "#/components/schemas/CallDirection"
|
959
|
+
},
|
960
|
+
"conferenceId": {
|
961
|
+
"type": "string",
|
962
|
+
"description": "Unique ID of the Conference."
|
963
|
+
},
|
964
|
+
"queueId": {
|
965
|
+
"type": "string",
|
966
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
967
|
+
"nullable": true
|
968
|
+
},
|
969
|
+
"queueResult": {
|
970
|
+
"type": "string",
|
971
|
+
"description": "The final result of the enqueued Call. Valid values are: •dequeued - Enqueued caller exited the Queue via a Dequeue action (Dequeue command or Queue Members POST REST API)."
|
972
|
+
},
|
973
|
+
"queueTime": {
|
974
|
+
"type": "integer",
|
975
|
+
"description": "Time (in seconds) the call spent in the Queue. This is only available if the Call was actually enqueued.",
|
976
|
+
"nullable": true
|
977
|
+
}
|
978
|
+
}
|
979
|
+
}
|
980
|
+
]
|
981
|
+
},
|
982
|
+
"GetDigitsWebhook": {
|
983
|
+
"description": "A POST request with the following fields will be sent to the actionUrl provided in your GetDigits command.",
|
984
|
+
"allOf": [
|
985
|
+
{
|
986
|
+
"$ref": "#/components/schemas/Webhook"
|
987
|
+
},
|
988
|
+
{
|
989
|
+
"type": "object",
|
990
|
+
"properties": {
|
991
|
+
"requestType": {
|
992
|
+
"type": "string",
|
993
|
+
"description": "Context or reason why this request is being made. Will be getDigits - The GetDigits command has completed and its actionUrl is being invoked."
|
994
|
+
},
|
995
|
+
"callId": {
|
996
|
+
"type": "string",
|
997
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
998
|
+
},
|
999
|
+
"accountId": {
|
1000
|
+
"type": "string",
|
1001
|
+
"description": "Account ID associated with your account."
|
1002
|
+
},
|
1003
|
+
"from": {
|
1004
|
+
"type": "string",
|
1005
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1006
|
+
},
|
1007
|
+
"to": {
|
1008
|
+
"type": "string",
|
1009
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
1010
|
+
},
|
1011
|
+
"callStatus": {
|
1012
|
+
"$ref": "#/components/schemas/CallStatus"
|
1013
|
+
},
|
1014
|
+
"direction": {
|
1015
|
+
"$ref": "#/components/schemas/CallDirection"
|
1016
|
+
},
|
1017
|
+
"conferenceId": {
|
1018
|
+
"type": "string",
|
1019
|
+
"description": "Unique ID of the Conference."
|
1020
|
+
},
|
1021
|
+
"queueId": {
|
1022
|
+
"type": "string",
|
1023
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
1024
|
+
"nullable": true
|
1025
|
+
},
|
1026
|
+
"digits": {
|
1027
|
+
"type": "string",
|
1028
|
+
"description": "tring of digits entered by the Caller, excluding the terminating digit (if used). The string of digits will be replaced by 'xxxxx' when privacyMode is set to true"
|
1029
|
+
},
|
1030
|
+
"reason": {
|
1031
|
+
"$ref": "#/components/schemas/GetDigitsReason"
|
1032
|
+
},
|
1033
|
+
"parentCallId": {
|
1034
|
+
"type": "string",
|
1035
|
+
"description": "ID of the Call that created this leg (child call)."
|
1036
|
+
}
|
1037
|
+
}
|
1038
|
+
}
|
1039
|
+
]
|
1040
|
+
},
|
1041
|
+
"GetSpeechWebhook": {
|
1042
|
+
"description": "The GetSpeech command has completed and its actionUrl is being invoked. A PerCL response is expected, unless reason is hangup.",
|
1043
|
+
"allOf": [
|
1044
|
+
{
|
1045
|
+
"$ref": "#/components/schemas/Webhook"
|
1046
|
+
},
|
1047
|
+
{
|
1048
|
+
"type": "object",
|
1049
|
+
"properties": {
|
1050
|
+
"requestType": {
|
1051
|
+
"type": "string",
|
1052
|
+
"description": "Context or reason why this request is being made. Will be getSpeech - The GetSpeech command has completed and its actionUrl is being invoked."
|
1053
|
+
},
|
1054
|
+
"callId": {
|
1055
|
+
"type": "string",
|
1056
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
1057
|
+
},
|
1058
|
+
"accountId": {
|
1059
|
+
"type": "string",
|
1060
|
+
"description": "Account ID associated with your account."
|
1061
|
+
},
|
1062
|
+
"from": {
|
1063
|
+
"type": "string",
|
1064
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1065
|
+
},
|
1066
|
+
"to": {
|
1067
|
+
"type": "string",
|
1068
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
1069
|
+
},
|
1070
|
+
"callStatus": {
|
1071
|
+
"$ref": "#/components/schemas/CallStatus"
|
1072
|
+
},
|
1073
|
+
"direction": {
|
1074
|
+
"$ref": "#/components/schemas/CallDirection"
|
1075
|
+
},
|
1076
|
+
"conferenceId": {
|
1077
|
+
"type": "string",
|
1078
|
+
"description": "Unique ID of the Conference."
|
1079
|
+
},
|
1080
|
+
"queueId": {
|
1081
|
+
"type": "string",
|
1082
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
1083
|
+
"nullable": true
|
1084
|
+
},
|
1085
|
+
"reason": {
|
1086
|
+
"$ref": "#/components/schemas/GetSpeechReason"
|
1087
|
+
},
|
1088
|
+
"recognitionResult": {
|
1089
|
+
"type": "string",
|
1090
|
+
"description": "Semantic content (either a string if speech was recognized or a digit if a digit was input instead of speech) returned from the entry or tag that was recognized within the grammar. The content will be replaced by 'xxxxx' when privacyMode is set to true. This field is populated only if the reason field is set to recognition or digit."
|
1091
|
+
},
|
1092
|
+
"confidence": {
|
1093
|
+
"type": "integer",
|
1094
|
+
"description": "Level of confidence in the obtained result. This is a value in the range 0 to 100 – with 0 being total lack of confidence and 100 being absolute certainty in the recognition. This field is populated only if the reason field is set to recognition."
|
1095
|
+
},
|
1096
|
+
"parentCallId": {
|
1097
|
+
"type": "string",
|
1098
|
+
"description": "ID of the Call that created this leg (child call)."
|
1099
|
+
},
|
1100
|
+
"completionReason": {
|
1101
|
+
"type": "string",
|
1102
|
+
"description": "Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.12 - speech recognition."
|
1103
|
+
},
|
1104
|
+
"completionCause": {
|
1105
|
+
"type": "string",
|
1106
|
+
"description": "Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.11 - speech recognition."
|
1107
|
+
},
|
1108
|
+
"mrcpCode": {
|
1109
|
+
"type": "integer",
|
1110
|
+
"description": "Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification."
|
1111
|
+
},
|
1112
|
+
"mrcpDiagnostic": {
|
1113
|
+
"type": "string",
|
1114
|
+
"description": "Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification."
|
1115
|
+
}
|
1116
|
+
}
|
1117
|
+
}
|
1118
|
+
]
|
1119
|
+
},
|
1120
|
+
"InboundCallWebhook": {
|
1121
|
+
"description": "An inbound Call to a number registered on FreeClimb will trigger a request to the voiceUrl of the application the number is assigned to. FreeClimb expects to receive PerCL in response to this request in order to process the Call. The following parameters are sent as the POST body.",
|
1122
|
+
"allOf": [
|
1123
|
+
{
|
1124
|
+
"$ref": "#/components/schemas/Webhook"
|
1125
|
+
},
|
1126
|
+
{
|
1127
|
+
"type": "object",
|
1128
|
+
"properties": {
|
1129
|
+
"requestType": {
|
1130
|
+
"type": "string",
|
1131
|
+
"description": "Context or reason why this request is being made. Will be inboundCall - An inbound call was received and the voiceUrl is being invoked."
|
1132
|
+
},
|
1133
|
+
"callId": {
|
1134
|
+
"type": "string",
|
1135
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
1136
|
+
},
|
1137
|
+
"accountId": {
|
1138
|
+
"type": "string",
|
1139
|
+
"description": "Account ID associated with your account."
|
1140
|
+
},
|
1141
|
+
"from": {
|
1142
|
+
"type": "string",
|
1143
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1144
|
+
},
|
1145
|
+
"to": {
|
1146
|
+
"type": "string",
|
1147
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
1148
|
+
},
|
1149
|
+
"callStatus": {
|
1150
|
+
"$ref": "#/components/schemas/CallStatus"
|
1151
|
+
},
|
1152
|
+
"direction": {
|
1153
|
+
"$ref": "#/components/schemas/CallDirection"
|
1154
|
+
},
|
1155
|
+
"conferenceId": {
|
1156
|
+
"type": "string",
|
1157
|
+
"description": "This is only populated if request pertains to a Conference. Otherwise, it is set to null.",
|
1158
|
+
"nullable": true
|
1159
|
+
},
|
1160
|
+
"queueId": {
|
1161
|
+
"type": "string",
|
1162
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
1163
|
+
"nullable": true
|
1164
|
+
},
|
1165
|
+
"parentCallId": {
|
1166
|
+
"type": "string",
|
1167
|
+
"nullable": true
|
1168
|
+
}
|
1169
|
+
}
|
1170
|
+
}
|
1171
|
+
]
|
1172
|
+
},
|
1173
|
+
"LeaveConferenceWebhook": {
|
1174
|
+
"description": "A Call has been unbridged from a Conference and its leaveConferenceUrl is being invoked. A PerCL response is expected — unless the URL is invoked due to the participant hanging up.",
|
1175
|
+
"allOf": [
|
1176
|
+
{
|
1177
|
+
"$ref": "#/components/schemas/Webhook"
|
1178
|
+
},
|
1179
|
+
{
|
1180
|
+
"type": "object",
|
1181
|
+
"properties": {
|
1182
|
+
"requestType": {
|
1183
|
+
"type": "string",
|
1184
|
+
"description": "Context or reason why this request is being made. Will be leaveConference - Call has been unbridged from a Conference and its leaveConferenceUrl is being invoked."
|
1185
|
+
},
|
1186
|
+
"callId": {
|
1187
|
+
"type": "string",
|
1188
|
+
"description": "Unique ID for this Call, generated by FreeClimb. This is the call leg which has left the Conference"
|
1189
|
+
},
|
1190
|
+
"accountId": {
|
1191
|
+
"type": "string",
|
1192
|
+
"description": "Account ID associated with your account."
|
1193
|
+
},
|
1194
|
+
"from": {
|
1195
|
+
"type": "string",
|
1196
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1197
|
+
},
|
1198
|
+
"to": {
|
1199
|
+
"type": "string",
|
1200
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
1201
|
+
},
|
1202
|
+
"callStatus": {
|
1203
|
+
"$ref": "#/components/schemas/CallStatus"
|
1204
|
+
},
|
1205
|
+
"direction": {
|
1206
|
+
"$ref": "#/components/schemas/CallDirection"
|
1207
|
+
},
|
1208
|
+
"conferenceId": {
|
1209
|
+
"type": "string",
|
1210
|
+
"description": "This is only populated if request pertains to a Conference. Otherwise, it is set to null.",
|
1211
|
+
"nullable": true
|
1212
|
+
},
|
1213
|
+
"queueId": {
|
1214
|
+
"type": "string",
|
1215
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
1216
|
+
"nullable": true
|
1217
|
+
}
|
1218
|
+
}
|
1219
|
+
}
|
1220
|
+
]
|
1221
|
+
},
|
1222
|
+
"MachineDetectedWebhook": {
|
1223
|
+
"description": "An outbound call spawned by OutDial detected an answer by a machine (answering machine or fax/modem machine) and ifMachineUrl is being invoked. A PerCL response is expected.",
|
1224
|
+
"allOf": [
|
1225
|
+
{
|
1226
|
+
"$ref": "#/components/schemas/Webhook"
|
1227
|
+
},
|
1228
|
+
{
|
1229
|
+
"type": "object",
|
1230
|
+
"properties": {
|
1231
|
+
"requestType": {
|
1232
|
+
"type": "string",
|
1233
|
+
"description": "Context or reason why this request is being made. Will be machineDetected - An outbound call spawned by OutDial was answered by a machine and the ifMachineUrl is being invoked."
|
1234
|
+
},
|
1235
|
+
"callId": {
|
1236
|
+
"type": "string",
|
1237
|
+
"description": "Unique ID for this Call, generated by FreeClimb."
|
1238
|
+
},
|
1239
|
+
"accountId": {
|
1240
|
+
"type": "string",
|
1241
|
+
"description": "Account ID associated with your account."
|
1242
|
+
},
|
1243
|
+
"from": {
|
1244
|
+
"type": "string",
|
1245
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1246
|
+
},
|
1247
|
+
"to": {
|
1248
|
+
"type": "string",
|
1249
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
1250
|
+
},
|
1251
|
+
"callStatus": {
|
1252
|
+
"$ref": "#/components/schemas/CallStatus"
|
1253
|
+
},
|
1254
|
+
"direction": {
|
1255
|
+
"$ref": "#/components/schemas/CallDirection"
|
1256
|
+
},
|
1257
|
+
"conferenceId": {
|
1258
|
+
"type": "string",
|
1259
|
+
"description": "This is only populated if request pertains to a Conference. Otherwise, it is set to null.",
|
1260
|
+
"nullable": true
|
1261
|
+
},
|
1262
|
+
"queueId": {
|
1263
|
+
"type": "string",
|
1264
|
+
"description": "This is only populated if the request pertains to a Queue. Otherwise, it is set to null.",
|
1265
|
+
"nullable": true
|
1266
|
+
},
|
1267
|
+
"parentCallId": {
|
1268
|
+
"type": "string",
|
1269
|
+
"description": "Call ID of the leg which initiated the OutDial."
|
1270
|
+
},
|
1271
|
+
"machineType": {
|
1272
|
+
"$ref": "#/components/schemas/MachineType"
|
1273
|
+
}
|
1274
|
+
}
|
1275
|
+
}
|
1276
|
+
]
|
1277
|
+
},
|
1278
|
+
"MessageDeliveryWebhook": {
|
1279
|
+
"description": "An SMS has been received by the platform and is being delivered to the smsUrl of the customer application that is associated with the destination number. A PerCL response will be ignored.",
|
1280
|
+
"allOf": [
|
1281
|
+
{
|
1282
|
+
"$ref": "#/components/schemas/Webhook"
|
1283
|
+
},
|
1284
|
+
{
|
1285
|
+
"type": "object",
|
1286
|
+
"properties": {
|
1287
|
+
"requestType": {
|
1288
|
+
"type": "string",
|
1289
|
+
"description": "Value will be messageDelivery - An SMS message has been received by the platform and is being delivered to the customer application associated with the destination number."
|
1290
|
+
},
|
1291
|
+
"accountId": {
|
1292
|
+
"type": "string",
|
1293
|
+
"description": "Account ID associated with your account."
|
1294
|
+
},
|
1295
|
+
"from": {
|
1296
|
+
"type": "string",
|
1297
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1298
|
+
},
|
1299
|
+
"to": {
|
1300
|
+
"type": "string",
|
1301
|
+
"description": "Phone number provisioned to you and to which this Call is directed (in E.164 format)."
|
1302
|
+
},
|
1303
|
+
"text": {
|
1304
|
+
"type": "string",
|
1305
|
+
"description": "Body of the SMS message."
|
1306
|
+
},
|
1307
|
+
"direction": {
|
1308
|
+
"type": "string",
|
1309
|
+
"description": "Value will be inbound to indicate the receipt of a message into the FreeClimb platform."
|
1310
|
+
},
|
1311
|
+
"applicationId": {
|
1312
|
+
"type": "string",
|
1313
|
+
"description": "ID of the application to which the destination number is assigned."
|
1314
|
+
},
|
1315
|
+
"status": {
|
1316
|
+
"type": "string",
|
1317
|
+
"description": "Value will be received to indicate that the platform has successfully received the incoming message."
|
1318
|
+
},
|
1319
|
+
"phoneNumberId": {
|
1320
|
+
"type": "string",
|
1321
|
+
"description": "ID of the destination phone number."
|
1322
|
+
},
|
1323
|
+
"uri": {
|
1324
|
+
"type": "string",
|
1325
|
+
"description": "The URI for this resource, relative to the API base URL"
|
1326
|
+
}
|
1327
|
+
}
|
1328
|
+
}
|
1329
|
+
]
|
1330
|
+
},
|
1331
|
+
"MessageStatusWebhook": {
|
1332
|
+
"description": "An outbound SMS has changed status and the notificationUrl from the Sms command or Send an SMS request is being invoked. A PerCL response will be ignored.",
|
1333
|
+
"allOf": [
|
1334
|
+
{
|
1335
|
+
"$ref": "#/components/schemas/Webhook"
|
1336
|
+
},
|
1337
|
+
{
|
1338
|
+
"type": "object",
|
1339
|
+
"properties": {
|
1340
|
+
"requestType": {
|
1341
|
+
"type": "string",
|
1342
|
+
"description": "Value will be messageStatus - An outbound SMS has changed status and the Sms command's notificationUrl is being invoked."
|
1343
|
+
},
|
1344
|
+
"accountId": {
|
1345
|
+
"type": "string",
|
1346
|
+
"description": "Account ID associated with your account."
|
1347
|
+
},
|
1348
|
+
"messageId": {
|
1349
|
+
"type": "string",
|
1350
|
+
"description": "Unique ID for this message, generated by FreeClimb."
|
1351
|
+
},
|
1352
|
+
"callId": {
|
1353
|
+
"type": "string",
|
1354
|
+
"description": "Unique ID for the Call in the context of which the Sms PerCL command was issued."
|
1355
|
+
},
|
1356
|
+
"from": {
|
1357
|
+
"type": "string",
|
1358
|
+
"description": "aPhone number used to initiate the SMS message (in E.164 format)."
|
1359
|
+
},
|
1360
|
+
"to": {
|
1361
|
+
"type": "string",
|
1362
|
+
"description": "Destination number of the SMS message (in E.164 format)."
|
1363
|
+
},
|
1364
|
+
"text": {
|
1365
|
+
"type": "string",
|
1366
|
+
"description": "Body of the SMS message."
|
1367
|
+
},
|
1368
|
+
"direction": {
|
1369
|
+
"type": "string",
|
1370
|
+
"description": "Value will be outbound to indicate an outgoing SMS from FreeClimb."
|
1371
|
+
},
|
1372
|
+
"applicationId": {
|
1373
|
+
"type": "string",
|
1374
|
+
"description": "ID of the application to which the destination number is assigned. May be null if the originating number is invalid in some way or is not registered to an application."
|
1375
|
+
},
|
1376
|
+
"status": {
|
1377
|
+
"$ref": "#/components/schemas/MessageStatus"
|
1378
|
+
},
|
1379
|
+
"phoneNumberId": {
|
1380
|
+
"type": "string",
|
1381
|
+
"description": "ID of the destination phone number."
|
1382
|
+
}
|
1383
|
+
}
|
1384
|
+
}
|
1385
|
+
]
|
1386
|
+
},
|
1387
|
+
"OutDialApiConnectWebhook": {
|
1388
|
+
"description": "An outbound call initiated by the REST API has connected and the callConnectUrl specified in the API request is being invoked. A PerCL response is expected if the call was successfully connected (with status of inProgress).",
|
1389
|
+
"allOf": [
|
1390
|
+
{
|
1391
|
+
"$ref": "#/components/schemas/Webhook"
|
1392
|
+
},
|
1393
|
+
{
|
1394
|
+
"type": "object",
|
1395
|
+
"properties": {
|
1396
|
+
"requestType": {
|
1397
|
+
"type": "string",
|
1398
|
+
"description": "Context or reason why this request is being made. Will be outDialApiConnect - An outbound call spawned by the REST API has connected and the callConnectUrl specified in the API request is being invoked."
|
1399
|
+
},
|
1400
|
+
"accountId": {
|
1401
|
+
"type": "string",
|
1402
|
+
"description": "Account ID associated with your account."
|
1403
|
+
},
|
1404
|
+
"callId": {
|
1405
|
+
"type": "string",
|
1406
|
+
"description": "Unique identifier for this Call, generated by FreeClimb"
|
1407
|
+
},
|
1408
|
+
"from": {
|
1409
|
+
"type": "string",
|
1410
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1411
|
+
},
|
1412
|
+
"to": {
|
1413
|
+
"type": "string",
|
1414
|
+
"description": "Phone number or SIP URL of the party that is receiving the call (phone number in E.164 format)."
|
1415
|
+
},
|
1416
|
+
"callStatus": {
|
1417
|
+
"$ref": "#/components/schemas/CallStatus"
|
1418
|
+
},
|
1419
|
+
"direction": {
|
1420
|
+
"$ref": "#/components/schemas/CallDirection"
|
1421
|
+
},
|
1422
|
+
"conferenceId": {
|
1423
|
+
"type": "string",
|
1424
|
+
"description": "This is only populated if request pertains to a conference. Otherwise, it is set to null.",
|
1425
|
+
"nullable": true
|
1426
|
+
},
|
1427
|
+
"queueId": {
|
1428
|
+
"type": "string",
|
1429
|
+
"description": "This is only populated if the request pertains to a queue. Otherwise, it is set to null.",
|
1430
|
+
"nullable": true
|
1431
|
+
},
|
1432
|
+
"parentCallId": {
|
1433
|
+
"type": "string",
|
1434
|
+
"description": "ID of the Call that created this leg (child call)."
|
1435
|
+
}
|
1436
|
+
}
|
1437
|
+
}
|
1438
|
+
]
|
1439
|
+
},
|
1440
|
+
"OutDialConnectWebhook": {
|
1441
|
+
"description": "A Call generated by OutDial has connected and the callConnectUrl is being invoked. This request is made in the context of the Call leg that was generated using OutDial and not the parent (the OutDialStart webhook is invoked on the parent call to continue that call context). A PerCL response is expected if the call was successfully connected (as indicated by status of inProgress) and begins the execution context for this (child) call.",
|
1442
|
+
"allOf": [
|
1443
|
+
{
|
1444
|
+
"$ref": "#/components/schemas/Webhook"
|
1445
|
+
},
|
1446
|
+
{
|
1447
|
+
"type": "object",
|
1448
|
+
"properties": {
|
1449
|
+
"requestType": {
|
1450
|
+
"type": "string",
|
1451
|
+
"description": "Context or reason why this request is being made. Will be outDialConnect - A Call generated by OutDial has connected and the callConnectUrl is being invoked."
|
1452
|
+
},
|
1453
|
+
"accountId": {
|
1454
|
+
"type": "string",
|
1455
|
+
"description": "Account ID associated with your account."
|
1456
|
+
},
|
1457
|
+
"callId": {
|
1458
|
+
"type": "string",
|
1459
|
+
"description": "Unique identifier for this Call, generated by FreeClimb"
|
1460
|
+
},
|
1461
|
+
"from": {
|
1462
|
+
"type": "string",
|
1463
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1464
|
+
},
|
1465
|
+
"to": {
|
1466
|
+
"type": "string",
|
1467
|
+
"description": "Phone number or SIP URL of the party that is receiving the call (phone number in E.164 format)."
|
1468
|
+
},
|
1469
|
+
"callStatus": {
|
1470
|
+
"$ref": "#/components/schemas/CallStatus"
|
1471
|
+
},
|
1472
|
+
"direction": {
|
1473
|
+
"$ref": "#/components/schemas/CallDirection"
|
1474
|
+
},
|
1475
|
+
"conferenceId": {
|
1476
|
+
"type": "string",
|
1477
|
+
"description": "This is only populated if request pertains to a conference. Otherwise, it is set to null.",
|
1478
|
+
"nullable": true
|
1479
|
+
},
|
1480
|
+
"queueId": {
|
1481
|
+
"type": "string",
|
1482
|
+
"description": "This is only populated if the request pertains to a queue. Otherwise, it is set to null.",
|
1483
|
+
"nullable": true
|
1484
|
+
},
|
1485
|
+
"parentCallId": {
|
1486
|
+
"type": "string",
|
1487
|
+
"description": "ID of the Call that created this leg (child call)."
|
1488
|
+
}
|
1489
|
+
}
|
1490
|
+
}
|
1491
|
+
]
|
1492
|
+
},
|
1493
|
+
"OutDialStartWebhook": {
|
1494
|
+
"description": "The OutDial command has started and the actionUrl is being invoked. This request is made in the context of the parent call (Call leg that invoked). A PerCL response is expected.",
|
1495
|
+
"allOf": [
|
1496
|
+
{
|
1497
|
+
"$ref": "#/components/schemas/Webhook"
|
1498
|
+
},
|
1499
|
+
{
|
1500
|
+
"type": "object",
|
1501
|
+
"properties": {
|
1502
|
+
"requestType": {
|
1503
|
+
"type": "string",
|
1504
|
+
"description": "Context or reason why this request is being made. Will be outDialStart - The OutDial command has started and the actionUrl is being invoked."
|
1505
|
+
},
|
1506
|
+
"accountId": {
|
1507
|
+
"type": "string",
|
1508
|
+
"description": "Account ID associated with your account."
|
1509
|
+
},
|
1510
|
+
"callId": {
|
1511
|
+
"type": "string",
|
1512
|
+
"description": "Unique identifier for this Call, generated by FreeClimb"
|
1513
|
+
},
|
1514
|
+
"from": {
|
1515
|
+
"type": "string",
|
1516
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1517
|
+
},
|
1518
|
+
"to": {
|
1519
|
+
"type": "string",
|
1520
|
+
"description": "Phone number provisioned to the customer and to which this Call is directed (in E.164 format)."
|
1521
|
+
},
|
1522
|
+
"callStatus": {
|
1523
|
+
"$ref": "#/components/schemas/CallStatus"
|
1524
|
+
},
|
1525
|
+
"direction": {
|
1526
|
+
"$ref": "#/components/schemas/CallDirection"
|
1527
|
+
},
|
1528
|
+
"conferenceId": {
|
1529
|
+
"type": "string",
|
1530
|
+
"description": "This is only populated if request pertains to a conference. Otherwise, it is set to null.",
|
1531
|
+
"nullable": true
|
1532
|
+
},
|
1533
|
+
"queueId": {
|
1534
|
+
"type": "string",
|
1535
|
+
"description": "This is only populated if the request pertains to a queue. Otherwise, it is set to null.",
|
1536
|
+
"nullable": true
|
1537
|
+
},
|
1538
|
+
"dialCallId": {
|
1539
|
+
"type": "string",
|
1540
|
+
"description": "ID of the child call that was generated as a result of the Outdial."
|
1541
|
+
},
|
1542
|
+
"parentCallId": {
|
1543
|
+
"type": "string",
|
1544
|
+
"description": "ID of the Call that created this leg (child call). If this was an inbound call or call created via REST API with no parent, this field will be null.",
|
1545
|
+
"nullable": true
|
1546
|
+
}
|
1547
|
+
}
|
1548
|
+
}
|
1549
|
+
]
|
1550
|
+
},
|
1551
|
+
"QueueWaitWebhook": {
|
1552
|
+
"description": "A queued Call is requesting instructions to execute during the wait in the Queue and the corresponding waitUrl is being invoked. A PerCL response is expected. The following are the only PerCL commands supported in the PerCL script response to a request to the waitUrl: Play,Say,Pause,GetDigits,Dequeue,Hangup",
|
1553
|
+
"allOf": [
|
1554
|
+
{
|
1555
|
+
"$ref": "#/components/schemas/Webhook"
|
1556
|
+
},
|
1557
|
+
{
|
1558
|
+
"type": "object",
|
1559
|
+
"properties": {
|
1560
|
+
"requestType": {
|
1561
|
+
"type": "string",
|
1562
|
+
"description": "Context or reason why this request is being made. Will be queueWait - A queued call is requesting instructions to execute during the wait in the queue and the corresponding waitUrl is being invoked."
|
1563
|
+
},
|
1564
|
+
"accountId": {
|
1565
|
+
"type": "string",
|
1566
|
+
"description": "Account ID associated with your account."
|
1567
|
+
},
|
1568
|
+
"callId": {
|
1569
|
+
"type": "string",
|
1570
|
+
"description": "Unique identifier for this Call, generated by FreeClimb"
|
1571
|
+
},
|
1572
|
+
"from": {
|
1573
|
+
"type": "string",
|
1574
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1575
|
+
},
|
1576
|
+
"to": {
|
1577
|
+
"type": "string",
|
1578
|
+
"description": "Phone number provisioned to the customer and to which this Call is directed (in E.164 format)."
|
1579
|
+
},
|
1580
|
+
"callStatus": {
|
1581
|
+
"$ref": "#/components/schemas/CallStatus"
|
1582
|
+
},
|
1583
|
+
"direction": {
|
1584
|
+
"$ref": "#/components/schemas/CallDirection"
|
1585
|
+
},
|
1586
|
+
"conferenceId": {
|
1587
|
+
"type": "string",
|
1588
|
+
"description": "This is only populated if request pertains to a conference. Otherwise, it is set to null.",
|
1589
|
+
"nullable": true
|
1590
|
+
},
|
1591
|
+
"queueId": {
|
1592
|
+
"type": "string",
|
1593
|
+
"description": "This is only populated if the request pertains to a queue. Otherwise, it is set to null.",
|
1594
|
+
"nullable": true
|
1595
|
+
},
|
1596
|
+
"queuePosition": {
|
1597
|
+
"type": "string",
|
1598
|
+
"description": "Current queue position of the enqueued Call."
|
1599
|
+
},
|
1600
|
+
"queueTime": {
|
1601
|
+
"type": "integer",
|
1602
|
+
"description": "Time (in seconds) the Call spent in the Queue. This is only available if the Call was actually enqueued."
|
1603
|
+
},
|
1604
|
+
"currentQueueSize": {
|
1605
|
+
"type": "integer",
|
1606
|
+
"description": "Current number of enqueued Calls in this Queue."
|
1607
|
+
}
|
1608
|
+
}
|
1609
|
+
}
|
1610
|
+
]
|
1611
|
+
},
|
1612
|
+
"RecordWebhook": {
|
1613
|
+
"description": "The RecordUtterance command has completed and its actionUrl is being invoked.",
|
1614
|
+
"allOf": [
|
1615
|
+
{
|
1616
|
+
"$ref": "#/components/schemas/Webhook"
|
1617
|
+
},
|
1618
|
+
{
|
1619
|
+
"type": "object",
|
1620
|
+
"properties": {
|
1621
|
+
"requestType": {
|
1622
|
+
"type": "string",
|
1623
|
+
"description": "The context or reason why this request is being made. Will be record - The RecordUtterance command has completed and its actionUrl is being invoked."
|
1624
|
+
},
|
1625
|
+
"accountId": {
|
1626
|
+
"type": "string",
|
1627
|
+
"description": "Account ID associated with your account."
|
1628
|
+
},
|
1629
|
+
"callId": {
|
1630
|
+
"type": "string",
|
1631
|
+
"description": "Unique identifier for this Call, generated by FreeClimb"
|
1632
|
+
},
|
1633
|
+
"from": {
|
1634
|
+
"type": "string",
|
1635
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1636
|
+
},
|
1637
|
+
"to": {
|
1638
|
+
"type": "string",
|
1639
|
+
"description": "Phone number provisioned to the customer and to which this Call is directed (in E.164 format)."
|
1640
|
+
},
|
1641
|
+
"callStatus": {
|
1642
|
+
"$ref": "#/components/schemas/CallStatus"
|
1643
|
+
},
|
1644
|
+
"direction": {
|
1645
|
+
"$ref": "#/components/schemas/CallDirection"
|
1646
|
+
},
|
1647
|
+
"conferenceId": {
|
1648
|
+
"type": "string",
|
1649
|
+
"description": "This is only populated if request pertains to a conference. Otherwise, it is set to null.",
|
1650
|
+
"nullable": true
|
1651
|
+
},
|
1652
|
+
"queueId": {
|
1653
|
+
"type": "string",
|
1654
|
+
"description": "This is only populated if the request pertains to a queue. Otherwise, it is set to null.",
|
1655
|
+
"nullable": true
|
1656
|
+
},
|
1657
|
+
"recordingId": {
|
1658
|
+
"type": "string",
|
1659
|
+
"description": "ID of the recording."
|
1660
|
+
},
|
1661
|
+
"recordingUrl": {
|
1662
|
+
"type": "string",
|
1663
|
+
"description": "URL of the recorded audio file. This URL can be used as is in a Play command to play the recording (no authentication needed). It can also be used to download a recording file via the REST API.",
|
1664
|
+
"format": "uri"
|
1665
|
+
},
|
1666
|
+
"recordingSize": {
|
1667
|
+
"type": "string",
|
1668
|
+
"description": "Size of the recording in bytes"
|
1669
|
+
},
|
1670
|
+
"recordingFormat": {
|
1671
|
+
"type": "string",
|
1672
|
+
"description": "File type of the recording (audio/wav)"
|
1673
|
+
},
|
1674
|
+
"recordingDurationSec": {
|
1675
|
+
"type": "integer",
|
1676
|
+
"description": "Duration of the recorded audio rounded up to the nearest second (in seconds)"
|
1677
|
+
},
|
1678
|
+
"termReason": {
|
1679
|
+
"$ref": "#/components/schemas/RecordUtteranceTermReason"
|
1680
|
+
},
|
1681
|
+
"parentCallId": {
|
1682
|
+
"type": "string",
|
1683
|
+
"description": "ID of Call that created this leg (child call)."
|
1684
|
+
},
|
1685
|
+
"privacyMode": {
|
1686
|
+
"type": "boolean",
|
1687
|
+
"description": "If true then it indicates the recording will only be available for download for two minutes prior to it being deleted. This is to minimize risk of anyone else getting access to the url and attempting to access it."
|
1688
|
+
}
|
1689
|
+
}
|
1690
|
+
}
|
1691
|
+
]
|
1692
|
+
},
|
1693
|
+
"RedirectWebhook": {
|
1694
|
+
"description": "The Redirect command is executing and its actionUrl is being invoked. A PerCL response is expected.",
|
1695
|
+
"allOf": [
|
1696
|
+
{
|
1697
|
+
"$ref": "#/components/schemas/Webhook"
|
1698
|
+
},
|
1699
|
+
{
|
1700
|
+
"type": "object",
|
1701
|
+
"properties": {
|
1702
|
+
"requestType": {
|
1703
|
+
"type": "string",
|
1704
|
+
"description": "Context or reason why this request is being made. Will be redirect - The Redirect command is executing and its actionUrl is being invoked."
|
1705
|
+
},
|
1706
|
+
"accountId": {
|
1707
|
+
"type": "string",
|
1708
|
+
"description": "Account ID associated with your account."
|
1709
|
+
},
|
1710
|
+
"callId": {
|
1711
|
+
"type": "string",
|
1712
|
+
"description": "Unique identifier for this Call, generated by FreeClimb"
|
1713
|
+
},
|
1714
|
+
"from": {
|
1715
|
+
"type": "string",
|
1716
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1717
|
+
},
|
1718
|
+
"to": {
|
1719
|
+
"type": "string",
|
1720
|
+
"description": "Phone number provisioned to the customer and to which this Call is directed (in E.164 format)."
|
1721
|
+
},
|
1722
|
+
"callStatus": {
|
1723
|
+
"$ref": "#/components/schemas/CallStatus"
|
1724
|
+
},
|
1725
|
+
"direction": {
|
1726
|
+
"$ref": "#/components/schemas/CallDirection"
|
1727
|
+
},
|
1728
|
+
"conferenceId": {
|
1729
|
+
"type": "string",
|
1730
|
+
"description": "This is only populated if request pertains to a conference. Otherwise, it is set to null.",
|
1731
|
+
"nullable": true
|
1732
|
+
},
|
1733
|
+
"queueId": {
|
1734
|
+
"type": "string",
|
1735
|
+
"description": "This is only populated if the request pertains to a queue. Otherwise, it is set to null.",
|
1736
|
+
"nullable": true
|
1737
|
+
},
|
1738
|
+
"parentCallId": {
|
1739
|
+
"type": "string",
|
1740
|
+
"description": "ID of Call that created this leg (child call)."
|
1741
|
+
}
|
1742
|
+
}
|
1743
|
+
}
|
1744
|
+
]
|
439
1745
|
},
|
440
|
-
"
|
441
|
-
"
|
442
|
-
"
|
443
|
-
|
444
|
-
|
445
|
-
|
446
|
-
|
447
|
-
"
|
448
|
-
"
|
449
|
-
|
450
|
-
|
451
|
-
|
452
|
-
|
453
|
-
|
454
|
-
|
455
|
-
|
456
|
-
|
457
|
-
|
458
|
-
|
459
|
-
|
460
|
-
|
461
|
-
|
462
|
-
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
468
|
-
|
469
|
-
|
470
|
-
|
471
|
-
|
472
|
-
|
1746
|
+
"RemoveFromQueueNotificationWebhook": {
|
1747
|
+
"description": "A call has been removed from a queue and the Enqueue command’s actionUrl is being invoked. A PerCL response is expected except if reason is hangup.",
|
1748
|
+
"allOf": [
|
1749
|
+
{
|
1750
|
+
"$ref": "#/components/schemas/Webhook"
|
1751
|
+
},
|
1752
|
+
{
|
1753
|
+
"type": "object",
|
1754
|
+
"properties": {
|
1755
|
+
"requestType": {
|
1756
|
+
"type": "string",
|
1757
|
+
"description": "Context or reason why this request is being made. Will be removeFromQueueNotification - A Call has been removed from a Queue and the Enqueue command’s actionUrl is being invoked."
|
1758
|
+
},
|
1759
|
+
"accountId": {
|
1760
|
+
"type": "string",
|
1761
|
+
"description": "Account ID associated with your account."
|
1762
|
+
},
|
1763
|
+
"callId": {
|
1764
|
+
"type": "string",
|
1765
|
+
"description": "Unique identifier for this Call, generated by FreeClimb"
|
1766
|
+
},
|
1767
|
+
"from": {
|
1768
|
+
"type": "string",
|
1769
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1770
|
+
},
|
1771
|
+
"to": {
|
1772
|
+
"type": "string",
|
1773
|
+
"description": "Phone number provisioned to the customer and to which this Call is directed (in E.164 format)."
|
1774
|
+
},
|
1775
|
+
"callStatus": {
|
1776
|
+
"$ref": "#/components/schemas/CallStatus"
|
1777
|
+
},
|
1778
|
+
"direction": {
|
1779
|
+
"$ref": "#/components/schemas/CallDirection"
|
1780
|
+
},
|
1781
|
+
"conferenceId": {
|
1782
|
+
"type": "string",
|
1783
|
+
"description": "This is only populated if request pertains to a conference. Otherwise, it is set to null.",
|
1784
|
+
"nullable": true
|
1785
|
+
},
|
1786
|
+
"queueId": {
|
1787
|
+
"type": "string",
|
1788
|
+
"description": "This is only populated if the request pertains to a queue. Otherwise, it is set to null.",
|
1789
|
+
"nullable": true
|
1790
|
+
},
|
1791
|
+
"queueResult": {
|
1792
|
+
"$ref": "#/components/schemas/QueueResultStatus"
|
1793
|
+
},
|
1794
|
+
"queueTime": {
|
1795
|
+
"type": "integer",
|
1796
|
+
"description": "Time (in seconds) the Call spent in the Queue. This is only available if the Call was actually enqueued."
|
1797
|
+
}
|
1798
|
+
}
|
473
1799
|
}
|
474
|
-
|
475
|
-
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
"
|
1800
|
+
]
|
1801
|
+
},
|
1802
|
+
"TranscribeWebhook": {
|
1803
|
+
"allOf": [
|
1804
|
+
{
|
1805
|
+
"$ref": "#/components/schemas/Webhook"
|
1806
|
+
},
|
1807
|
+
{
|
1808
|
+
"type": "object",
|
1809
|
+
"properties": {
|
1810
|
+
"requestType": {
|
1811
|
+
"type": "string",
|
1812
|
+
"description": "The context or reason why this request is being made. Will be transcribe - The TranscribeUtterance command has completed and its actionUrl is being invoked."
|
1813
|
+
},
|
1814
|
+
"accountId": {
|
1815
|
+
"type": "string",
|
1816
|
+
"description": "Account ID associated with your account."
|
1817
|
+
},
|
1818
|
+
"callId": {
|
1819
|
+
"type": "string",
|
1820
|
+
"description": "Unique identifier for this Call, generated by FreeClimb"
|
1821
|
+
},
|
1822
|
+
"from": {
|
1823
|
+
"type": "string",
|
1824
|
+
"description": "Phone number of the party that initiated the Call (in E.164 format)."
|
1825
|
+
},
|
1826
|
+
"to": {
|
1827
|
+
"type": "string",
|
1828
|
+
"description": "Phone number provisioned to the customer and to which this Call is directed (in E.164 format)."
|
1829
|
+
},
|
1830
|
+
"recordingId": {
|
1831
|
+
"type": "string",
|
1832
|
+
"description": "The ID of the recording. If no recording was made due to errors or the 'saveRecording' flag being disabled this field will be set to null.",
|
1833
|
+
"nullable": true
|
1834
|
+
},
|
1835
|
+
"recordingUrl": {
|
1836
|
+
"type": "string",
|
1837
|
+
"description": "The URL of the recorded audio file. This URL can be used as is in a Play command to play the recording (no authentication needed). It can also be used to download the recording file via the REST API.",
|
1838
|
+
"format": "uri",
|
1839
|
+
"nullable": true
|
1840
|
+
},
|
1841
|
+
"recordingSize": {
|
1842
|
+
"type": "integer",
|
1843
|
+
"description": "The size of the recording in bytes."
|
1844
|
+
},
|
1845
|
+
"recordingFormat": {
|
1846
|
+
"type": "string",
|
1847
|
+
"description": "The media type of the recording.",
|
1848
|
+
"nullable": true
|
1849
|
+
},
|
1850
|
+
"recordingDurationMs": {
|
1851
|
+
"type": "integer",
|
1852
|
+
"description": "The duration of the recorded audio in milliseconds."
|
1853
|
+
},
|
1854
|
+
"termReason": {
|
1855
|
+
"$ref": "#/components/schemas/TranscribeTermReason"
|
1856
|
+
},
|
1857
|
+
"recordTermReason": {
|
1858
|
+
"$ref": "#/components/schemas/RecordUtteranceTermReason"
|
1859
|
+
},
|
1860
|
+
"digit": {
|
1861
|
+
"type": "string",
|
1862
|
+
"description": "If recordTermReason is digit, this will be the digit that was pressed. Otherwise it will be null.",
|
1863
|
+
"nullable": true
|
1864
|
+
},
|
1865
|
+
"privacyForLogging": {
|
1866
|
+
"type": "boolean",
|
1867
|
+
"description": "Echo back of the privacyForLogging flag as specified in the transcribe utterance command – confirmation of logging protection has been applied. Can be used by application to know it should also apply protection when handling this request."
|
1868
|
+
},
|
1869
|
+
"privacyForRecording": {
|
1870
|
+
"type": "boolean",
|
1871
|
+
"description": "Echo back of the privacyForRecording flag as specified in the transcribe utterance command – confirmation of logging protection has been applied. Can be used by application to know it should also apply protection when handling this request."
|
1872
|
+
},
|
1873
|
+
"bargeInReason": {
|
1874
|
+
"$ref": "#/components/schemas/BargeInReason"
|
1875
|
+
},
|
1876
|
+
"bargedInPromptNo": {
|
1877
|
+
"type": "integer"
|
1878
|
+
},
|
1879
|
+
"bargedInPromptMs": {
|
1880
|
+
"type": "integer",
|
1881
|
+
"description": "duration in ms bargedInPromptNo prompt was executing until barge-in occurred."
|
1882
|
+
},
|
1883
|
+
"bargedInPromptLoopNo": {
|
1884
|
+
"type": "integer"
|
1885
|
+
},
|
1886
|
+
"bargeInTimeMs": {
|
1887
|
+
"type": "integer",
|
1888
|
+
"description": "epoch time in ms"
|
1889
|
+
},
|
1890
|
+
"transcript": {
|
1891
|
+
"type": "string",
|
1892
|
+
"description": "Transcribed text of the recording. Can be empty or null. null means there was a failure in transcribing the audio, refer to transcribeReason for detailed failure reason.",
|
1893
|
+
"nullable": true
|
1894
|
+
},
|
1895
|
+
"transcribeReason": {
|
1896
|
+
"$ref": "#/components/schemas/TranscribeReason"
|
1897
|
+
},
|
1898
|
+
"transcriptionDurationMs": {
|
1899
|
+
"type": "integer",
|
1900
|
+
"description": "The duration of the audio being transcribed in milliseconds"
|
1901
|
+
}
|
1902
|
+
}
|
480
1903
|
}
|
481
|
-
|
1904
|
+
]
|
482
1905
|
},
|
483
1906
|
"AddToConference": {
|
484
1907
|
"description": "The `AddToConference` command adds a Participant to a Conference. Two Call legs can be bridged together by creating a Conference and adding both Call legs to it via `AddToConference`.",
|
485
|
-
"
|
486
|
-
"x-ref-properties": [
|
487
|
-
"false",
|
488
|
-
"\"TEST_STRING\"",
|
489
|
-
"\"TEST_STRING\"",
|
490
|
-
"\"TEST_STRING\"",
|
491
|
-
"\"TEST_STRING\"",
|
492
|
-
"false",
|
493
|
-
"\"TEST_STRING\"",
|
494
|
-
"false",
|
495
|
-
"false"
|
496
|
-
],
|
1908
|
+
"required": ["conferenceId"],
|
497
1909
|
"allOf": [
|
498
1910
|
{
|
499
1911
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -512,7 +1924,8 @@
|
|
512
1924
|
},
|
513
1925
|
"callControlUrl": {
|
514
1926
|
"description": "URL to be invoked when this Participant enters the digit sequence defined in the `callControlSequence` attribute.",
|
515
|
-
"type": "string"
|
1927
|
+
"type": "string",
|
1928
|
+
"format": "uri"
|
516
1929
|
},
|
517
1930
|
"conferenceId": {
|
518
1931
|
"description": "ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result.",
|
@@ -520,6 +1933,7 @@
|
|
520
1933
|
},
|
521
1934
|
"leaveConferenceUrl": {
|
522
1935
|
"description": "URL to be invoked when the Participant leaves the Conference. ",
|
1936
|
+
"format": "uri",
|
523
1937
|
"type": "string"
|
524
1938
|
},
|
525
1939
|
"listen": {
|
@@ -528,6 +1942,7 @@
|
|
528
1942
|
},
|
529
1943
|
"notificationUrl": {
|
530
1944
|
"description": "When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters.",
|
1945
|
+
"format": "uri",
|
531
1946
|
"type": "string"
|
532
1947
|
},
|
533
1948
|
"startConfOnEnter": {
|
@@ -548,16 +1963,6 @@
|
|
548
1963
|
},
|
549
1964
|
"CreateConference": {
|
550
1965
|
"description": "The `CreateConference` command does exactly what its name implies — it creates an unpopulated Conference (one without any Participants). Once created, a Conference remains in FreeClimb until explicitly terminated by a customer. Once a Conference has been terminated, it can no longer be used.",
|
551
|
-
"x-percl-command": true,
|
552
|
-
"x-ref-properties": [
|
553
|
-
"\"TEST_STRING\"",
|
554
|
-
"false",
|
555
|
-
"PlayBeep.ALWAYS",
|
556
|
-
"false",
|
557
|
-
"\"https://a.com\"",
|
558
|
-
"\"https://a.com\"",
|
559
|
-
"\"TEST_STRING\""
|
560
|
-
],
|
561
1966
|
"allOf": [
|
562
1967
|
{
|
563
1968
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -568,8 +1973,8 @@
|
|
568
1973
|
"properties": {
|
569
1974
|
"actionUrl": {
|
570
1975
|
"description": " This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response. ",
|
571
|
-
"
|
572
|
-
"
|
1976
|
+
"format": "uri",
|
1977
|
+
"type": "string"
|
573
1978
|
},
|
574
1979
|
"alias": {
|
575
1980
|
"description": "Descriptive name for the Conference. ",
|
@@ -584,10 +1989,12 @@
|
|
584
1989
|
},
|
585
1990
|
"statusCallbackUrl": {
|
586
1991
|
"description": "This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available.",
|
1992
|
+
"format": "uri",
|
587
1993
|
"type": "string"
|
588
1994
|
},
|
589
1995
|
"waitUrl": {
|
590
1996
|
"description": "If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb.",
|
1997
|
+
"format": "uri",
|
591
1998
|
"type": "string"
|
592
1999
|
}
|
593
2000
|
}
|
@@ -596,8 +2003,6 @@
|
|
596
2003
|
},
|
597
2004
|
"Dequeue": {
|
598
2005
|
"description": "The `Dequeue` command transfers control of a Call that is in a Queue so that the waiting caller exits the Queue. Execution continues with the first command in the PerCL script returned by the `actionUrl` specified in the `Enqueue` command.",
|
599
|
-
"x-percl-command": true,
|
600
|
-
"x-no-properties": true,
|
601
2006
|
"allOf": [
|
602
2007
|
{
|
603
2008
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -609,18 +2014,10 @@
|
|
609
2014
|
},
|
610
2015
|
"Enqueue": {
|
611
2016
|
"description": "The `Enqueue` command adds the current Call to a call Queue. If the specified Queue does not exist, it is created and then the Call is added to it. The default maximum length of the queue is 100. This can be modified using the REST API.",
|
612
|
-
"
|
613
|
-
"x-ref-properties": [
|
614
|
-
"\"TEST_STRING\"",
|
615
|
-
"\"TEST_STRING\"",
|
616
|
-
"\"TEST_STRING\"",
|
617
|
-
"\"TEST_STRING\"",
|
618
|
-
"\"TEST_STRING\""
|
619
|
-
],
|
2017
|
+
"required": ["queueId", "waitUrl", "actionUrl"],
|
620
2018
|
"allOf": [
|
621
2019
|
{
|
622
|
-
"$ref": "#/components/schemas/PerclCommand"
|
623
|
-
"x-is-uri": true
|
2020
|
+
"$ref": "#/components/schemas/PerclCommand"
|
624
2021
|
},
|
625
2022
|
{
|
626
2023
|
"type": "object",
|
@@ -629,12 +2026,12 @@
|
|
629
2026
|
"actionUrl": {
|
630
2027
|
"description": "A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up.",
|
631
2028
|
"type": "string",
|
632
|
-
"
|
2029
|
+
"format": "uri"
|
633
2030
|
},
|
634
2031
|
"notificationUrl": {
|
635
2032
|
"description": "URL to be invoked when the call enters the queue. The request to the URL contains the standard request parameters.This is a notification only; any PerCL returned will be ignored.",
|
636
2033
|
"type": "string",
|
637
|
-
"
|
2034
|
+
"format": "uri"
|
638
2035
|
},
|
639
2036
|
"queueId": {
|
640
2037
|
"description": "ID of the Queue to which to add the Call. If the Queue does not exist, it will be created. The ID must start with QU followed by 40 hex characters.",
|
@@ -642,7 +2039,8 @@
|
|
642
2039
|
},
|
643
2040
|
"waitUrl": {
|
644
2041
|
"description": "A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up.",
|
645
|
-
"type": "string"
|
2042
|
+
"type": "string",
|
2043
|
+
"format": "uri"
|
646
2044
|
}
|
647
2045
|
}
|
648
2046
|
}
|
@@ -650,23 +2048,9 @@
|
|
650
2048
|
},
|
651
2049
|
"GetDigits": {
|
652
2050
|
"description": "The `GetDigits` command collects DTMF inputs from the caller. It is only supported only when there is a single party on the Call. `GetDigits` is a Terminal Command — any actions following it are never executed. When the Caller is done entering the digits, FreeClimb submits that data to the provided `actionUrl` using an HTTP POST request. Your server will be required to respond to the FreeClimb Webhook with PerCL to continue handling the call.",
|
653
|
-
"x-percl-command": true,
|
654
|
-
"x-ref-properties": [
|
655
|
-
"\"https://a.com\"",
|
656
|
-
"1",
|
657
|
-
"\"TEST_STRING\"",
|
658
|
-
"false",
|
659
|
-
"300",
|
660
|
-
"1",
|
661
|
-
"1",
|
662
|
-
"new List<PerclCommand>()",
|
663
|
-
"false",
|
664
|
-
"\"TEST_STRING\""
|
665
|
-
],
|
666
2051
|
"allOf": [
|
667
2052
|
{
|
668
|
-
"$ref": "#/components/schemas/PerclCommand"
|
669
|
-
"x-is-uri": true
|
2053
|
+
"$ref": "#/components/schemas/PerclCommand"
|
670
2054
|
},
|
671
2055
|
{
|
672
2056
|
"type": "object",
|
@@ -675,7 +2059,7 @@
|
|
675
2059
|
"actionUrl": {
|
676
2060
|
"description": "When the Caller has finished entering digits, FreeClimb will make an HTTP POST request to this URL. A PerCL response is expected to continue handling the Call. Make sure to keep “http://“ in the URL.",
|
677
2061
|
"type": "string",
|
678
|
-
"
|
2062
|
+
"format": "uri"
|
679
2063
|
},
|
680
2064
|
"digitTimeoutMs": {
|
681
2065
|
"description": " Maximum time in milliseconds that FreeClimb will wait for the Caller to press any digit after the last digit entered, before making a determination that a `timeout` has occurred and moving on to make the request to the actionUrl to submit the results of the `GetDigits` command. This timeout interval begins and resets after each digit entered.",
|
@@ -704,7 +2088,6 @@
|
|
704
2088
|
"prompts": {
|
705
2089
|
"description": "JSON array of PerCL commands to nest within the `GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller.",
|
706
2090
|
"type": "array",
|
707
|
-
"x-is-list": true,
|
708
2091
|
"items": {
|
709
2092
|
"$ref": "#/components/schemas/PerclCommand"
|
710
2093
|
}
|
@@ -719,23 +2102,6 @@
|
|
719
2102
|
},
|
720
2103
|
"GetSpeech": {
|
721
2104
|
"description": "The `GetSpeech` command enables the Caller to respond to the application using a supported language. Unlike DTMF entry, which implicitly restricts the user to using the available buttons on the phone key pad, speech input allows for flexible audio inputs based on grammar. FreeClimb supports grammars written using GRXML compatible with the Microsoft Speech Platform. `GetSpeech` is only supported on a single call leg. It is not supported when there are two or more call legs connected (as in within a Conference).",
|
722
|
-
"x-percl-command": true,
|
723
|
-
"x-ref-properties": [
|
724
|
-
"\"https://a.com\"",
|
725
|
-
"GrammarType.URL",
|
726
|
-
"\"TEST_STRING\"",
|
727
|
-
"\"TEST_STRING\"",
|
728
|
-
"false",
|
729
|
-
"new List<PerclCommand>()",
|
730
|
-
"1",
|
731
|
-
"1",
|
732
|
-
"1",
|
733
|
-
"1",
|
734
|
-
"1",
|
735
|
-
"1",
|
736
|
-
"false",
|
737
|
-
"\"TEST_STRING\""
|
738
|
-
],
|
739
2105
|
"allOf": [
|
740
2106
|
{
|
741
2107
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -747,9 +2113,7 @@
|
|
747
2113
|
"actionUrl": {
|
748
2114
|
"description": "When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call.",
|
749
2115
|
"type": "string",
|
750
|
-
"format": "uri"
|
751
|
-
"x-is-uri": true,
|
752
|
-
"x-is-url": true
|
2116
|
+
"format": "uri"
|
753
2117
|
},
|
754
2118
|
"grammarType": {
|
755
2119
|
"$ref": "#/components/schemas/GrammarType"
|
@@ -771,8 +2135,7 @@
|
|
771
2135
|
"type": "array",
|
772
2136
|
"items": {
|
773
2137
|
"$ref": "#/components/schemas/PerclCommand"
|
774
|
-
}
|
775
|
-
"x-is-list": true
|
2138
|
+
}
|
776
2139
|
},
|
777
2140
|
"noInputTimeoutMs": {
|
778
2141
|
"description": "When recognition is started and there is no speech detected for `noInputTimeoutMs` milliseconds, the recognizer will terminate the recognition operation.",
|
@@ -808,7 +2171,6 @@
|
|
808
2171
|
},
|
809
2172
|
"Hangup": {
|
810
2173
|
"description": "The `Hangup` command terminates a Call. If `Hangup` is used as the first action in a PerCL response, it does not prevent FreeClimb from answering the Call and billing your account. See the `Reject` command to hang up at no charge.",
|
811
|
-
"x-percl-command": true,
|
812
2174
|
"allOf": [
|
813
2175
|
{
|
814
2176
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -826,24 +2188,9 @@
|
|
826
2188
|
},
|
827
2189
|
"OutDial": {
|
828
2190
|
"description": "The OutDial command is used to call a phone number",
|
829
|
-
"x-percl-command": true,
|
830
|
-
"x-ref-properties": [
|
831
|
-
"\"https://a.com\"",
|
832
|
-
"\"https://a.com\"",
|
833
|
-
"\"TEST_STRING\"",
|
834
|
-
"\"TEST_STRING\"",
|
835
|
-
"IfMachine.REDIRECT",
|
836
|
-
"\"https://a.com\"",
|
837
|
-
"\"TEST_STRING\"",
|
838
|
-
"\"TEST_STRING\"",
|
839
|
-
"1",
|
840
|
-
"false",
|
841
|
-
"\"TEST_STRING\""
|
842
|
-
],
|
843
2191
|
"allOf": [
|
844
2192
|
{
|
845
|
-
"$ref": "#/components/schemas/PerclCommand"
|
846
|
-
"x-is-uri": true
|
2193
|
+
"$ref": "#/components/schemas/PerclCommand"
|
847
2194
|
},
|
848
2195
|
{
|
849
2196
|
"required": [
|
@@ -857,12 +2204,12 @@
|
|
857
2204
|
"actionUrl": {
|
858
2205
|
"description": "URL to which FreeClimb sends an HTTP POST request. ",
|
859
2206
|
"type": "string",
|
860
|
-
"
|
2207
|
+
"format": "uri"
|
861
2208
|
},
|
862
2209
|
"callConnectUrl": {
|
863
2210
|
"description": "URL to which FreeClimb makes an HTTP POST request informing the result of the OutDial.",
|
864
2211
|
"type": "string",
|
865
|
-
"
|
2212
|
+
"format": "uri"
|
866
2213
|
},
|
867
2214
|
"callingNumber": {
|
868
2215
|
"description": "he caller ID to show to the called party when FreeClimb calls. This can be one of the following: The To or From number provided in the first Webhook to your webserver. Any phone number you have purchased from FreeClimb.",
|
@@ -877,6 +2224,7 @@
|
|
877
2224
|
},
|
878
2225
|
"ifMachineUrl": {
|
879
2226
|
"description": "When the `ifMachine` flag is set to `redirect`, this attribute specifies a URL to which FreeClimb makes a POST request when an answering machine or a fax machine is detected. This URL is required if the `ifMachine` flag is set to `redirect`. Otherwise, it should not be included.",
|
2227
|
+
"format": "uri",
|
880
2228
|
"type": "string"
|
881
2229
|
},
|
882
2230
|
"sendDigits": {
|
@@ -885,6 +2233,7 @@
|
|
885
2233
|
},
|
886
2234
|
"statusCallbackUrl": {
|
887
2235
|
"description": "When the outdialed Call leg terminates, FreeClimb sends a `callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored.",
|
2236
|
+
"format": "uri",
|
888
2237
|
"type": "string"
|
889
2238
|
},
|
890
2239
|
"timeout": {
|
@@ -901,17 +2250,9 @@
|
|
901
2250
|
},
|
902
2251
|
"Park": {
|
903
2252
|
"description": "The `Park` command allows a caller to be put on hold. You can provide hold music,messages,etc until ready to resume the call. Park is a terminal command. Actions performed on the Call while on hold are provided in a PerCL script in response to the waitUrl property. Actions performed on the Call after it has been unparked (resumed) will be provided in a PerCL script in response to the actionUrl provided. A Call can be resumed in two ways -- REST API invocation or the Unpark percl command. No actions can be nested within Park and Park cannot be nested in any other actions. ",
|
904
|
-
"x-percl-command": true,
|
905
|
-
"x-ref-properties": [
|
906
|
-
"\"https://a.com\"",
|
907
|
-
"\"https://a.com\"",
|
908
|
-
"\"TEST_STRING\"",
|
909
|
-
"\"TEST_STRING\""
|
910
|
-
],
|
911
2253
|
"allOf": [
|
912
2254
|
{
|
913
|
-
"$ref": "#/components/schemas/PerclCommand"
|
914
|
-
"x-is-uri": true
|
2255
|
+
"$ref": "#/components/schemas/PerclCommand"
|
915
2256
|
},
|
916
2257
|
{
|
917
2258
|
"type": "object",
|
@@ -920,16 +2261,17 @@
|
|
920
2261
|
"waitUrl": {
|
921
2262
|
"description": "Specifies a URL pointing to a PerCL script containing actions to be executed while the caller is Parked. Once the script returned by the waitUrl runs out of commands to execute, FreeClimb will re-request the waitUrl and start over, essentially looping the script requests indefinitely.",
|
922
2263
|
"type": "string",
|
923
|
-
"
|
2264
|
+
"format": "uri"
|
924
2265
|
},
|
925
2266
|
"actionUrl": {
|
926
2267
|
"description": "A request is made to this URL when the Call is resumed, which can occur if the Call is resumed via the Unpark command, the REST API (POST to Call resource), or the caller hangs up. The PerCL script returned in response to the actionUrl will be executed on the resumed call.",
|
927
2268
|
"type": "string",
|
928
|
-
"
|
2269
|
+
"format": "uri"
|
929
2270
|
},
|
930
2271
|
"notificationUrl": {
|
931
2272
|
"description": "URL to be invoked when the Call is parked. The request to the URL contains the standard request parameters.",
|
932
|
-
"type": "string"
|
2273
|
+
"type": "string",
|
2274
|
+
"format": "uri"
|
933
2275
|
}
|
934
2276
|
}
|
935
2277
|
}
|
@@ -937,8 +2279,6 @@
|
|
937
2279
|
},
|
938
2280
|
"Pause": {
|
939
2281
|
"description": "The `Pause` command halts execution of the current PerCL script for a specified number of milliseconds. If `Pause` is the first command in a PerCL document, FreeClimb will wait for the specified time to elapse before picking up the call.",
|
940
|
-
"x-percl-command": true,
|
941
|
-
"x-ref-properties": ["1"],
|
942
2282
|
"allOf": [
|
943
2283
|
{
|
944
2284
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -957,8 +2297,6 @@
|
|
957
2297
|
},
|
958
2298
|
"Play": {
|
959
2299
|
"description": "The `Play` command plays an audio file back to the caller. The audio file may be located at any location accessible via a URL. `Play` can exist as a stand-alone command or as a nested command. It does not allow barge-in unless nested within a `GetSpeech` command. The file will always be played to completion unless nested.",
|
960
|
-
"x-percl-command": true,
|
961
|
-
"x-ref-properties": ["\"TEST_STRING\"", "1", "false"],
|
962
2300
|
"allOf": [
|
963
2301
|
{
|
964
2302
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -985,8 +2323,6 @@
|
|
985
2323
|
},
|
986
2324
|
"PlayEarlyMedia": {
|
987
2325
|
"description": "`PlayEarlyMedia` is relevant only when present as the very first command in the PerCL script returned for an incoming Call. In such cases, the command is executed before FreeClimb attempts to connect the call. The audio file it uses can be stored in any location that is accessible via URL.",
|
988
|
-
"x-percl-command": true,
|
989
|
-
"x-ref-properties": ["\"TEST_STRING\""],
|
990
2326
|
"allOf": [
|
991
2327
|
{
|
992
2328
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1005,20 +2341,9 @@
|
|
1005
2341
|
},
|
1006
2342
|
"RecordUtterance": {
|
1007
2343
|
"description": "The `RecordUtterance` command records the caller's voice and returns the URL of a file containing the audio recording. `RecordUtterance` is blocking and is a terminal command. As such, the `actionUrl` property is required, and control of the Call picks up using the PerCL returned in response to the `actionUrl`. Recording information is returned in the `actionUrl` request.",
|
1008
|
-
"x-percl-command": true,
|
1009
|
-
"x-ref-properties": [
|
1010
|
-
"\"https://a.com\"",
|
1011
|
-
"1",
|
1012
|
-
"\"TEST_STRING\"",
|
1013
|
-
"1",
|
1014
|
-
"false",
|
1015
|
-
"false",
|
1016
|
-
"false"
|
1017
|
-
],
|
1018
2344
|
"allOf": [
|
1019
2345
|
{
|
1020
|
-
"$ref": "#/components/schemas/PerclCommand"
|
1021
|
-
"x-is-uri": true
|
2346
|
+
"$ref": "#/components/schemas/PerclCommand"
|
1022
2347
|
},
|
1023
2348
|
{
|
1024
2349
|
"required": ["actionUrl"],
|
@@ -1027,7 +2352,7 @@
|
|
1027
2352
|
"actionUrl": {
|
1028
2353
|
"description": "URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing.",
|
1029
2354
|
"type": "string",
|
1030
|
-
"
|
2355
|
+
"format": "uri"
|
1031
2356
|
},
|
1032
2357
|
"silenceTimeoutMs": {
|
1033
2358
|
"description": "Interval of silence that should elapse before ending the recording.",
|
@@ -1059,12 +2384,9 @@
|
|
1059
2384
|
},
|
1060
2385
|
"Redirect": {
|
1061
2386
|
"description": "The `Redirect` command transfers control of a Call to the PerCL at a different URL. `Redirect` is a terminal command, so any actions following it are never executed. The maximum number of redirections allowed during the life time of a Call is 256. This is intended to prevent a Call from possibly looping infinitely due to errors in PerCL being generated.",
|
1062
|
-
"x-percl-command": true,
|
1063
|
-
"x-ref-properties": ["\"https://a.com\""],
|
1064
2387
|
"allOf": [
|
1065
2388
|
{
|
1066
|
-
"$ref": "#/components/schemas/PerclCommand"
|
1067
|
-
"x-is-uri": true
|
2389
|
+
"$ref": "#/components/schemas/PerclCommand"
|
1068
2390
|
},
|
1069
2391
|
{
|
1070
2392
|
"required": ["actionUrl"],
|
@@ -1073,7 +2395,7 @@
|
|
1073
2395
|
"actionUrl": {
|
1074
2396
|
"description": "URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call.",
|
1075
2397
|
"type": "string",
|
1076
|
-
"
|
2398
|
+
"format": "uri"
|
1077
2399
|
}
|
1078
2400
|
}
|
1079
2401
|
}
|
@@ -1081,8 +2403,6 @@
|
|
1081
2403
|
},
|
1082
2404
|
"Reject": {
|
1083
2405
|
"description": "The `Reject` command blocks an incoming Call. Using `Reject` is the only way to prevent FreeClimb from answering a Call. Any other response will result in an answered Call and your account will be billed.",
|
1084
|
-
"x-percl-command": true,
|
1085
|
-
"x-ref-properties": ["\"TEST_STRING\""],
|
1086
2406
|
"allOf": [
|
1087
2407
|
{
|
1088
2408
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1100,8 +2420,6 @@
|
|
1100
2420
|
},
|
1101
2421
|
"RemoveFromConference": {
|
1102
2422
|
"description": "The `RemoveFromConference` command removes a Participant from a Conference but does not hang up. Instead, the Call is simply unbridged and what happens next with the Call is determined by the PerCL returned in response to the `leaveConferenceUrl` attribute.",
|
1103
|
-
"x-percl-command": true,
|
1104
|
-
"x-no-properties": true,
|
1105
2423
|
"allOf": [
|
1106
2424
|
{
|
1107
2425
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1115,13 +2433,6 @@
|
|
1115
2433
|
},
|
1116
2434
|
"Say": {
|
1117
2435
|
"description": "The `Say` command provides Text-To-Speech (TTS) support. It converts text to speech and then renders it in a female voice back to the caller. `Say` is useful in cases where it's difficult to pre-record a prompt for any reason. `Say` does not allow barge-in unless nested within a `GetSpeech` command. The file will always be played to completion unless nested.",
|
1118
|
-
"x-percl-command": true,
|
1119
|
-
"x-ref-properties": [
|
1120
|
-
"\"TEST_STRING\"",
|
1121
|
-
"\"TEST_STRING\"",
|
1122
|
-
"1",
|
1123
|
-
"false"
|
1124
|
-
],
|
1125
2436
|
"allOf": [
|
1126
2437
|
{
|
1127
2438
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1153,8 +2464,6 @@
|
|
1153
2464
|
},
|
1154
2465
|
"SendDigits": {
|
1155
2466
|
"description": "The `SendDigits` command plays DTMF tones on a live Call. This is useful for navigating through IVR menus or dialing extensions.",
|
1156
|
-
"x-percl-command": true,
|
1157
|
-
"x-ref-properties": ["\"TEST_STRING\"", "1", "false"],
|
1158
2467
|
"allOf": [
|
1159
2468
|
{
|
1160
2469
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1181,8 +2490,6 @@
|
|
1181
2490
|
},
|
1182
2491
|
"SetListen": {
|
1183
2492
|
"description": "The `SetListen` command enables or disables the listen privilege for this Conference Participant. The Participant can hear what the other participants are saying only if this privilege is enabled.",
|
1184
|
-
"x-percl-command": true,
|
1185
|
-
"x-ref-properties": ["false"],
|
1186
2493
|
"allOf": [
|
1187
2494
|
{
|
1188
2495
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1201,8 +2508,6 @@
|
|
1201
2508
|
},
|
1202
2509
|
"SetTalk": {
|
1203
2510
|
"description": "The `SetTalk` command enables or disables the talk privilege for this Conference Participant. If 'true', no audio from that Participant is shared with the other Participants of the Conference.",
|
1204
|
-
"x-percl-command": true,
|
1205
|
-
"x-ref-properties": ["false"],
|
1206
2511
|
"allOf": [
|
1207
2512
|
{
|
1208
2513
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1221,8 +2526,6 @@
|
|
1221
2526
|
},
|
1222
2527
|
"SetDTMFPassThrough": {
|
1223
2528
|
"description": "The `SetDTMFPassThrough` command enables or disables the dtmfPassThrough privilege for this Conference Participant. If 'true', DTMFs will be passed through from this Participant to all other Participants in the Conference",
|
1224
|
-
"x-percl-command": true,
|
1225
|
-
"x-ref-properties": ["false"],
|
1226
2529
|
"allOf": [
|
1227
2530
|
{
|
1228
2531
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1241,12 +2544,6 @@
|
|
1241
2544
|
},
|
1242
2545
|
"Sms": {
|
1243
2546
|
"description": "The `Sms` command can be used to send an SMS message to a phone number during a phone call. International SMS is disabled by default.",
|
1244
|
-
"x-percl-command": true,
|
1245
|
-
"x-ref-properties": [
|
1246
|
-
"\"TEST_STRING\"",
|
1247
|
-
"\"TEST_STRING\"",
|
1248
|
-
"\"TEST_STRING\""
|
1249
|
-
],
|
1250
2547
|
"allOf": [
|
1251
2548
|
{
|
1252
2549
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1269,7 +2566,8 @@
|
|
1269
2566
|
},
|
1270
2567
|
"notificationUrl": {
|
1271
2568
|
"description": "When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters. This is a notification only; any PerCL returned will be ignored.",
|
1272
|
-
"type": "string"
|
2569
|
+
"type": "string",
|
2570
|
+
"format": "uri"
|
1273
2571
|
}
|
1274
2572
|
}
|
1275
2573
|
}
|
@@ -1277,8 +2575,6 @@
|
|
1277
2575
|
},
|
1278
2576
|
"StartRecordCall": {
|
1279
2577
|
"description": "The `StartRecordCall` command records the current call and returns the URL of a file containing the audio recording when recording completes. `StartRecordCall` is non-blocking. After recording of the current call begins, control of the call moves to the PerCL command that follows `StartRecordCall` in the current PerCL script.",
|
1280
|
-
"x-percl-command": true,
|
1281
|
-
"x-no-properties": true,
|
1282
2578
|
"allOf": [
|
1283
2579
|
{
|
1284
2580
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1290,8 +2586,6 @@
|
|
1290
2586
|
},
|
1291
2587
|
"TerminateConference": {
|
1292
2588
|
"description": "The `TerminateConference` command terminates an existing Conference. Any active participants are hung up on by FreeClimb. If this is not the desired behavior, use the `RemoveFromConference` command to unbridge Calls that should not be hung up. Note: The Call requesting TerminateConference must be on the same Conference for this command to execute.",
|
1293
|
-
"x-percl-command": true,
|
1294
|
-
"x-no-properties": true,
|
1295
2589
|
"allOf": [
|
1296
2590
|
{
|
1297
2591
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1305,8 +2599,6 @@
|
|
1305
2599
|
},
|
1306
2600
|
"Unpark": {
|
1307
2601
|
"description": "The `Unpark` command resumes a parked call. Execution continues with the first command in the PerCL scripted returned by the actionUrl specified in the Park command as long as the call is still in progress. If the call is no longer in progress, any returned PerCL will not be executed. Unpark is a terminal command -- any commands following it in the same script are not executed.",
|
1308
|
-
"x-percl-command": true,
|
1309
|
-
"x-no-properties": true,
|
1310
2602
|
"allOf": [
|
1311
2603
|
{
|
1312
2604
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -1381,8 +2673,6 @@
|
|
1381
2673
|
"description": "Details for which features this number may be used.",
|
1382
2674
|
"type": "object",
|
1383
2675
|
"required": ["voice", "sms", "tollFree", "tenDLC", "shortCode"],
|
1384
|
-
"x-is-object": true,
|
1385
|
-
"x-ref-properties": [false, false, false, false, false],
|
1386
2676
|
"properties": {
|
1387
2677
|
"voice": {
|
1388
2678
|
"description": "Indicates whether a number can be used for voice calls. Replaces voiceEnabled.",
|
@@ -1415,8 +2705,6 @@
|
|
1415
2705
|
"description": "TollFree Campaign details for this number",
|
1416
2706
|
"type": "object",
|
1417
2707
|
"required": ["campaignId"],
|
1418
|
-
"x-is-object": true,
|
1419
|
-
"x-ref-properties": ["\"TEST_STRING\""],
|
1420
2708
|
"properties": {
|
1421
2709
|
"campaignId": {
|
1422
2710
|
"description": "alphanumeric identifier for the TollFree campaign associated with this number",
|
@@ -1506,31 +2794,37 @@
|
|
1506
2794
|
"voiceUrl": {
|
1507
2795
|
"type": "string",
|
1508
2796
|
"description": "The URL FreeClimb will request when a phone number assigned to this Application receives a Call. Used for inbound calls only.",
|
2797
|
+
"format": "uri",
|
1509
2798
|
"nullable": true
|
1510
2799
|
},
|
1511
2800
|
"voiceFallbackUrl": {
|
1512
2801
|
"type": "string",
|
1513
2802
|
"description": "The URL that FreeClimb will request if it times out waiting for a response from the voiceUrl. Used for inbound calls only.",
|
2803
|
+
"format": "uri",
|
1514
2804
|
"nullable": true
|
1515
2805
|
},
|
1516
2806
|
"callConnectUrl": {
|
1517
2807
|
"type": "string",
|
1518
2808
|
"description": "The URL to which FreeClimb will make a POST request informing the result of the outbound Call request. The status property of the request message specifies if the Call was connected or not.",
|
2809
|
+
"format": "uri",
|
1519
2810
|
"nullable": true
|
1520
2811
|
},
|
1521
2812
|
"statusCallbackUrl": {
|
1522
2813
|
"type": "string",
|
1523
2814
|
"description": "A URL to which FreeClimb will make a POST request when the Call ends to notify this app.",
|
2815
|
+
"format": "uri",
|
1524
2816
|
"nullable": true
|
1525
2817
|
},
|
1526
2818
|
"smsUrl": {
|
1527
2819
|
"type": "string",
|
1528
2820
|
"description": "The URL FreeClimb will request when a phone number assigned to this Application receives an incoming SMS message. Used for inbound SMS only.",
|
2821
|
+
"format": "uri",
|
1529
2822
|
"nullable": true
|
1530
2823
|
},
|
1531
2824
|
"smsFallbackUrl": {
|
1532
2825
|
"type": "string",
|
1533
2826
|
"description": "The URL that FreeClimb will request if it times out waiting for a response from the smsUrl. Used for inbound SMS only.",
|
2827
|
+
"format": "uri",
|
1534
2828
|
"nullable": true
|
1535
2829
|
}
|
1536
2830
|
}
|
@@ -1547,37 +2841,42 @@
|
|
1547
2841
|
"voiceUrl": {
|
1548
2842
|
"type": "string",
|
1549
2843
|
"description": "The URL that FreeClimb will request when an inbound call arrives on a phone number assigned to this application. Used only for inbound calls.",
|
2844
|
+
"format": "uri",
|
1550
2845
|
"nullable": true
|
1551
2846
|
},
|
1552
2847
|
"voiceFallbackUrl": {
|
1553
2848
|
"type": "string",
|
1554
2849
|
"description": "The URL that FreeClimb will request if it times out waiting for a response from the voiceUrl. Used for inbound calls only. Note: A PerCL response is expected to control the inbound call.",
|
2850
|
+
"format": "uri",
|
1555
2851
|
"nullable": true
|
1556
2852
|
},
|
1557
2853
|
"callConnectUrl": {
|
1558
2854
|
"type": "string",
|
1559
2855
|
"description": "The URL that FreeClimb will request when an outbound call request is complete. Used for outbound calls only. Note: A PerCL response is expected if the outbound call is connected (status=InProgress) to control the call.",
|
2856
|
+
"format": "uri",
|
1560
2857
|
"nullable": true
|
1561
2858
|
},
|
1562
2859
|
"statusCallbackUrl": {
|
1563
2860
|
"type": "string",
|
1564
2861
|
"description": "The URL that FreeClimb will request to pass call status (such as call ended) to the application. Note: This is a notification only; any PerCL returned will be ignored.",
|
2862
|
+
"format": "uri",
|
1565
2863
|
"nullable": true
|
1566
2864
|
},
|
1567
2865
|
"smsUrl": {
|
1568
2866
|
"type": "string",
|
1569
2867
|
"description": "The URL that FreeClimb will request when a phone number assigned to this application receives an incoming SMS message. Used for inbound SMS only. Note: Any PerCL returned will be ignored.",
|
2868
|
+
"format": "uri",
|
1570
2869
|
"nullable": true
|
1571
2870
|
},
|
1572
2871
|
"smsFallbackUrl": {
|
1573
2872
|
"type": "string",
|
1574
2873
|
"description": "The URL that FreeClimb will request if it times out waiting for a response from the smsUrl. Used for inbound SMS only. Note: Any PerCL returned will be ignored.",
|
2874
|
+
"format": "uri",
|
1575
2875
|
"nullable": true
|
1576
2876
|
}
|
1577
2877
|
}
|
1578
2878
|
},
|
1579
2879
|
"ApplicationList": {
|
1580
|
-
"x-implements": "Pagination",
|
1581
2880
|
"allOf": [
|
1582
2881
|
{
|
1583
2882
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -1590,8 +2889,7 @@
|
|
1590
2889
|
"items": {
|
1591
2890
|
"$ref": "#/components/schemas/ApplicationResult"
|
1592
2891
|
},
|
1593
|
-
"nullable": true
|
1594
|
-
"x-is-list": true
|
2892
|
+
"nullable": true
|
1595
2893
|
}
|
1596
2894
|
}
|
1597
2895
|
}
|
@@ -1638,7 +2936,6 @@
|
|
1638
2936
|
}
|
1639
2937
|
},
|
1640
2938
|
"AvailableNumberList": {
|
1641
|
-
"x-implements": "Pagination",
|
1642
2939
|
"allOf": [
|
1643
2940
|
{
|
1644
2941
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -1651,8 +2948,7 @@
|
|
1651
2948
|
"items": {
|
1652
2949
|
"$ref": "#/components/schemas/AvailableNumber"
|
1653
2950
|
},
|
1654
|
-
"nullable": true
|
1655
|
-
"x-is-list": true
|
2951
|
+
"nullable": true
|
1656
2952
|
}
|
1657
2953
|
}
|
1658
2954
|
}
|
@@ -1753,7 +3049,6 @@
|
|
1753
3049
|
}
|
1754
3050
|
},
|
1755
3051
|
"IncomingNumberList": {
|
1756
|
-
"x-implements": "Pagination",
|
1757
3052
|
"allOf": [
|
1758
3053
|
{
|
1759
3054
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -1766,8 +3061,7 @@
|
|
1766
3061
|
"items": {
|
1767
3062
|
"$ref": "#/components/schemas/IncomingNumberResult"
|
1768
3063
|
},
|
1769
|
-
"nullable": true
|
1770
|
-
"x-is-list": true
|
3064
|
+
"nullable": true
|
1771
3065
|
}
|
1772
3066
|
}
|
1773
3067
|
}
|
@@ -1912,7 +3206,8 @@
|
|
1912
3206
|
},
|
1913
3207
|
"ifMachineUrl": {
|
1914
3208
|
"type": "string",
|
1915
|
-
"description": "This attribute specifies a URL to which FreeClimb will make a POST request when an answering machine or a fax machine is detected. This URL is required if the ifMachine flag is set to redirect. When ifMachine is set to hangup, ifMachineUrl must not be included in the request. For more information, see **ifMachineUrl example** below."
|
3209
|
+
"description": "This attribute specifies a URL to which FreeClimb will make a POST request when an answering machine or a fax machine is detected. This URL is required if the ifMachine flag is set to redirect. When ifMachine is set to hangup, ifMachineUrl must not be included in the request. For more information, see **ifMachineUrl example** below.",
|
3210
|
+
"format": "uri"
|
1916
3211
|
},
|
1917
3212
|
"timeout": {
|
1918
3213
|
"type": "integer",
|
@@ -1930,12 +3225,12 @@
|
|
1930
3225
|
},
|
1931
3226
|
"callConnectUrl": {
|
1932
3227
|
"type": "string",
|
1933
|
-
"description": "The URL that FreeClimb should use to handle this phone call. If an applicationId or parentCallId have already been provided, this callConnectUrl attribute will be used as a replacement of the callConnectUrl originally assigned in the application or parent call."
|
3228
|
+
"description": "The URL that FreeClimb should use to handle this phone call. If an applicationId or parentCallId have already been provided, this callConnectUrl attribute will be used as a replacement of the callConnectUrl originally assigned in the application or parent call.",
|
3229
|
+
"format": "uri"
|
1934
3230
|
}
|
1935
3231
|
}
|
1936
3232
|
},
|
1937
3233
|
"CallList": {
|
1938
|
-
"x-implements": "Pagination",
|
1939
3234
|
"allOf": [
|
1940
3235
|
{
|
1941
3236
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -1948,8 +3243,7 @@
|
|
1948
3243
|
"items": {
|
1949
3244
|
"$ref": "#/components/schemas/CallResult"
|
1950
3245
|
},
|
1951
|
-
"nullable": true
|
1952
|
-
"x-is-list": true
|
3246
|
+
"nullable": true
|
1953
3247
|
}
|
1954
3248
|
}
|
1955
3249
|
}
|
@@ -1993,7 +3287,6 @@
|
|
1993
3287
|
]
|
1994
3288
|
},
|
1995
3289
|
"RecordingList": {
|
1996
|
-
"x-implements": "Pagination",
|
1997
3290
|
"allOf": [
|
1998
3291
|
{
|
1999
3292
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -2006,8 +3299,7 @@
|
|
2006
3299
|
"items": {
|
2007
3300
|
"$ref": "#/components/schemas/RecordingResult"
|
2008
3301
|
},
|
2009
|
-
"nullable": true
|
2010
|
-
"x-is-list": true
|
3302
|
+
"nullable": true
|
2011
3303
|
}
|
2012
3304
|
}
|
2013
3305
|
}
|
@@ -2052,7 +3344,6 @@
|
|
2052
3344
|
}
|
2053
3345
|
},
|
2054
3346
|
"LogList": {
|
2055
|
-
"x-implements": "Pagination",
|
2056
3347
|
"allOf": [
|
2057
3348
|
{
|
2058
3349
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -2065,8 +3356,7 @@
|
|
2065
3356
|
"items": {
|
2066
3357
|
"$ref": "#/components/schemas/LogResult"
|
2067
3358
|
},
|
2068
|
-
"nullable": true
|
2069
|
-
"x-is-list": true
|
3359
|
+
"nullable": true
|
2070
3360
|
}
|
2071
3361
|
}
|
2072
3362
|
}
|
@@ -2110,16 +3400,19 @@
|
|
2110
3400
|
"waitUrl": {
|
2111
3401
|
"type": "string",
|
2112
3402
|
"description": "URL referencing the audio file to be used as default wait music for the Conference when it is in the populated state.",
|
3403
|
+
"format": "uri",
|
2113
3404
|
"nullable": true
|
2114
3405
|
},
|
2115
3406
|
"actionUrl": {
|
2116
3407
|
"type": "string",
|
2117
3408
|
"description": "URL invoked once the Conference is successfully created.",
|
3409
|
+
"format": "uri",
|
2118
3410
|
"nullable": true
|
2119
3411
|
},
|
2120
3412
|
"statusCallbackUrl": {
|
2121
3413
|
"type": "string",
|
2122
3414
|
"description": "URL to inform that the Conference status has changed.",
|
3415
|
+
"format": "uri",
|
2123
3416
|
"nullable": true
|
2124
3417
|
},
|
2125
3418
|
"subresourceUris": {
|
@@ -2132,7 +3425,6 @@
|
|
2132
3425
|
]
|
2133
3426
|
},
|
2134
3427
|
"MessagesList": {
|
2135
|
-
"x-implements": "Pagination",
|
2136
3428
|
"allOf": [
|
2137
3429
|
{
|
2138
3430
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -2146,8 +3438,7 @@
|
|
2146
3438
|
"items": {
|
2147
3439
|
"$ref": "#/components/schemas/MessageResult"
|
2148
3440
|
},
|
2149
|
-
"nullable": true
|
2150
|
-
"x-is-list": true
|
3441
|
+
"nullable": true
|
2151
3442
|
}
|
2152
3443
|
}
|
2153
3444
|
}
|
@@ -2176,12 +3467,12 @@
|
|
2176
3467
|
},
|
2177
3468
|
"notificationUrl": {
|
2178
3469
|
"type": "string",
|
2179
|
-
"description": "When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored."
|
3470
|
+
"description": "When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters. **Note:** This is a notification only; any PerCL returned is ignored.",
|
3471
|
+
"format": "uri"
|
2180
3472
|
},
|
2181
3473
|
"mediaUrls": {
|
2182
3474
|
"type": "array",
|
2183
3475
|
"description": "an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile.",
|
2184
|
-
"x-is-list": true,
|
2185
3476
|
"items": {
|
2186
3477
|
"type": "string",
|
2187
3478
|
"format": "uri"
|
@@ -2206,26 +3497,17 @@
|
|
2206
3497
|
"CompletionResult": {
|
2207
3498
|
"type": "object",
|
2208
3499
|
"required": ["response", "status"],
|
2209
|
-
"x-completion-result": true,
|
2210
3500
|
"properties": {
|
2211
3501
|
"response": {
|
2212
3502
|
"type": "string",
|
2213
3503
|
"description": "The generative response from the KnowledgeBase"
|
2214
3504
|
},
|
2215
3505
|
"status": {
|
2216
|
-
"
|
2217
|
-
"x-has-writer": true,
|
2218
|
-
"description": "Completion result status. Possible values: success, no_context",
|
2219
|
-
"x-enum-type": "CompletionResultStatusEnum",
|
2220
|
-
"x-enum-type-c-sharp": "StatusEnum",
|
2221
|
-
"enum": ["success", "no_context"],
|
2222
|
-
"x-enum-varnames": ["SUCCESS", "NO_CONTEXT"],
|
2223
|
-
"x-enum-varnames-values": ["success", "no_context"]
|
3506
|
+
"$ref": "#/components/schemas/CompletionResultStatus"
|
2224
3507
|
}
|
2225
3508
|
}
|
2226
3509
|
},
|
2227
3510
|
"ConferenceList": {
|
2228
|
-
"x-implements": "Pagination",
|
2229
3511
|
"allOf": [
|
2230
3512
|
{
|
2231
3513
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -2238,8 +3520,7 @@
|
|
2238
3520
|
"items": {
|
2239
3521
|
"$ref": "#/components/schemas/ConferenceResult"
|
2240
3522
|
},
|
2241
|
-
"nullable": true
|
2242
|
-
"x-is-list": true
|
3523
|
+
"nullable": true
|
2243
3524
|
}
|
2244
3525
|
}
|
2245
3526
|
}
|
@@ -2289,6 +3570,7 @@
|
|
2289
3570
|
"notificationUrl": {
|
2290
3571
|
"type": "string",
|
2291
3572
|
"description": "URL invoked when message sent",
|
3573
|
+
"format": "uri",
|
2292
3574
|
"nullable": true
|
2293
3575
|
},
|
2294
3576
|
"brandId": {
|
@@ -2309,7 +3591,6 @@
|
|
2309
3591
|
"mediaUrls": {
|
2310
3592
|
"type": "array",
|
2311
3593
|
"description": "an array of HTTP URLs which were attached this this message",
|
2312
|
-
"x-is-list": true,
|
2313
3594
|
"items": {
|
2314
3595
|
"type": "string",
|
2315
3596
|
"format": "uri"
|
@@ -2336,11 +3617,13 @@
|
|
2336
3617
|
},
|
2337
3618
|
"waitUrl": {
|
2338
3619
|
"type": "string",
|
2339
|
-
"description": "If specified, a URL for the audio file that provides custom hold music for the Conference when it is in the populated state. Otherwise, FreeClimb uses a system default audio file. This is always fetched using HTTP GET and is fetched just once — when the Conference is created."
|
3620
|
+
"description": "If specified, a URL for the audio file that provides custom hold music for the Conference when it is in the populated state. Otherwise, FreeClimb uses a system default audio file. This is always fetched using HTTP GET and is fetched just once — when the Conference is created.",
|
3621
|
+
"format": "uri"
|
2340
3622
|
},
|
2341
3623
|
"statusCallbackUrl": {
|
2342
3624
|
"type": "string",
|
2343
|
-
"description": "This URL is invoked when the status of the Conference changes. For more information, see **statusCallbackUrl** (below)."
|
3625
|
+
"description": "This URL is invoked when the status of the Conference changes. For more information, see **statusCallbackUrl** (below).",
|
3626
|
+
"format": "uri"
|
2344
3627
|
}
|
2345
3628
|
}
|
2346
3629
|
},
|
@@ -2424,7 +3707,6 @@
|
|
2424
3707
|
}
|
2425
3708
|
},
|
2426
3709
|
"ConferenceParticipantList": {
|
2427
|
-
"x-implements": "Pagination",
|
2428
3710
|
"allOf": [
|
2429
3711
|
{
|
2430
3712
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -2437,8 +3719,7 @@
|
|
2437
3719
|
"items": {
|
2438
3720
|
"$ref": "#/components/schemas/ConferenceParticipantResult"
|
2439
3721
|
},
|
2440
|
-
"nullable": true
|
2441
|
-
"x-is-list": true
|
3722
|
+
"nullable": true
|
2442
3723
|
}
|
2443
3724
|
}
|
2444
3725
|
}
|
@@ -2507,7 +3788,6 @@
|
|
2507
3788
|
}
|
2508
3789
|
},
|
2509
3790
|
"QueueList": {
|
2510
|
-
"x-implements": "Pagination",
|
2511
3791
|
"allOf": [
|
2512
3792
|
{
|
2513
3793
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -2520,8 +3800,7 @@
|
|
2520
3800
|
"items": {
|
2521
3801
|
"$ref": "#/components/schemas/QueueResult"
|
2522
3802
|
},
|
2523
|
-
"nullable": true
|
2524
|
-
"x-is-list": true
|
3803
|
+
"nullable": true
|
2525
3804
|
}
|
2526
3805
|
}
|
2527
3806
|
}
|
@@ -2558,7 +3837,6 @@
|
|
2558
3837
|
}
|
2559
3838
|
},
|
2560
3839
|
"QueueMemberList": {
|
2561
|
-
"x-implements": "Pagination",
|
2562
3840
|
"allOf": [
|
2563
3841
|
{
|
2564
3842
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -2571,8 +3849,7 @@
|
|
2571
3849
|
"items": {
|
2572
3850
|
"$ref": "#/components/schemas/QueueMember"
|
2573
3851
|
},
|
2574
|
-
"nullable": true
|
2575
|
-
"x-is-list": true
|
3852
|
+
"nullable": true
|
2576
3853
|
}
|
2577
3854
|
}
|
2578
3855
|
}
|
@@ -2589,7 +3866,6 @@
|
|
2589
3866
|
}
|
2590
3867
|
},
|
2591
3868
|
"SMSTenDLCCampaignsListResult": {
|
2592
|
-
"x-implements": "Pagination",
|
2593
3869
|
"allOf": [
|
2594
3870
|
{
|
2595
3871
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -2602,8 +3878,7 @@
|
|
2602
3878
|
"items": {
|
2603
3879
|
"$ref": "#/components/schemas/SMSTenDLCCampaign"
|
2604
3880
|
},
|
2605
|
-
"nullable": true
|
2606
|
-
"x-is-list": true
|
3881
|
+
"nullable": true
|
2607
3882
|
}
|
2608
3883
|
}
|
2609
3884
|
}
|
@@ -2641,19 +3916,12 @@
|
|
2641
3916
|
"description": "Alphanumeric identifier of the reseller that you want to associate with this campaign."
|
2642
3917
|
},
|
2643
3918
|
"status": {
|
2644
|
-
"
|
2645
|
-
"x-has-writer": true,
|
2646
|
-
"description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
|
2647
|
-
"x-enum-type": "SMSTenDLCCampaignStatusEnum",
|
2648
|
-
"x-enum-type-c-sharp": "StatusEnum",
|
2649
|
-
"enum": ["ACTIVE", "EXPIRED"],
|
2650
|
-
"x-enum-varnames": ["ACTIVE", "EXPIRED"]
|
3919
|
+
"$ref": "#/components/schemas/SMSTenDLCCampaignStatus"
|
2651
3920
|
},
|
2652
3921
|
"createDate": {
|
2653
3922
|
"type": "string",
|
2654
3923
|
"description": "Unix timestamp when campaign was created.",
|
2655
|
-
"format": "date-time"
|
2656
|
-
"x-is-date-time": true
|
3924
|
+
"format": "date-time"
|
2657
3925
|
},
|
2658
3926
|
"autoRenewal": {
|
2659
3927
|
"type": "boolean",
|
@@ -2663,7 +3931,6 @@
|
|
2663
3931
|
"type": "string",
|
2664
3932
|
"description": "Campaign recent billed date.",
|
2665
3933
|
"format": "date-time",
|
2666
|
-
"x-is-date-time": true,
|
2667
3934
|
"nullable": true
|
2668
3935
|
},
|
2669
3936
|
"brandId": {
|
@@ -2678,7 +3945,6 @@
|
|
2678
3945
|
},
|
2679
3946
|
"subUsecases": {
|
2680
3947
|
"uniqueItems": true,
|
2681
|
-
"x-is-set": true,
|
2682
3948
|
"type": "array",
|
2683
3949
|
"description": "Campaign sub-usecases. Must be of defined valid sub-usecase types. Use `/registry/enum/usecase` operation to retrieve list of valid sub-usecases",
|
2684
3950
|
"items": {
|
@@ -2813,7 +4079,6 @@
|
|
2813
4079
|
"nullable": true,
|
2814
4080
|
"description": "When the campaign would be due for its next renew/bill date.",
|
2815
4081
|
"format": "date",
|
2816
|
-
"x-is-date": true,
|
2817
4082
|
"example": "2000-01-01"
|
2818
4083
|
}
|
2819
4084
|
},
|
@@ -2852,7 +4117,6 @@
|
|
2852
4117
|
}
|
2853
4118
|
},
|
2854
4119
|
"SMSTenDLCPartnerCampaignsListResult": {
|
2855
|
-
"x-implements": "Pagination",
|
2856
4120
|
"allOf": [
|
2857
4121
|
{
|
2858
4122
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -2865,8 +4129,7 @@
|
|
2865
4129
|
"items": {
|
2866
4130
|
"$ref": "#/components/schemas/SMSTenDLCPartnerCampaign"
|
2867
4131
|
},
|
2868
|
-
"nullable": true
|
2869
|
-
"x-is-list": true
|
4132
|
+
"nullable": true
|
2870
4133
|
}
|
2871
4134
|
}
|
2872
4135
|
}
|
@@ -2886,19 +4149,12 @@
|
|
2886
4149
|
"description": "Alphanumeric identifier assigned by the registry for a campaign. This identifier is required by the NetNumber OSR SMS enabling process of 10DLC."
|
2887
4150
|
},
|
2888
4151
|
"status": {
|
2889
|
-
"
|
2890
|
-
"x-has-writer": true,
|
2891
|
-
"description": "Current campaign status. Possible values: ACTIVE, EXPIRED. A newly created campaign defaults to ACTIVE status. ",
|
2892
|
-
"x-enum-type": "SMSTenDLCPartnerCampaignStatusEnum",
|
2893
|
-
"x-enum-type-c-sharp": "StatusEnum",
|
2894
|
-
"enum": ["ACTIVE", "EXPIRED"],
|
2895
|
-
"x-enum-varnames": ["ACTIVE", "EXPIRED"]
|
4152
|
+
"$ref": "#/components/schemas/SMSTenDLCPartnerCampaignStatus"
|
2896
4153
|
},
|
2897
4154
|
"createDate": {
|
2898
4155
|
"type": "string",
|
2899
4156
|
"description": "Unix timestamp when campaign was created.",
|
2900
|
-
"format": "date-time"
|
2901
|
-
"x-is-date-time": true
|
4157
|
+
"format": "date-time"
|
2902
4158
|
},
|
2903
4159
|
"brandId": {
|
2904
4160
|
"maxLength": 8,
|
@@ -3023,8 +4279,7 @@
|
|
3023
4279
|
"description": "Subscriber opt-out message."
|
3024
4280
|
},
|
3025
4281
|
"brand": {
|
3026
|
-
"$ref": "#/components/schemas/SMSTenDLCPartnerCampaignBrand"
|
3027
|
-
"x-partner-campaign-brand": true
|
4282
|
+
"$ref": "#/components/schemas/SMSTenDLCPartnerCampaignBrand"
|
3028
4283
|
}
|
3029
4284
|
},
|
3030
4285
|
"example": {
|
@@ -3073,20 +4328,6 @@
|
|
3073
4328
|
"SMSTenDLCPartnerCampaignBrand": {
|
3074
4329
|
"required": ["email", "phone"],
|
3075
4330
|
"type": "object",
|
3076
|
-
"x-is-object": true,
|
3077
|
-
"x-sms-ten-dlc-partner-campaign-brand": true,
|
3078
|
-
"x-ref-properties": [
|
3079
|
-
"\"TEST_STRING\"",
|
3080
|
-
"\"TEST_STRING\"",
|
3081
|
-
"\"TEST_STRING\"",
|
3082
|
-
"\"TEST_STRING\"",
|
3083
|
-
"\"TEST_STRING\"",
|
3084
|
-
"\"TEST_STRING\"",
|
3085
|
-
"\"TEST_STRING\"",
|
3086
|
-
"\"TEST_STRING\"",
|
3087
|
-
"new Dictionary<string, object>()",
|
3088
|
-
"1"
|
3089
|
-
],
|
3090
4331
|
"properties": {
|
3091
4332
|
"accountId": {
|
3092
4333
|
"type": "string",
|
@@ -3140,14 +4381,7 @@
|
|
3140
4381
|
"example": "http://www.abcmobile.com"
|
3141
4382
|
},
|
3142
4383
|
"optionalAttributes": {
|
3143
|
-
"
|
3144
|
-
"type": "object",
|
3145
|
-
"x-is-hash": true,
|
3146
|
-
"additionalProperties": {
|
3147
|
-
"type": "object",
|
3148
|
-
"description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names."
|
3149
|
-
},
|
3150
|
-
"description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names."
|
4384
|
+
"$ref": "#/components/schemas/SMSTenDLCOptionalAttributes"
|
3151
4385
|
},
|
3152
4386
|
"evpVettingScore": {
|
3153
4387
|
"type": "integer",
|
@@ -3156,7 +4390,6 @@
|
|
3156
4390
|
}
|
3157
4391
|
},
|
3158
4392
|
"SMSTenDLCBrandsListResult": {
|
3159
|
-
"x-implements": "Pagination",
|
3160
4393
|
"allOf": [
|
3161
4394
|
{
|
3162
4395
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -3169,8 +4402,7 @@
|
|
3169
4402
|
"items": {
|
3170
4403
|
"$ref": "#/components/schemas/SMSTenDLCBrand"
|
3171
4404
|
},
|
3172
|
-
"nullable": true
|
3173
|
-
"x-is-list": true
|
4405
|
+
"nullable": true
|
3174
4406
|
}
|
3175
4407
|
}
|
3176
4408
|
}
|
@@ -3189,7 +4421,6 @@
|
|
3189
4421
|
"vertical"
|
3190
4422
|
],
|
3191
4423
|
"type": "object",
|
3192
|
-
"x-sms-ten-dlc-brand": true,
|
3193
4424
|
"properties": {
|
3194
4425
|
"accountId": {
|
3195
4426
|
"type": "string",
|
@@ -3197,26 +4428,7 @@
|
|
3197
4428
|
"nullable": true
|
3198
4429
|
},
|
3199
4430
|
"entityType": {
|
3200
|
-
"
|
3201
|
-
"type": "string",
|
3202
|
-
"x-has-writer": true,
|
3203
|
-
"description": "Entity type behind the brand. This is the form of business establishment.",
|
3204
|
-
"x-enum-type": "SMSTenDLCBrandEntityTypeEnum",
|
3205
|
-
"x-enum-type-c-sharp": "EntityTypeEnum",
|
3206
|
-
"enum": [
|
3207
|
-
"PRIVATE_PROFIT",
|
3208
|
-
"PUBLIC_PROFIT",
|
3209
|
-
"NON_PROFIT",
|
3210
|
-
"GOVERNMENT",
|
3211
|
-
"SOLE_PROPRIETOR"
|
3212
|
-
],
|
3213
|
-
"x-enum-varnames": [
|
3214
|
-
"PRIVATE_PROFIT",
|
3215
|
-
"PUBLIC_PROFIT",
|
3216
|
-
"NON_PROFIT",
|
3217
|
-
"GOVERNMENT",
|
3218
|
-
"SOLE_PROPRIETOR"
|
3219
|
-
]
|
4431
|
+
"$ref": "#/components/schemas/SMSTenDLCBrandEntityType"
|
3220
4432
|
},
|
3221
4433
|
"cspId": {
|
3222
4434
|
"type": "string",
|
@@ -3312,70 +4524,7 @@
|
|
3312
4524
|
"example": "ABC"
|
3313
4525
|
},
|
3314
4526
|
"stockExchange": {
|
3315
|
-
"
|
3316
|
-
"x-has-writer": true,
|
3317
|
-
"description": "(Required for public company) stock exchange.",
|
3318
|
-
"example": "NASDAQ",
|
3319
|
-
"x-enum-type": "SMSTenDLCBrandStockExchangeEnum",
|
3320
|
-
"x-enum-type-c-sharp": "StockExchangeEnum",
|
3321
|
-
"enum": [
|
3322
|
-
"NONE",
|
3323
|
-
"NASDAQ",
|
3324
|
-
"NYSE",
|
3325
|
-
"AMEX",
|
3326
|
-
"AMX",
|
3327
|
-
"ASX",
|
3328
|
-
"B3",
|
3329
|
-
"BME",
|
3330
|
-
"BSE",
|
3331
|
-
"FRA",
|
3332
|
-
"ICEX",
|
3333
|
-
"JPX",
|
3334
|
-
"JSE",
|
3335
|
-
"KRX",
|
3336
|
-
"LON",
|
3337
|
-
"NSE",
|
3338
|
-
"OMX",
|
3339
|
-
"SEHK",
|
3340
|
-
"SGX",
|
3341
|
-
"SSE",
|
3342
|
-
"STO",
|
3343
|
-
"SWX",
|
3344
|
-
"SZSE",
|
3345
|
-
"TSX",
|
3346
|
-
"TWSE",
|
3347
|
-
"VSE",
|
3348
|
-
"OTHER"
|
3349
|
-
],
|
3350
|
-
"x-enum-varnames": [
|
3351
|
-
"NONE",
|
3352
|
-
"NASDAQ",
|
3353
|
-
"NYSE",
|
3354
|
-
"AMEX",
|
3355
|
-
"AMX",
|
3356
|
-
"ASX",
|
3357
|
-
"B3",
|
3358
|
-
"BME",
|
3359
|
-
"BSE",
|
3360
|
-
"FRA",
|
3361
|
-
"ICEX",
|
3362
|
-
"JPX",
|
3363
|
-
"JSE",
|
3364
|
-
"KRX",
|
3365
|
-
"LON",
|
3366
|
-
"NSE",
|
3367
|
-
"OMX",
|
3368
|
-
"SEHK",
|
3369
|
-
"SGX",
|
3370
|
-
"SSE",
|
3371
|
-
"STO",
|
3372
|
-
"SWX",
|
3373
|
-
"SZSE",
|
3374
|
-
"TSX",
|
3375
|
-
"TWSE",
|
3376
|
-
"VSE",
|
3377
|
-
"OTHER"
|
3378
|
-
]
|
4527
|
+
"$ref": "#/components/schemas/SMSTenDLCBrandStockExchange"
|
3379
4528
|
},
|
3380
4529
|
"ipAddress": {
|
3381
4530
|
"maxLength": 50,
|
@@ -3389,25 +4538,7 @@
|
|
3389
4538
|
"example": "http://www.abcmobile.com"
|
3390
4539
|
},
|
3391
4540
|
"brandRelationship": {
|
3392
|
-
"
|
3393
|
-
"x-has-writer": true,
|
3394
|
-
"description": "Brand relationship to the CSP",
|
3395
|
-
"x-enum-type": "SMSTenDLCBrandBrandRelationshipEnum",
|
3396
|
-
"x-enum-type-c-sharp": "BrandRelationshipEnum",
|
3397
|
-
"enum": [
|
3398
|
-
"BASIC_ACCOUNT",
|
3399
|
-
"SMALL_ACCOUNT",
|
3400
|
-
"MEDIUM_ACCOUNT",
|
3401
|
-
"LARGE_ACCOUNT",
|
3402
|
-
"KEY_ACCOUNT"
|
3403
|
-
],
|
3404
|
-
"x-enum-varnames": [
|
3405
|
-
"BASIC_ACCOUNT",
|
3406
|
-
"SMALL_ACCOUNT",
|
3407
|
-
"MEDIUM_ACCOUNT",
|
3408
|
-
"LARGE_ACCOUNT",
|
3409
|
-
"KEY_ACCOUNT"
|
3410
|
-
]
|
4541
|
+
"$ref": "#/components/schemas/SMSTenDLCBrandRelationship"
|
3411
4542
|
},
|
3412
4543
|
"vertical": {
|
3413
4544
|
"maxLength": 50,
|
@@ -3420,13 +4551,7 @@
|
|
3420
4551
|
"description": "Alternate business identifier such as DUNS, LEI, or GIIN"
|
3421
4552
|
},
|
3422
4553
|
"altBusinessIdType": {
|
3423
|
-
"
|
3424
|
-
"x-has-writer": true,
|
3425
|
-
"x-enum-type": "SMSTenDLCBrandAltBusinessIdTypeEnum",
|
3426
|
-
"x-enum-type-c-sharp": "AltBusinessIdTypeEnum",
|
3427
|
-
"enum": ["NONE", "DUNS", "GIIN", "LEI"],
|
3428
|
-
"x-enum-varnames": ["NONE", "DUNS", "GIIN", "LEI"],
|
3429
|
-
"description": "The type of the Alternative business identifier"
|
4554
|
+
"$ref": "#/components/schemas/SMSTenDLCBrandAltBusinessIdType"
|
3430
4555
|
},
|
3431
4556
|
"universalEin": {
|
3432
4557
|
"type": "string",
|
@@ -3439,43 +4564,19 @@
|
|
3439
4564
|
"description": "Caller supplied brand reference ID. If supplied, the value must be unique across all submitted brands. Can be used to prevent duplicate brand registrations."
|
3440
4565
|
},
|
3441
4566
|
"optionalAttributes": {
|
3442
|
-
"
|
3443
|
-
"type": "object",
|
3444
|
-
"x-is-hash": true,
|
3445
|
-
"additionalProperties": {
|
3446
|
-
"type": "object",
|
3447
|
-
"description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names."
|
3448
|
-
},
|
3449
|
-
"description": "Optional brand attributes. Please refer to GET /enum/optionalAttributeNames for dictionary of optional attribute names."
|
4567
|
+
"$ref": "#/components/schemas/SMSTenDLCOptionalAttributes"
|
3450
4568
|
},
|
3451
4569
|
"mock": {
|
3452
4570
|
"type": "boolean",
|
3453
4571
|
"description": "Test brand."
|
3454
4572
|
},
|
3455
4573
|
"identityStatus": {
|
3456
|
-
"
|
3457
|
-
"x-has-writer": true,
|
3458
|
-
"description": "TCR assessment of the brand identification status.",
|
3459
|
-
"x-enum-type": "SMSTenDLCBrandIdentityStatusEnum",
|
3460
|
-
"x-enum-type-c-sharp": "IdentityStatusEnum",
|
3461
|
-
"enum": [
|
3462
|
-
"SELF_DECLARED",
|
3463
|
-
"UNVERIFIED",
|
3464
|
-
"VERIFIED",
|
3465
|
-
"VETTED_VERIFIED"
|
3466
|
-
],
|
3467
|
-
"x-enum-varnames": [
|
3468
|
-
"SELF_DECLARED",
|
3469
|
-
"UNVERIFIED",
|
3470
|
-
"VERIFIED",
|
3471
|
-
"VETTED_VERIFIED"
|
3472
|
-
]
|
4574
|
+
"$ref": "#/components/schemas/SMSTenDLCBrandIdentityStatus"
|
3473
4575
|
},
|
3474
4576
|
"createDate": {
|
3475
4577
|
"type": "string",
|
3476
4578
|
"description": "Unix timestamp when brand was created.",
|
3477
|
-
"format": "date-time"
|
3478
|
-
"x-is-date-time": true
|
4579
|
+
"format": "date-time"
|
3479
4580
|
}
|
3480
4581
|
},
|
3481
4582
|
"description": "A brand is a business identity behind the campaign.",
|
@@ -3512,7 +4613,6 @@
|
|
3512
4613
|
}
|
3513
4614
|
},
|
3514
4615
|
"SMSTollFreeCampaignsListResult": {
|
3515
|
-
"x-implements": "Pagination",
|
3516
4616
|
"allOf": [
|
3517
4617
|
{
|
3518
4618
|
"$ref": "#/components/schemas/PaginationModel"
|
@@ -3525,8 +4625,7 @@
|
|
3525
4625
|
"items": {
|
3526
4626
|
"$ref": "#/components/schemas/SMSTollFreeCampaign"
|
3527
4627
|
},
|
3528
|
-
"nullable": true
|
3529
|
-
"x-is-list": true
|
4628
|
+
"nullable": true
|
3530
4629
|
}
|
3531
4630
|
}
|
3532
4631
|
}
|
@@ -3543,7 +4642,6 @@
|
|
3543
4642
|
"dateUpdated",
|
3544
4643
|
"revision"
|
3545
4644
|
],
|
3546
|
-
"x-sms-toll-free-campaign": true,
|
3547
4645
|
"properties": {
|
3548
4646
|
"accountId": {
|
3549
4647
|
"type": "string",
|
@@ -3558,25 +4656,7 @@
|
|
3558
4656
|
"type": "string"
|
3559
4657
|
},
|
3560
4658
|
"registrationStatus": {
|
3561
|
-
"
|
3562
|
-
"x-has-writer": true,
|
3563
|
-
"description": "Current toll-free campaign registration status.Possible values: UNREGISTERED,INITIATED,PENDING,DECLINED,REGISTERED. A newly created campaign defaults to INITIATED status. ",
|
3564
|
-
"x-enum-type": "SMSTollFreeCampaignRegistrationStatusEnum",
|
3565
|
-
"x-enum-type-c-sharp": "RegistrationStatusEnum",
|
3566
|
-
"enum": [
|
3567
|
-
"UNREGISTERED",
|
3568
|
-
"INITIATED",
|
3569
|
-
"PENDING",
|
3570
|
-
"DECLINED",
|
3571
|
-
"REGISTERED"
|
3572
|
-
],
|
3573
|
-
"x-enum-varnames": [
|
3574
|
-
"UNREGISTERED",
|
3575
|
-
"INITIATED",
|
3576
|
-
"PENDING",
|
3577
|
-
"DECLINED",
|
3578
|
-
"REGISTERED"
|
3579
|
-
]
|
4659
|
+
"$ref": "#/components/schemas/SMSTollFreeCampaignRegistrationStatus"
|
3580
4660
|
},
|
3581
4661
|
"dateCreated": {
|
3582
4662
|
"type": "string"
|
@@ -3589,22 +4669,32 @@
|
|
3589
4669
|
}
|
3590
4670
|
}
|
3591
4671
|
},
|
4672
|
+
"TranscribeUtteranceRecord": {
|
4673
|
+
"type": "object",
|
4674
|
+
"properties": {
|
4675
|
+
"saveRecording": {
|
4676
|
+
"type": "boolean",
|
4677
|
+
"default": false
|
4678
|
+
},
|
4679
|
+
"maxLengthSec": {
|
4680
|
+
"type": "integer",
|
4681
|
+
"minimum": 1,
|
4682
|
+
"maximum": 60,
|
4683
|
+
"default": 60
|
4684
|
+
},
|
4685
|
+
"rcrdTerminationSilenceTimeMs": {
|
4686
|
+
"type": "integer",
|
4687
|
+
"minimum": 1,
|
4688
|
+
"maximum": 3000
|
4689
|
+
}
|
4690
|
+
}
|
4691
|
+
},
|
3592
4692
|
"TranscribeUtterance": {
|
3593
4693
|
"title": "TranscribeUtterance",
|
3594
4694
|
"x-stoplight": {
|
3595
4695
|
"id": "u509r3zqc38ze"
|
3596
4696
|
},
|
3597
4697
|
"description": "The `TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed.\n\n`TranscribeUtterance` is blocking and is a terminal command. As such, the actionUrl property is required, and control of the Call picks up using the `PerCL` returned in response of the `actionUrl`. Recording and Transcription information is returned in the actionUrl request. If the reason this command ended was due to the call hanging up, any PerCL returned will not execute.",
|
3598
|
-
"x-percl-command": true,
|
3599
|
-
"x-ref-properties": [
|
3600
|
-
"\"TEST_STRING\"",
|
3601
|
-
"false",
|
3602
|
-
"new TranscribeUtteranceAllOfRecord()",
|
3603
|
-
"false",
|
3604
|
-
"false",
|
3605
|
-
"new List<Object>()",
|
3606
|
-
"\"TEST_STRING\""
|
3607
|
-
],
|
3608
4698
|
"allOf": [
|
3609
4699
|
{
|
3610
4700
|
"$ref": "#/components/schemas/PerclCommand"
|
@@ -3615,33 +4705,15 @@
|
|
3615
4705
|
"description": "The `TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed.\n\n`TranscribeUtterance` is blocking and is a terminal command. As such, the actionUrl property is required, and control of the Call picks up using the `PerCL` returned in response of the `actionUrl`. Recording and Transcription information is returned in the actionUrl request. If the reason this command ended was due to the call hanging up, any PerCL returned will not execute.",
|
3616
4706
|
"properties": {
|
3617
4707
|
"actionUrl": {
|
3618
|
-
"type": "string"
|
4708
|
+
"type": "string",
|
4709
|
+
"format": "uri"
|
3619
4710
|
},
|
3620
4711
|
"playBeep": {
|
3621
4712
|
"type": "boolean",
|
3622
4713
|
"default": false
|
3623
4714
|
},
|
3624
4715
|
"record": {
|
3625
|
-
"
|
3626
|
-
"x-is-object": true,
|
3627
|
-
"properties": {
|
3628
|
-
"saveRecording": {
|
3629
|
-
"type": "boolean",
|
3630
|
-
"default": false
|
3631
|
-
},
|
3632
|
-
"maxLengthSec": {
|
3633
|
-
"type": "integer",
|
3634
|
-
"minimum": 1,
|
3635
|
-
"maximum": 60,
|
3636
|
-
"default": 60
|
3637
|
-
},
|
3638
|
-
"rcrdTerminationSilenceTimeMs": {
|
3639
|
-
"type": "integer",
|
3640
|
-
"exclusiveMinimum": true,
|
3641
|
-
"minimum": 0,
|
3642
|
-
"maximum": 3000
|
3643
|
-
}
|
3644
|
-
}
|
4716
|
+
"$ref": "#/components/schemas/TranscribeUtteranceRecord"
|
3645
4717
|
},
|
3646
4718
|
"privacyForLogging": {
|
3647
4719
|
"type": "boolean",
|
@@ -3653,8 +4725,9 @@
|
|
3653
4725
|
},
|
3654
4726
|
"prompts": {
|
3655
4727
|
"type": "array",
|
3656
|
-
"
|
3657
|
-
|
4728
|
+
"items": {
|
4729
|
+
"$ref": "#/components/schemas/PerclCommand"
|
4730
|
+
}
|
3658
4731
|
}
|
3659
4732
|
}
|
3660
4733
|
}
|
@@ -3683,7 +4756,6 @@
|
|
3683
4756
|
"CreateWebRTCToken": {
|
3684
4757
|
"type": "object",
|
3685
4758
|
"required": ["to", "from", "uses"],
|
3686
|
-
"x-web-rtc": true,
|
3687
4759
|
"additionalProperties": false,
|
3688
4760
|
"properties": {
|
3689
4761
|
"to": {
|
@@ -3865,7 +4937,6 @@
|
|
3865
4937
|
"tags": [],
|
3866
4938
|
"summary": "List applications",
|
3867
4939
|
"operationId": "list-applications",
|
3868
|
-
"x-is-paginated": true,
|
3869
4940
|
"parameters": [
|
3870
4941
|
{
|
3871
4942
|
"name": "alias",
|
@@ -3933,7 +5004,6 @@
|
|
3933
5004
|
"tags": [],
|
3934
5005
|
"summary": "List available numbers",
|
3935
5006
|
"operationId": "list-available-numbers",
|
3936
|
-
"x-is-paginated": true,
|
3937
5007
|
"parameters": [
|
3938
5008
|
{
|
3939
5009
|
"name": "phoneNumber",
|
@@ -4119,7 +5189,6 @@
|
|
4119
5189
|
"tags": [],
|
4120
5190
|
"summary": "List Incoming Numbers",
|
4121
5191
|
"operationId": "list-incoming-numbers",
|
4122
|
-
"x-is-paginated": true,
|
4123
5192
|
"parameters": [
|
4124
5193
|
{
|
4125
5194
|
"$ref": "#/components/parameters/AccountId"
|
@@ -4445,7 +5514,6 @@
|
|
4445
5514
|
"tags": [],
|
4446
5515
|
"summary": "List Calls",
|
4447
5516
|
"operationId": "list-calls",
|
4448
|
-
"x-is-paginated": true,
|
4449
5517
|
"parameters": [
|
4450
5518
|
{
|
4451
5519
|
"name": "active",
|
@@ -4550,7 +5618,6 @@
|
|
4550
5618
|
"tags": [],
|
4551
5619
|
"summary": "List Call Recordings",
|
4552
5620
|
"operationId": "list-call-recordings",
|
4553
|
-
"x-is-paginated": true,
|
4554
5621
|
"parameters": [
|
4555
5622
|
{
|
4556
5623
|
"name": "dateCreated",
|
@@ -4594,7 +5661,6 @@
|
|
4594
5661
|
"tags": [],
|
4595
5662
|
"summary": "List Call Logs",
|
4596
5663
|
"operationId": "list-call-logs",
|
4597
|
-
"x-is-paginated": true,
|
4598
5664
|
"parameters": [
|
4599
5665
|
{
|
4600
5666
|
"$ref": "#/components/parameters/AccountId"
|
@@ -4628,7 +5694,6 @@
|
|
4628
5694
|
"post": {
|
4629
5695
|
"summary": "Make a JWT for WebRTC calling",
|
4630
5696
|
"operationId": "make-a-webrtc-jwt",
|
4631
|
-
"x-web-rtc": true,
|
4632
5697
|
"parameters": [
|
4633
5698
|
{
|
4634
5699
|
"$ref": "#/components/parameters/AccountId"
|
@@ -4698,7 +5763,6 @@
|
|
4698
5763
|
"tags": [],
|
4699
5764
|
"summary": "List Conferences",
|
4700
5765
|
"operationId": "list-conferences",
|
4701
|
-
"x-is-paginated": true,
|
4702
5766
|
"parameters": [
|
4703
5767
|
{
|
4704
5768
|
"name": "status",
|
@@ -4957,7 +6021,6 @@
|
|
4957
6021
|
"tags": [],
|
4958
6022
|
"summary": "List Participants",
|
4959
6023
|
"operationId": "list-participants",
|
4960
|
-
"x-is-paginated": true,
|
4961
6024
|
"parameters": [
|
4962
6025
|
{
|
4963
6026
|
"name": "talk",
|
@@ -5019,7 +6082,6 @@
|
|
5019
6082
|
"tags": [],
|
5020
6083
|
"summary": "List Conference Recordings",
|
5021
6084
|
"operationId": "list-conference-recordings",
|
5022
|
-
"x-is-paginated": true,
|
5023
6085
|
"parameters": [
|
5024
6086
|
{
|
5025
6087
|
"name": "callId",
|
@@ -5148,7 +6210,6 @@
|
|
5148
6210
|
"tags": [],
|
5149
6211
|
"summary": "List Active Queues",
|
5150
6212
|
"operationId": "list-active-queues",
|
5151
|
-
"x-is-paginated": true,
|
5152
6213
|
"parameters": [
|
5153
6214
|
{
|
5154
6215
|
"name": "alias",
|
@@ -5282,7 +6343,6 @@
|
|
5282
6343
|
"tags": [],
|
5283
6344
|
"summary": "List Members",
|
5284
6345
|
"operationId": "list-members",
|
5285
|
-
"x-is-paginated": true,
|
5286
6346
|
"parameters": [
|
5287
6347
|
{
|
5288
6348
|
"$ref": "#/components/parameters/AccountId"
|
@@ -5401,7 +6461,6 @@
|
|
5401
6461
|
"tags": [],
|
5402
6462
|
"summary": "List All Account Logs",
|
5403
6463
|
"operationId": "list-all-account-logs",
|
5404
|
-
"x-is-paginated": true,
|
5405
6464
|
"parameters": [
|
5406
6465
|
{
|
5407
6466
|
"$ref": "#/components/parameters/AccountId"
|
@@ -5461,7 +6520,6 @@
|
|
5461
6520
|
"tags": [],
|
5462
6521
|
"summary": "List Recordings",
|
5463
6522
|
"operationId": "list-recordings",
|
5464
|
-
"x-is-paginated": true,
|
5465
6523
|
"parameters": [
|
5466
6524
|
{
|
5467
6525
|
"name": "callId",
|
@@ -5643,7 +6701,6 @@
|
|
5643
6701
|
"tags": [],
|
5644
6702
|
"summary": "List SMS Messages",
|
5645
6703
|
"operationId": "list-sms-messages",
|
5646
|
-
"x-is-paginated": true,
|
5647
6704
|
"parameters": [
|
5648
6705
|
{
|
5649
6706
|
"$ref": "#/components/parameters/AccountId"
|
@@ -5808,8 +6865,7 @@
|
|
5808
6865
|
"get": {
|
5809
6866
|
"tags": [],
|
5810
6867
|
"summary": "Get list of SMS 10DLC Campaigns",
|
5811
|
-
"operationId": "get-tenDLC-sms-
|
5812
|
-
"x-is-paginated": true,
|
6868
|
+
"operationId": "get-tenDLC-sms-campaigns",
|
5813
6869
|
"parameters": [
|
5814
6870
|
{
|
5815
6871
|
"$ref": "#/components/parameters/AccountId"
|
@@ -5922,7 +6978,6 @@
|
|
5922
6978
|
"tags": [],
|
5923
6979
|
"summary": "Get list of SMS 10DLC Partner Campaigns",
|
5924
6980
|
"operationId": "get-tenDLC-sms-partnerCampaigns",
|
5925
|
-
"x-is-paginated": true,
|
5926
6981
|
"parameters": [
|
5927
6982
|
{
|
5928
6983
|
"$ref": "#/components/parameters/AccountId"
|
@@ -6044,7 +7099,6 @@
|
|
6044
7099
|
"tags": [],
|
6045
7100
|
"summary": "Get list of SMS 10DLC Brands",
|
6046
7101
|
"operationId": "get-tenDLC-sms-brands",
|
6047
|
-
"x-is-paginated": true,
|
6048
7102
|
"parameters": [
|
6049
7103
|
{
|
6050
7104
|
"$ref": "#/components/parameters/AccountId"
|
@@ -6146,7 +7200,6 @@
|
|
6146
7200
|
"tags": [],
|
6147
7201
|
"summary": "Get list of TollFree Campaigns",
|
6148
7202
|
"operationId": "get-tollFree-sms-campaigns",
|
6149
|
-
"x-is-paginated": true,
|
6150
7203
|
"parameters": [
|
6151
7204
|
{
|
6152
7205
|
"$ref": "#/components/parameters/AccountId"
|