docs/OutboundApi.md in purecloudplatformclientv2-49.0.0 vs docs/OutboundApi.md in purecloudplatformclientv2-49.0.1

- old
+ new

@@ -106,11 +106,11 @@ [**put_outbound_wrapupcodemappings**](OutboundApi.html#put_outbound_wrapupcodemappings) | Update the Dialer wrap up code mapping. {: class="table table-striped"} <a name="delete_outbound_attemptlimit"></a> -## - delete_outbound_attemptlimit(attempt_limits_id) +## delete_outbound_attemptlimit(attempt_limits_id) Delete attempt limits @@ -122,11 +122,11 @@ * outbound:attemptLimits:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -147,11 +147,11 @@ #Delete attempt limits api_instance.delete_outbound_attemptlimit(attempt_limits_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_attemptlimit: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -170,11 +170,11 @@ <a name="delete_outbound_callabletimeset"></a> -## - delete_outbound_callabletimeset(callable_time_set_id) +## delete_outbound_callabletimeset(callable_time_set_id) Delete callable time set @@ -186,11 +186,11 @@ * outbound:callableTimeSet:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -211,11 +211,11 @@ #Delete callable time set api_instance.delete_outbound_callabletimeset(callable_time_set_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_callabletimeset: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -234,11 +234,11 @@ <a name="delete_outbound_callanalysisresponseset"></a> -## - delete_outbound_callanalysisresponseset(call_analysis_set_id) +## delete_outbound_callanalysisresponseset(call_analysis_set_id) Delete a dialer call analysis response set. @@ -250,11 +250,11 @@ * outbound:responseSet:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -275,11 +275,11 @@ #Delete a dialer call analysis response set. api_instance.delete_outbound_callanalysisresponseset(call_analysis_set_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_callanalysisresponseset: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -298,11 +298,11 @@ <a name="delete_outbound_campaign"></a> -## -[**Campaign**](Campaign.html) delete_outbound_campaign(campaign_id) +## [**Campaign**](Campaign.html) delete_outbound_campaign(campaign_id) Delete a campaign. @@ -314,11 +314,11 @@ * outbound:campaign:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -340,11 +340,11 @@ result = api_instance.delete_outbound_campaign(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_campaign: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -363,11 +363,11 @@ <a name="delete_outbound_campaign_progress"></a> -## - delete_outbound_campaign_progress(campaign_id) +## delete_outbound_campaign_progress(campaign_id) Reset campaign progress and recycle the campaign @@ -379,11 +379,11 @@ * outbound:campaign:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -404,11 +404,11 @@ #Reset campaign progress and recycle the campaign api_instance.delete_outbound_campaign_progress(campaign_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_campaign_progress: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -427,11 +427,11 @@ <a name="delete_outbound_campaignrule"></a> -## - delete_outbound_campaignrule(campaign_rule_id) +## delete_outbound_campaignrule(campaign_rule_id) Delete Campaign Rule @@ -443,11 +443,11 @@ * outbound:campaignRule:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -468,11 +468,11 @@ #Delete Campaign Rule api_instance.delete_outbound_campaignrule(campaign_rule_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_campaignrule: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -491,11 +491,11 @@ <a name="delete_outbound_contactlist"></a> -## - delete_outbound_contactlist(contact_list_id) +## delete_outbound_contactlist(contact_list_id) Delete a contact list. @@ -507,11 +507,11 @@ * outbound:contactList:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -532,11 +532,11 @@ #Delete a contact list. api_instance.delete_outbound_contactlist(contact_list_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_contactlist: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -555,11 +555,11 @@ <a name="delete_outbound_contactlist_contact"></a> -## - delete_outbound_contactlist_contact(contact_list_id, contact_id) +## delete_outbound_contactlist_contact(contact_list_id, contact_id) Delete a contact. @@ -571,11 +571,11 @@ * outbound:contact:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -598,11 +598,11 @@ #Delete a contact. api_instance.delete_outbound_contactlist_contact(contact_list_id, contact_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_contactlist_contact: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -622,11 +622,11 @@ <a name="delete_outbound_contactlist_contacts"></a> -## - delete_outbound_contactlist_contacts(contact_list_id, contact_ids) +## delete_outbound_contactlist_contacts(contact_list_id, contact_ids) Delete contacts from a contact list. @@ -638,11 +638,11 @@ * outbound:contact:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -665,11 +665,11 @@ #Delete contacts from a contact list. api_instance.delete_outbound_contactlist_contacts(contact_list_id, contact_ids) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_contactlist_contacts: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -689,11 +689,11 @@ <a name="delete_outbound_contactlistfilter"></a> -## - delete_outbound_contactlistfilter(contact_list_filter_id) +## delete_outbound_contactlistfilter(contact_list_filter_id) Delete Contact List Filter @@ -705,11 +705,11 @@ * outbound:contactListFilter:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -730,11 +730,11 @@ #Delete Contact List Filter api_instance.delete_outbound_contactlistfilter(contact_list_filter_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_contactlistfilter: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -753,11 +753,11 @@ <a name="delete_outbound_contactlists"></a> -## - delete_outbound_contactlists(id) +## delete_outbound_contactlists(id) Delete multiple contact lists. @@ -769,11 +769,11 @@ * outbound:contactList:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -794,11 +794,11 @@ #Delete multiple contact lists. api_instance.delete_outbound_contactlists(id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_contactlists: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -817,11 +817,11 @@ <a name="delete_outbound_dnclist"></a> -## - delete_outbound_dnclist(dnc_list_id) +## delete_outbound_dnclist(dnc_list_id) Delete dialer DNC list @@ -833,11 +833,11 @@ * outbound:dncList:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -858,11 +858,11 @@ #Delete dialer DNC list api_instance.delete_outbound_dnclist(dnc_list_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_dnclist: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -881,11 +881,11 @@ <a name="delete_outbound_ruleset"></a> -## - delete_outbound_ruleset(rule_set_id) +## delete_outbound_ruleset(rule_set_id) Delete a Rule set. @@ -897,11 +897,11 @@ * outbound:ruleSet:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -922,11 +922,11 @@ #Delete a Rule set. api_instance.delete_outbound_ruleset(rule_set_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_ruleset: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -945,11 +945,11 @@ <a name="delete_outbound_schedules_campaign"></a> -## - delete_outbound_schedules_campaign(campaign_id) +## delete_outbound_schedules_campaign(campaign_id) Delete a dialer campaign schedule. @@ -961,11 +961,11 @@ * outbound:schedule:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -986,11 +986,11 @@ #Delete a dialer campaign schedule. api_instance.delete_outbound_schedules_campaign(campaign_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_schedules_campaign: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1009,11 +1009,11 @@ <a name="delete_outbound_schedules_sequence"></a> -## - delete_outbound_schedules_sequence(sequence_id) +## delete_outbound_schedules_sequence(sequence_id) Delete a dialer sequence schedule. @@ -1025,11 +1025,11 @@ * outbound:schedule:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1050,11 +1050,11 @@ #Delete a dialer sequence schedule. api_instance.delete_outbound_schedules_sequence(sequence_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_schedules_sequence: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1073,11 +1073,11 @@ <a name="delete_outbound_sequence"></a> -## - delete_outbound_sequence(sequence_id) +## delete_outbound_sequence(sequence_id) Delete a dialer campaign sequence. @@ -1089,11 +1089,11 @@ * outbound:campaignSequence:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1114,11 +1114,11 @@ #Delete a dialer campaign sequence. api_instance.delete_outbound_sequence(sequence_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_outbound_sequence: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1137,11 +1137,11 @@ <a name="get_outbound_attemptlimit"></a> -## -[**AttemptLimits**](AttemptLimits.html) get_outbound_attemptlimit(attempt_limits_id) +## [**AttemptLimits**](AttemptLimits.html) get_outbound_attemptlimit(attempt_limits_id) Get attempt limits @@ -1153,11 +1153,11 @@ * outbound:attemptLimits:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1179,11 +1179,11 @@ result = api_instance.get_outbound_attemptlimit(attempt_limits_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_attemptlimit: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1202,11 +1202,11 @@ <a name="get_outbound_attemptlimits"></a> -## -[**AttemptLimitsEntityListing**](AttemptLimitsEntityListing.html) get_outbound_attemptlimits(opts) +## [**AttemptLimitsEntityListing**](AttemptLimitsEntityListing.html) get_outbound_attemptlimits(opts) Query attempt limits list @@ -1218,11 +1218,11 @@ * outbound:attemptLimits:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1250,11 +1250,11 @@ result = api_instance.get_outbound_attemptlimits(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_attemptlimits: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1278,11 +1278,11 @@ <a name="get_outbound_callabletimeset"></a> -## -[**CallableTimeSet**](CallableTimeSet.html) get_outbound_callabletimeset(callable_time_set_id) +## [**CallableTimeSet**](CallableTimeSet.html) get_outbound_callabletimeset(callable_time_set_id) Get callable time set @@ -1294,11 +1294,11 @@ * outbound:callableTimeSet:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1320,11 +1320,11 @@ result = api_instance.get_outbound_callabletimeset(callable_time_set_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_callabletimeset: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1343,11 +1343,11 @@ <a name="get_outbound_callabletimesets"></a> -## -[**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html) get_outbound_callabletimesets(opts) +## [**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html) get_outbound_callabletimesets(opts) Query callable time set list @@ -1359,11 +1359,11 @@ * outbound:callableTimeSet:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1391,11 +1391,11 @@ result = api_instance.get_outbound_callabletimesets(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_callabletimesets: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1419,11 +1419,11 @@ <a name="get_outbound_callanalysisresponseset"></a> -## -[**ResponseSet**](ResponseSet.html) get_outbound_callanalysisresponseset(call_analysis_set_id) +## [**ResponseSet**](ResponseSet.html) get_outbound_callanalysisresponseset(call_analysis_set_id) Get a dialer call analysis response set. @@ -1435,11 +1435,11 @@ * outbound:responseSet:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1461,11 +1461,11 @@ result = api_instance.get_outbound_callanalysisresponseset(call_analysis_set_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_callanalysisresponseset: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1484,11 +1484,11 @@ <a name="get_outbound_callanalysisresponsesets"></a> -## -[**ResponseSetEntityListing**](ResponseSetEntityListing.html) get_outbound_callanalysisresponsesets(opts) +## [**ResponseSetEntityListing**](ResponseSetEntityListing.html) get_outbound_callanalysisresponsesets(opts) Query a list of dialer call analysis response sets. @@ -1500,11 +1500,11 @@ * outbound:responseSet:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1532,11 +1532,11 @@ result = api_instance.get_outbound_callanalysisresponsesets(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_callanalysisresponsesets: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1560,11 +1560,11 @@ <a name="get_outbound_campaign"></a> -## -[**Campaign**](Campaign.html) get_outbound_campaign(campaign_id) +## [**Campaign**](Campaign.html) get_outbound_campaign(campaign_id) Get dialer campaign. @@ -1576,11 +1576,11 @@ * outbound:campaign:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1602,11 +1602,11 @@ result = api_instance.get_outbound_campaign(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_campaign: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1625,11 +1625,11 @@ <a name="get_outbound_campaign_diagnostics"></a> -## -[**CampaignDiagnostics**](CampaignDiagnostics.html) get_outbound_campaign_diagnostics(campaign_id) +## [**CampaignDiagnostics**](CampaignDiagnostics.html) get_outbound_campaign_diagnostics(campaign_id) Get campaign diagnostics @@ -1641,11 +1641,11 @@ * outbound:campaign:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1667,11 +1667,11 @@ result = api_instance.get_outbound_campaign_diagnostics(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_campaign_diagnostics: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1690,11 +1690,11 @@ <a name="get_outbound_campaign_interactions"></a> -## -[**CampaignInteractions**](CampaignInteractions.html) get_outbound_campaign_interactions(campaign_id) +## [**CampaignInteractions**](CampaignInteractions.html) get_outbound_campaign_interactions(campaign_id) Get dialer campaign interactions. @@ -1706,11 +1706,11 @@ * outbound:campaign:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1732,11 +1732,11 @@ result = api_instance.get_outbound_campaign_interactions(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_campaign_interactions: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1755,11 +1755,11 @@ <a name="get_outbound_campaign_progress"></a> -## -[**CampaignProgress**](CampaignProgress.html) get_outbound_campaign_progress(campaign_id) +## [**CampaignProgress**](CampaignProgress.html) get_outbound_campaign_progress(campaign_id) Get campaign progress @@ -1771,11 +1771,11 @@ * outbound:campaign:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1797,11 +1797,11 @@ result = api_instance.get_outbound_campaign_progress(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_campaign_progress: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1820,11 +1820,11 @@ <a name="get_outbound_campaign_stats"></a> -## -[**CampaignStats**](CampaignStats.html) get_outbound_campaign_stats(campaign_id) +## [**CampaignStats**](CampaignStats.html) get_outbound_campaign_stats(campaign_id) Get statistics about a Dialer Campaign @@ -1836,11 +1836,11 @@ * outbound:campaign:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1862,11 +1862,11 @@ result = api_instance.get_outbound_campaign_stats(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_campaign_stats: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1885,11 +1885,11 @@ <a name="get_outbound_campaignrule"></a> -## -[**CampaignRule**](CampaignRule.html) get_outbound_campaignrule(campaign_rule_id) +## [**CampaignRule**](CampaignRule.html) get_outbound_campaignrule(campaign_rule_id) Get Campaign Rule @@ -1901,11 +1901,11 @@ * outbound:campaignRule:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1927,11 +1927,11 @@ result = api_instance.get_outbound_campaignrule(campaign_rule_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_campaignrule: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -1950,11 +1950,11 @@ <a name="get_outbound_campaignrules"></a> -## -[**CampaignRuleEntityListing**](CampaignRuleEntityListing.html) get_outbound_campaignrules(opts) +## [**CampaignRuleEntityListing**](CampaignRuleEntityListing.html) get_outbound_campaignrules(opts) Query Campaign Rule list @@ -1966,11 +1966,11 @@ * outbound:campaignRule:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -1998,11 +1998,11 @@ result = api_instance.get_outbound_campaignrules(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_campaignrules: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2026,11 +2026,11 @@ <a name="get_outbound_campaigns"></a> -## -[**CampaignEntityListing**](CampaignEntityListing.html) get_outbound_campaigns(opts) +## [**CampaignEntityListing**](CampaignEntityListing.html) get_outbound_campaigns(opts) Query a list of dialer campaigns. @@ -2042,11 +2042,11 @@ * outbound:campaign:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2081,11 +2081,11 @@ result = api_instance.get_outbound_campaigns(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_campaigns: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2116,11 +2116,11 @@ <a name="get_outbound_campaigns_divisionviews"></a> -## -[**CampaignDivisionViewListing**](CampaignDivisionViewListing.html) get_outbound_campaigns_divisionviews(opts) +## [**CampaignDivisionViewListing**](CampaignDivisionViewListing.html) get_outbound_campaigns_divisionviews(opts) Query a list of basic Campaign information objects @@ -2132,11 +2132,11 @@ * outbound:campaign:search ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2165,11 +2165,11 @@ result = api_instance.get_outbound_campaigns_divisionviews(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_campaigns_divisionviews: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2194,11 +2194,11 @@ <a name="get_outbound_contactlist"></a> -## -[**ContactList**](ContactList.html) get_outbound_contactlist(contact_list_id, opts) +## [**ContactList**](ContactList.html) get_outbound_contactlist(contact_list_id, opts) Get a dialer contact list. @@ -2210,11 +2210,11 @@ * outbound:contactList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2240,11 +2240,11 @@ result = api_instance.get_outbound_contactlist(contact_list_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_contactlist: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2265,11 +2265,11 @@ <a name="get_outbound_contactlist_contact"></a> -## -[**DialerContact**](DialerContact.html) get_outbound_contactlist_contact(contact_list_id, contact_id) +## [**DialerContact**](DialerContact.html) get_outbound_contactlist_contact(contact_list_id, contact_id) Get a contact. @@ -2281,11 +2281,11 @@ * outbound:contact:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2309,11 +2309,11 @@ result = api_instance.get_outbound_contactlist_contact(contact_list_id, contact_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_contactlist_contact: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2333,11 +2333,11 @@ <a name="get_outbound_contactlist_export"></a> -## -[**ExportUri**](ExportUri.html) get_outbound_contactlist_export(contact_list_id, opts) +## [**ExportUri**](ExportUri.html) get_outbound_contactlist_export(contact_list_id, opts) Get the URI of a contact list export. @@ -2350,11 +2350,11 @@ * outbound:contact:view * outbound:contactList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2379,11 +2379,11 @@ result = api_instance.get_outbound_contactlist_export(contact_list_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_contactlist_export: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2403,11 +2403,11 @@ <a name="get_outbound_contactlist_importstatus"></a> -## -[**ImportStatus**](ImportStatus.html) get_outbound_contactlist_importstatus(contact_list_id) +## [**ImportStatus**](ImportStatus.html) get_outbound_contactlist_importstatus(contact_list_id) Get dialer contactList import status. @@ -2419,11 +2419,11 @@ * outbound:contactList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2445,11 +2445,11 @@ result = api_instance.get_outbound_contactlist_importstatus(contact_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_contactlist_importstatus: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2468,11 +2468,11 @@ <a name="get_outbound_contactlist_timezonemappingpreview"></a> -## -[**TimeZoneMappingPreview**](TimeZoneMappingPreview.html) get_outbound_contactlist_timezonemappingpreview(contact_list_id) +## [**TimeZoneMappingPreview**](TimeZoneMappingPreview.html) get_outbound_contactlist_timezonemappingpreview(contact_list_id) Preview the result of applying Automatic Time Zone Mapping to a contact list @@ -2484,11 +2484,11 @@ * outbound:contactList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2510,11 +2510,11 @@ result = api_instance.get_outbound_contactlist_timezonemappingpreview(contact_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_contactlist_timezonemappingpreview: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2533,11 +2533,11 @@ <a name="get_outbound_contactlistfilter"></a> -## -[**ContactListFilter**](ContactListFilter.html) get_outbound_contactlistfilter(contact_list_filter_id) +## [**ContactListFilter**](ContactListFilter.html) get_outbound_contactlistfilter(contact_list_filter_id) Get Contact list filter @@ -2549,11 +2549,11 @@ * outbound:contactListFilter:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2575,11 +2575,11 @@ result = api_instance.get_outbound_contactlistfilter(contact_list_filter_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_contactlistfilter: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2598,11 +2598,11 @@ <a name="get_outbound_contactlistfilters"></a> -## -[**ContactListFilterEntityListing**](ContactListFilterEntityListing.html) get_outbound_contactlistfilters(opts) +## [**ContactListFilterEntityListing**](ContactListFilterEntityListing.html) get_outbound_contactlistfilters(opts) Query Contact list filters @@ -2614,11 +2614,11 @@ * outbound:contactListFilter:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2647,11 +2647,11 @@ result = api_instance.get_outbound_contactlistfilters(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_contactlistfilters: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2676,11 +2676,11 @@ <a name="get_outbound_contactlists"></a> -## -[**ContactListEntityListing**](ContactListEntityListing.html) get_outbound_contactlists(opts) +## [**ContactListEntityListing**](ContactListEntityListing.html) get_outbound_contactlists(opts) Query a list of contact lists. @@ -2692,11 +2692,11 @@ * outbound:contactList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2728,11 +2728,11 @@ result = api_instance.get_outbound_contactlists(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_contactlists: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2760,11 +2760,11 @@ <a name="get_outbound_contactlists_divisionview"></a> -## -[**ContactListDivisionView**](ContactListDivisionView.html) get_outbound_contactlists_divisionview(contact_list_id, opts) +## [**ContactListDivisionView**](ContactListDivisionView.html) get_outbound_contactlists_divisionview(contact_list_id, opts) Get a basic ContactList information object @@ -2776,11 +2776,11 @@ * outbound:contactList:search ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2806,11 +2806,11 @@ result = api_instance.get_outbound_contactlists_divisionview(contact_list_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_contactlists_divisionview: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2831,11 +2831,11 @@ <a name="get_outbound_contactlists_divisionviews"></a> -## -[**ContactListDivisionViewListing**](ContactListDivisionViewListing.html) get_outbound_contactlists_divisionviews(opts) +## [**ContactListDivisionViewListing**](ContactListDivisionViewListing.html) get_outbound_contactlists_divisionviews(opts) Query a list of simplified contact list objects. @@ -2847,11 +2847,11 @@ * outbound:contactList:search ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2882,11 +2882,11 @@ result = api_instance.get_outbound_contactlists_divisionviews(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_contactlists_divisionviews: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2913,11 +2913,11 @@ <a name="get_outbound_dnclist"></a> -## -[**DncList**](DncList.html) get_outbound_dnclist(dnc_list_id, opts) +## [**DncList**](DncList.html) get_outbound_dnclist(dnc_list_id, opts) Get dialer DNC list @@ -2929,11 +2929,11 @@ * outbound:dncList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -2959,11 +2959,11 @@ result = api_instance.get_outbound_dnclist(dnc_list_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_dnclist: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -2984,11 +2984,11 @@ <a name="get_outbound_dnclist_export"></a> -## -[**ExportUri**](ExportUri.html) get_outbound_dnclist_export(dnc_list_id, opts) +## [**ExportUri**](ExportUri.html) get_outbound_dnclist_export(dnc_list_id, opts) Get the URI of a DNC list export. @@ -3001,11 +3001,11 @@ * outbound:dnc:view * outbound:dncList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3030,11 +3030,11 @@ result = api_instance.get_outbound_dnclist_export(dnc_list_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_dnclist_export: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3054,11 +3054,11 @@ <a name="get_outbound_dnclist_importstatus"></a> -## -[**ImportStatus**](ImportStatus.html) get_outbound_dnclist_importstatus(dnc_list_id) +## [**ImportStatus**](ImportStatus.html) get_outbound_dnclist_importstatus(dnc_list_id) Get dialer dncList import status. @@ -3070,11 +3070,11 @@ * outbound:dncList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3096,11 +3096,11 @@ result = api_instance.get_outbound_dnclist_importstatus(dnc_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_dnclist_importstatus: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3119,11 +3119,11 @@ <a name="get_outbound_dnclists"></a> -## -[**DncListEntityListing**](DncListEntityListing.html) get_outbound_dnclists(opts) +## [**DncListEntityListing**](DncListEntityListing.html) get_outbound_dnclists(opts) Query dialer DNC lists @@ -3135,11 +3135,11 @@ * outbound:dncList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3171,11 +3171,11 @@ result = api_instance.get_outbound_dnclists(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_dnclists: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3203,11 +3203,11 @@ <a name="get_outbound_dnclists_divisionview"></a> -## -[**DncListDivisionView**](DncListDivisionView.html) get_outbound_dnclists_divisionview(dnc_list_id, opts) +## [**DncListDivisionView**](DncListDivisionView.html) get_outbound_dnclists_divisionview(dnc_list_id, opts) Get a basic DncList information object @@ -3219,11 +3219,11 @@ * outbound:dncList:search ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3249,11 +3249,11 @@ result = api_instance.get_outbound_dnclists_divisionview(dnc_list_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_dnclists_divisionview: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3274,11 +3274,11 @@ <a name="get_outbound_dnclists_divisionviews"></a> -## -[**DncListDivisionViewListing**](DncListDivisionViewListing.html) get_outbound_dnclists_divisionviews(opts) +## [**DncListDivisionViewListing**](DncListDivisionViewListing.html) get_outbound_dnclists_divisionviews(opts) Query a list of simplified dnc list objects. @@ -3290,11 +3290,11 @@ * outbound:dncList:search ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3325,11 +3325,11 @@ result = api_instance.get_outbound_dnclists_divisionviews(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_dnclists_divisionviews: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3356,11 +3356,11 @@ <a name="get_outbound_event"></a> -## -[**EventLog**](EventLog.html) get_outbound_event(event_id) +## [**EventLog**](EventLog.html) get_outbound_event(event_id) Get Dialer Event @@ -3372,11 +3372,11 @@ * outbound:eventLog:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3398,11 +3398,11 @@ result = api_instance.get_outbound_event(event_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_event: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3421,11 +3421,11 @@ <a name="get_outbound_events"></a> -## -[**DialerEventEntityListing**](DialerEventEntityListing.html) get_outbound_events(opts) +## [**DialerEventEntityListing**](DialerEventEntityListing.html) get_outbound_events(opts) Query Event Logs @@ -3437,11 +3437,11 @@ * outbound:eventLog:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3470,11 +3470,11 @@ result = api_instance.get_outbound_events(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_events: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3499,11 +3499,11 @@ <a name="get_outbound_ruleset"></a> -## -[**RuleSet**](RuleSet.html) get_outbound_ruleset(rule_set_id) +## [**RuleSet**](RuleSet.html) get_outbound_ruleset(rule_set_id) Get a Rule Set by ID. @@ -3515,11 +3515,11 @@ * outbound:ruleSet:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3541,11 +3541,11 @@ result = api_instance.get_outbound_ruleset(rule_set_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_ruleset: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3564,11 +3564,11 @@ <a name="get_outbound_rulesets"></a> -## -[**RuleSetEntityListing**](RuleSetEntityListing.html) get_outbound_rulesets(opts) +## [**RuleSetEntityListing**](RuleSetEntityListing.html) get_outbound_rulesets(opts) Query a list of Rule Sets. @@ -3580,11 +3580,11 @@ * outbound:ruleSet:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3612,11 +3612,11 @@ result = api_instance.get_outbound_rulesets(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_rulesets: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3640,11 +3640,11 @@ <a name="get_outbound_schedules_campaign"></a> -## -[**CampaignSchedule**](CampaignSchedule.html) get_outbound_schedules_campaign(campaign_id) +## [**CampaignSchedule**](CampaignSchedule.html) get_outbound_schedules_campaign(campaign_id) Get a dialer campaign schedule. @@ -3656,11 +3656,11 @@ * outbound:schedule:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3682,11 +3682,11 @@ result = api_instance.get_outbound_schedules_campaign(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_schedules_campaign: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3705,11 +3705,11 @@ <a name="get_outbound_schedules_campaigns"></a> -## -[**Array&lt;CampaignSchedule&gt;**](CampaignSchedule.html) get_outbound_schedules_campaigns +## [**Array&lt;CampaignSchedule&gt;**](CampaignSchedule.html) get_outbound_schedules_campaigns Query for a list of dialer campaign schedules. @@ -3721,11 +3721,11 @@ * outbound:schedule:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3744,11 +3744,11 @@ result = api_instance.get_outbound_schedules_campaigns p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_schedules_campaigns: #{e}" end -~~~ +``` ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} @@ -3764,11 +3764,11 @@ <a name="get_outbound_schedules_sequence"></a> -## -[**SequenceSchedule**](SequenceSchedule.html) get_outbound_schedules_sequence(sequence_id) +## [**SequenceSchedule**](SequenceSchedule.html) get_outbound_schedules_sequence(sequence_id) Get a dialer sequence schedule. @@ -3780,11 +3780,11 @@ * outbound:schedule:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3806,11 +3806,11 @@ result = api_instance.get_outbound_schedules_sequence(sequence_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_schedules_sequence: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3829,11 +3829,11 @@ <a name="get_outbound_schedules_sequences"></a> -## -[**Array&lt;SequenceSchedule&gt;**](SequenceSchedule.html) get_outbound_schedules_sequences +## [**Array&lt;SequenceSchedule&gt;**](SequenceSchedule.html) get_outbound_schedules_sequences Query for a list of dialer sequence schedules. @@ -3845,11 +3845,11 @@ * outbound:schedule:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3868,11 +3868,11 @@ result = api_instance.get_outbound_schedules_sequences p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_schedules_sequences: #{e}" end -~~~ +``` ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} @@ -3888,11 +3888,11 @@ <a name="get_outbound_sequence"></a> -## -[**CampaignSequence**](CampaignSequence.html) get_outbound_sequence(sequence_id) +## [**CampaignSequence**](CampaignSequence.html) get_outbound_sequence(sequence_id) Get a dialer campaign sequence. @@ -3904,11 +3904,11 @@ * outbound:campaignSequence:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -3930,11 +3930,11 @@ result = api_instance.get_outbound_sequence(sequence_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_sequence: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -3953,11 +3953,11 @@ <a name="get_outbound_sequences"></a> -## -[**CampaignSequenceEntityListing**](CampaignSequenceEntityListing.html) get_outbound_sequences(opts) +## [**CampaignSequenceEntityListing**](CampaignSequenceEntityListing.html) get_outbound_sequences(opts) Query a list of dialer campaign sequences. @@ -3969,11 +3969,11 @@ * outbound:campaignSequence:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4001,11 +4001,11 @@ result = api_instance.get_outbound_sequences(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_sequences: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4029,11 +4029,11 @@ <a name="get_outbound_settings"></a> -## -[**OutboundSettings**](OutboundSettings.html) get_outbound_settings +## [**OutboundSettings**](OutboundSettings.html) get_outbound_settings Get the outbound settings for this organization @@ -4045,11 +4045,11 @@ * outbound:settings:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4068,11 +4068,11 @@ result = api_instance.get_outbound_settings p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_settings: #{e}" end -~~~ +``` ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} @@ -4088,11 +4088,11 @@ <a name="get_outbound_wrapupcodemappings"></a> -## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) get_outbound_wrapupcodemappings +## [**WrapUpCodeMapping**](WrapUpCodeMapping.html) get_outbound_wrapupcodemappings Get the Dialer wrap up code mapping. @@ -4104,11 +4104,11 @@ * outbound:wrapUpCodeMapping:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4127,11 +4127,11 @@ result = api_instance.get_outbound_wrapupcodemappings p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_outbound_wrapupcodemappings: #{e}" end -~~~ +``` ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} @@ -4147,11 +4147,11 @@ <a name="patch_outbound_settings"></a> -## - patch_outbound_settings(body) +## patch_outbound_settings(body) Update the outbound settings for this organization @@ -4163,11 +4163,11 @@ * outbound:settings:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4188,11 +4188,11 @@ #Update the outbound settings for this organization api_instance.patch_outbound_settings(body) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->patch_outbound_settings: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4211,11 +4211,11 @@ <a name="post_outbound_attemptlimits"></a> -## -[**AttemptLimits**](AttemptLimits.html) post_outbound_attemptlimits(body) +## [**AttemptLimits**](AttemptLimits.html) post_outbound_attemptlimits(body) Create attempt limits @@ -4227,11 +4227,11 @@ * outbound:attemptLimits:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4253,11 +4253,11 @@ result = api_instance.post_outbound_attemptlimits(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_attemptlimits: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4276,11 +4276,11 @@ <a name="post_outbound_audits"></a> -## -[**AuditSearchResult**](AuditSearchResult.html) post_outbound_audits(body, opts) +## [**AuditSearchResult**](AuditSearchResult.html) post_outbound_audits(body, opts) Retrieves audits for dialer. @@ -4292,11 +4292,11 @@ * outbound:audit:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4325,11 +4325,11 @@ result = api_instance.post_outbound_audits(body, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_audits: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4353,11 +4353,11 @@ <a name="post_outbound_callabletimesets"></a> -## -[**CallableTimeSet**](CallableTimeSet.html) post_outbound_callabletimesets(body) +## [**CallableTimeSet**](CallableTimeSet.html) post_outbound_callabletimesets(body) Create callable time set @@ -4369,11 +4369,11 @@ * outbound:callableTimeSet:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4395,11 +4395,11 @@ result = api_instance.post_outbound_callabletimesets(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_callabletimesets: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4418,11 +4418,11 @@ <a name="post_outbound_callanalysisresponsesets"></a> -## -[**ResponseSet**](ResponseSet.html) post_outbound_callanalysisresponsesets(body) +## [**ResponseSet**](ResponseSet.html) post_outbound_callanalysisresponsesets(body) Create a dialer call analysis response set. @@ -4434,11 +4434,11 @@ * outbound:responseSet:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4460,11 +4460,11 @@ result = api_instance.post_outbound_callanalysisresponsesets(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_callanalysisresponsesets: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4483,11 +4483,11 @@ <a name="post_outbound_campaign_callback_schedule"></a> -## -[**ContactCallbackRequest**](ContactCallbackRequest.html) post_outbound_campaign_callback_schedule(campaign_id, body) +## [**ContactCallbackRequest**](ContactCallbackRequest.html) post_outbound_campaign_callback_schedule(campaign_id, body) <span style="background-color: #f0ad4e;display: inline-block;padding: 7px;font-weight: bold;line-height: 1;color: #ffffff;text-align: center;white-space: nowrap;vertical-align: baseline;border-radius: .25em;margin: 10px 0;">DEPRECATED</span> Schedule a Callback for a Dialer Campaign (Deprecated) @@ -4498,11 +4498,11 @@ Requires NO permissions: ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4526,11 +4526,11 @@ result = api_instance.post_outbound_campaign_callback_schedule(campaign_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_campaign_callback_schedule: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4550,11 +4550,11 @@ <a name="post_outbound_campaignrules"></a> -## -[**CampaignRule**](CampaignRule.html) post_outbound_campaignrules(body) +## [**CampaignRule**](CampaignRule.html) post_outbound_campaignrules(body) Create Campaign Rule @@ -4566,11 +4566,11 @@ * outbound:campaignRule:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4592,11 +4592,11 @@ result = api_instance.post_outbound_campaignrules(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_campaignrules: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4615,11 +4615,11 @@ <a name="post_outbound_campaigns"></a> -## -[**Campaign**](Campaign.html) post_outbound_campaigns(body) +## [**Campaign**](Campaign.html) post_outbound_campaigns(body) Create a campaign. @@ -4631,11 +4631,11 @@ * outbound:campaign:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4657,11 +4657,11 @@ result = api_instance.post_outbound_campaigns(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_campaigns: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4680,11 +4680,11 @@ <a name="post_outbound_campaigns_progress"></a> -## -[**Array&lt;CampaignProgress&gt;**](CampaignProgress.html) post_outbound_campaigns_progress(body) +## [**Array&lt;CampaignProgress&gt;**](CampaignProgress.html) post_outbound_campaigns_progress(body) Get progress for a list of campaigns @@ -4696,11 +4696,11 @@ * outbound:campaign:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4722,11 +4722,11 @@ result = api_instance.post_outbound_campaigns_progress(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_campaigns_progress: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4745,11 +4745,11 @@ <a name="post_outbound_contactlist_clear"></a> -## - post_outbound_contactlist_clear(contact_list_id) +## post_outbound_contactlist_clear(contact_list_id) Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled. @@ -4761,11 +4761,11 @@ * outbound:contact:delete ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4786,11 +4786,11 @@ #Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled. api_instance.post_outbound_contactlist_clear(contact_list_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_contactlist_clear: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4809,11 +4809,11 @@ <a name="post_outbound_contactlist_contacts"></a> -## -[**Array&lt;DialerContact&gt;**](DialerContact.html) post_outbound_contactlist_contacts(contact_list_id, body, opts) +## [**Array&lt;DialerContact&gt;**](DialerContact.html) post_outbound_contactlist_contacts(contact_list_id, body, opts) Add contacts to a contact list. @@ -4825,11 +4825,11 @@ * outbound:contact:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4858,11 +4858,11 @@ result = api_instance.post_outbound_contactlist_contacts(contact_list_id, body, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_contactlist_contacts: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4885,11 +4885,11 @@ <a name="post_outbound_contactlist_contacts_bulk"></a> -## -[**Array&lt;DialerContact&gt;**](DialerContact.html) post_outbound_contactlist_contacts_bulk(contact_list_id, body) +## [**Array&lt;DialerContact&gt;**](DialerContact.html) post_outbound_contactlist_contacts_bulk(contact_list_id, body) Get contacts from a contact list. @@ -4901,11 +4901,11 @@ * outbound:contact:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4929,11 +4929,11 @@ result = api_instance.post_outbound_contactlist_contacts_bulk(contact_list_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_contactlist_contacts_bulk: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -4953,11 +4953,11 @@ <a name="post_outbound_contactlist_export"></a> -## -[**UriReference**](UriReference.html) post_outbound_contactlist_export(contact_list_id) +## [**UriReference**](UriReference.html) post_outbound_contactlist_export(contact_list_id) Initiate the export of a contact list. @@ -4970,11 +4970,11 @@ * outbound:contact:view * outbound:contactList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -4996,11 +4996,11 @@ result = api_instance.post_outbound_contactlist_export(contact_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_contactlist_export: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5019,11 +5019,11 @@ <a name="post_outbound_contactlistfilters"></a> -## -[**ContactListFilter**](ContactListFilter.html) post_outbound_contactlistfilters(body) +## [**ContactListFilter**](ContactListFilter.html) post_outbound_contactlistfilters(body) Create Contact List Filter @@ -5035,11 +5035,11 @@ * outbound:contactListFilter:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5061,11 +5061,11 @@ result = api_instance.post_outbound_contactlistfilters(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_contactlistfilters: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5084,11 +5084,11 @@ <a name="post_outbound_contactlistfilters_preview"></a> -## -[**FilterPreviewResponse**](FilterPreviewResponse.html) post_outbound_contactlistfilters_preview(body) +## [**FilterPreviewResponse**](FilterPreviewResponse.html) post_outbound_contactlistfilters_preview(body) Get a preview of the output of a contact list filter @@ -5100,11 +5100,11 @@ * outbound:contact:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5126,11 +5126,11 @@ result = api_instance.post_outbound_contactlistfilters_preview(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_contactlistfilters_preview: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5149,11 +5149,11 @@ <a name="post_outbound_contactlists"></a> -## -[**ContactList**](ContactList.html) post_outbound_contactlists(body) +## [**ContactList**](ContactList.html) post_outbound_contactlists(body) Create a contact List. @@ -5165,11 +5165,11 @@ * outbound:contactList:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5191,11 +5191,11 @@ result = api_instance.post_outbound_contactlists(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_contactlists: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5214,11 +5214,11 @@ <a name="post_outbound_conversation_dnc"></a> -## - post_outbound_conversation_dnc(conversation_id) +## post_outbound_conversation_dnc(conversation_id) Add phone numbers to a Dialer DNC list. @@ -5230,11 +5230,11 @@ * outbound:dnc:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5255,11 +5255,11 @@ #Add phone numbers to a Dialer DNC list. api_instance.post_outbound_conversation_dnc(conversation_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_conversation_dnc: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5278,11 +5278,11 @@ <a name="post_outbound_dnclist_export"></a> -## -[**UriReference**](UriReference.html) post_outbound_dnclist_export(dnc_list_id) +## [**UriReference**](UriReference.html) post_outbound_dnclist_export(dnc_list_id) Initiate the export of a dnc list. @@ -5295,11 +5295,11 @@ * outbound:dnc:view * outbound:dncList:view ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5321,11 +5321,11 @@ result = api_instance.post_outbound_dnclist_export(dnc_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_dnclist_export: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5344,11 +5344,11 @@ <a name="post_outbound_dnclist_phonenumbers"></a> -## - post_outbound_dnclist_phonenumbers(dnc_list_id, body) +## post_outbound_dnclist_phonenumbers(dnc_list_id, body) Add phone numbers to a Dialer DNC list. @@ -5360,11 +5360,11 @@ * outbound:dnc:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5387,11 +5387,11 @@ #Add phone numbers to a Dialer DNC list. api_instance.post_outbound_dnclist_phonenumbers(dnc_list_id, body) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_dnclist_phonenumbers: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5411,11 +5411,11 @@ <a name="post_outbound_dnclists"></a> -## -[**DncList**](DncList.html) post_outbound_dnclists(body) +## [**DncList**](DncList.html) post_outbound_dnclists(body) Create dialer DNC list @@ -5427,11 +5427,11 @@ * outbound:dncList:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5453,11 +5453,11 @@ result = api_instance.post_outbound_dnclists(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_dnclists: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5476,11 +5476,11 @@ <a name="post_outbound_rulesets"></a> -## -[**RuleSet**](RuleSet.html) post_outbound_rulesets(body) +## [**RuleSet**](RuleSet.html) post_outbound_rulesets(body) Create a Dialer Call Analysis Response Set. @@ -5492,11 +5492,11 @@ * outbound:ruleSet:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5518,11 +5518,11 @@ result = api_instance.post_outbound_rulesets(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_rulesets: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5541,11 +5541,11 @@ <a name="post_outbound_sequences"></a> -## -[**CampaignSequence**](CampaignSequence.html) post_outbound_sequences(body) +## [**CampaignSequence**](CampaignSequence.html) post_outbound_sequences(body) Create a new campaign sequence. @@ -5557,11 +5557,11 @@ * outbound:campaignSequence:add ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5583,11 +5583,11 @@ result = api_instance.post_outbound_sequences(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_outbound_sequences: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5606,11 +5606,11 @@ <a name="put_outbound_attemptlimit"></a> -## -[**AttemptLimits**](AttemptLimits.html) put_outbound_attemptlimit(attempt_limits_id, body) +## [**AttemptLimits**](AttemptLimits.html) put_outbound_attemptlimit(attempt_limits_id, body) Update attempt limits @@ -5622,11 +5622,11 @@ * outbound:attemptLimits:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5650,11 +5650,11 @@ result = api_instance.put_outbound_attemptlimit(attempt_limits_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_attemptlimit: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5674,11 +5674,11 @@ <a name="put_outbound_callabletimeset"></a> -## -[**CallableTimeSet**](CallableTimeSet.html) put_outbound_callabletimeset(callable_time_set_id, body) +## [**CallableTimeSet**](CallableTimeSet.html) put_outbound_callabletimeset(callable_time_set_id, body) Update callable time set @@ -5690,11 +5690,11 @@ * outbound:callableTimeSet:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5718,11 +5718,11 @@ result = api_instance.put_outbound_callabletimeset(callable_time_set_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_callabletimeset: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5742,11 +5742,11 @@ <a name="put_outbound_callanalysisresponseset"></a> -## -[**ResponseSet**](ResponseSet.html) put_outbound_callanalysisresponseset(call_analysis_set_id, body) +## [**ResponseSet**](ResponseSet.html) put_outbound_callanalysisresponseset(call_analysis_set_id, body) Update a dialer call analysis response set. @@ -5758,11 +5758,11 @@ * outbound:responseSet:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5786,11 +5786,11 @@ result = api_instance.put_outbound_callanalysisresponseset(call_analysis_set_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_callanalysisresponseset: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5810,11 +5810,11 @@ <a name="put_outbound_campaign"></a> -## -[**Campaign**](Campaign.html) put_outbound_campaign(campaign_id, body) +## [**Campaign**](Campaign.html) put_outbound_campaign(campaign_id, body) Update a campaign. @@ -5826,11 +5826,11 @@ * outbound:campaign:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5854,11 +5854,11 @@ result = api_instance.put_outbound_campaign(campaign_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_campaign: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5878,11 +5878,11 @@ <a name="put_outbound_campaign_agent"></a> -## -String** put_outbound_campaign_agent(campaign_id, user_id, body) +## String** put_outbound_campaign_agent(campaign_id, user_id, body) Send notification that an agent's state changed @@ -5893,11 +5893,11 @@ Requires NO permissions: ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5923,11 +5923,11 @@ result = api_instance.put_outbound_campaign_agent(campaign_id, user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_campaign_agent: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -5948,11 +5948,11 @@ <a name="put_outbound_campaignrule"></a> -## -[**CampaignRule**](CampaignRule.html) put_outbound_campaignrule(campaign_rule_id, body) +## [**CampaignRule**](CampaignRule.html) put_outbound_campaignrule(campaign_rule_id, body) Update Campaign Rule @@ -5964,11 +5964,11 @@ * outbound:campaignRule:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -5992,11 +5992,11 @@ result = api_instance.put_outbound_campaignrule(campaign_rule_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_campaignrule: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -6016,11 +6016,11 @@ <a name="put_outbound_contactlist"></a> -## -[**ContactList**](ContactList.html) put_outbound_contactlist(contact_list_id, body) +## [**ContactList**](ContactList.html) put_outbound_contactlist(contact_list_id, body) Update a contact list. @@ -6032,11 +6032,11 @@ * outbound:contactList:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -6060,11 +6060,11 @@ result = api_instance.put_outbound_contactlist(contact_list_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_contactlist: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -6084,11 +6084,11 @@ <a name="put_outbound_contactlist_contact"></a> -## -[**DialerContact**](DialerContact.html) put_outbound_contactlist_contact(contact_list_id, contact_id, body) +## [**DialerContact**](DialerContact.html) put_outbound_contactlist_contact(contact_list_id, contact_id, body) Update a contact. @@ -6100,11 +6100,11 @@ * outbound:contact:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -6130,11 +6130,11 @@ result = api_instance.put_outbound_contactlist_contact(contact_list_id, contact_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_contactlist_contact: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -6155,11 +6155,11 @@ <a name="put_outbound_contactlistfilter"></a> -## -[**ContactListFilter**](ContactListFilter.html) put_outbound_contactlistfilter(contact_list_filter_id, body) +## [**ContactListFilter**](ContactListFilter.html) put_outbound_contactlistfilter(contact_list_filter_id, body) Update Contact List Filter @@ -6171,11 +6171,11 @@ * outbound:contactListFilter:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -6199,11 +6199,11 @@ result = api_instance.put_outbound_contactlistfilter(contact_list_filter_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_contactlistfilter: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -6223,11 +6223,11 @@ <a name="put_outbound_dnclist"></a> -## -[**DncList**](DncList.html) put_outbound_dnclist(dnc_list_id, body) +## [**DncList**](DncList.html) put_outbound_dnclist(dnc_list_id, body) Update dialer DNC list @@ -6239,11 +6239,11 @@ * outbound:dncList:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -6267,11 +6267,11 @@ result = api_instance.put_outbound_dnclist(dnc_list_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_dnclist: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -6291,11 +6291,11 @@ <a name="put_outbound_ruleset"></a> -## -[**RuleSet**](RuleSet.html) put_outbound_ruleset(rule_set_id, body) +## [**RuleSet**](RuleSet.html) put_outbound_ruleset(rule_set_id, body) Update a RuleSet. @@ -6307,11 +6307,11 @@ * outbound:ruleSet:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -6335,11 +6335,11 @@ result = api_instance.put_outbound_ruleset(rule_set_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_ruleset: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -6359,11 +6359,11 @@ <a name="put_outbound_schedules_campaign"></a> -## -[**CampaignSchedule**](CampaignSchedule.html) put_outbound_schedules_campaign(campaign_id, body) +## [**CampaignSchedule**](CampaignSchedule.html) put_outbound_schedules_campaign(campaign_id, body) Update a new campaign schedule. @@ -6375,11 +6375,11 @@ * outbound:schedule:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -6403,11 +6403,11 @@ result = api_instance.put_outbound_schedules_campaign(campaign_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_schedules_campaign: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -6427,11 +6427,11 @@ <a name="put_outbound_schedules_sequence"></a> -## -[**SequenceSchedule**](SequenceSchedule.html) put_outbound_schedules_sequence(sequence_id, body) +## [**SequenceSchedule**](SequenceSchedule.html) put_outbound_schedules_sequence(sequence_id, body) Update a new sequence schedule. @@ -6443,11 +6443,11 @@ * outbound:schedule:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -6471,11 +6471,11 @@ result = api_instance.put_outbound_schedules_sequence(sequence_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_schedules_sequence: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -6495,11 +6495,11 @@ <a name="put_outbound_sequence"></a> -## -[**CampaignSequence**](CampaignSequence.html) put_outbound_sequence(sequence_id, body) +## [**CampaignSequence**](CampaignSequence.html) put_outbound_sequence(sequence_id, body) Update a new campaign sequence. @@ -6511,11 +6511,11 @@ * outbound:campaignSequence:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -6539,11 +6539,11 @@ result = api_instance.put_outbound_sequence(sequence_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_sequence: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -6563,11 +6563,11 @@ <a name="put_outbound_wrapupcodemappings"></a> -## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) put_outbound_wrapupcodemappings(body) +## [**WrapUpCodeMapping**](WrapUpCodeMapping.html) put_outbound_wrapupcodemappings(body) Update the Dialer wrap up code mapping. @@ -6579,11 +6579,11 @@ * outbound:wrapUpCodeMapping:edit ### Example -~~~ruby +```{"language":"ruby"} # load the gem require 'purecloudplatformclientv2' # setup authorization @secret = ENV['PURECLOUD_SECRET'] @id = ENV['PURECLOUD_CLIENT_ID'] @@ -6605,10 +6605,10 @@ result = api_instance.put_outbound_wrapupcodemappings(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_outbound_wrapupcodemappings: #{e}" end -~~~ +``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | -------------