docs/OutboundApi.md in purecloudplatformclientv2-34.0.0 vs docs/OutboundApi.md in purecloudplatformclientv2-35.0.0

- old
+ new

@@ -36,10 +36,11 @@ [**get_outbound_campaign_progress**](OutboundApi.html#get_outbound_campaign_progress) | Get campaign progress [**get_outbound_campaign_stats**](OutboundApi.html#get_outbound_campaign_stats) | Get statistics about a Dialer Campaign [**get_outbound_campaignrule**](OutboundApi.html#get_outbound_campaignrule) | Get Campaign Rule [**get_outbound_campaignrules**](OutboundApi.html#get_outbound_campaignrules) | Query Campaign Rule list [**get_outbound_campaigns**](OutboundApi.html#get_outbound_campaigns) | Query a list of dialer campaigns. +[**get_outbound_campaigns_divisionviews**](OutboundApi.html#get_outbound_campaigns_divisionviews) | Query a list of basic Campaign information objects [**get_outbound_contactlist**](OutboundApi.html#get_outbound_contactlist) | Get a dialer contact list. [**get_outbound_contactlist_contact**](OutboundApi.html#get_outbound_contactlist_contact) | Get a contact. [**get_outbound_contactlist_export**](OutboundApi.html#get_outbound_contactlist_export) | Get the URI of a contact list export. [**get_outbound_contactlist_importstatus**](OutboundApi.html#get_outbound_contactlist_importstatus) | Get dialer contactList import status. [**get_outbound_contactlistfilter**](OutboundApi.html#get_outbound_contactlistfilter) | Get Contact list filter @@ -101,17 +102,23 @@ <a name="delete_outbound_attemptlimit"></a> ## - delete_outbound_attemptlimit(attempt_limits_id) + + Delete attempt limits Wraps DELETE /api/v2/outbound/attemptlimits/{attemptLimitsId} +Requires ANY permissions: +* outbound:attemptLimits:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -159,17 +166,23 @@ <a name="delete_outbound_callabletimeset"></a> ## - delete_outbound_callabletimeset(callable_time_set_id) + + Delete callable time set Wraps DELETE /api/v2/outbound/callabletimesets/{callableTimeSetId} +Requires ANY permissions: +* outbound:callableTimeSet:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -217,17 +230,23 @@ <a name="delete_outbound_callanalysisresponseset"></a> ## - delete_outbound_callanalysisresponseset(call_analysis_set_id) + + Delete a dialer call analysis response set. Wraps DELETE /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} +Requires ANY permissions: +* outbound:responseSet:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -275,17 +294,23 @@ <a name="delete_outbound_campaign"></a> ## -[**Campaign**](Campaign.html) delete_outbound_campaign(campaign_id) + + Delete a campaign. Wraps DELETE /api/v2/outbound/campaigns/{campaignId} +Requires ANY permissions: +* outbound:campaign:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -334,17 +359,23 @@ <a name="delete_outbound_campaign_progress"></a> ## - delete_outbound_campaign_progress(campaign_id) + + Reset campaign progress and recycle the campaign Wraps DELETE /api/v2/outbound/campaigns/{campaignId}/progress +Requires ANY permissions: +* outbound:campaign:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -392,17 +423,23 @@ <a name="delete_outbound_campaignrule"></a> ## - delete_outbound_campaignrule(campaign_rule_id) + + Delete Campaign Rule Wraps DELETE /api/v2/outbound/campaignrules/{campaignRuleId} +Requires ANY permissions: +* outbound:campaignRule:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -450,17 +487,23 @@ <a name="delete_outbound_contactlist"></a> ## - delete_outbound_contactlist(contact_list_id) + + Delete a contact list. Wraps DELETE /api/v2/outbound/contactlists/{contactListId} +Requires ANY permissions: +* outbound:contactList:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -508,17 +551,23 @@ <a name="delete_outbound_contactlist_contact"></a> ## - delete_outbound_contactlist_contact(contact_list_id, contact_id) + + Delete a contact. Wraps DELETE /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} +Requires ANY permissions: +* outbound:contact:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -569,17 +618,23 @@ <a name="delete_outbound_contactlist_contacts"></a> ## - delete_outbound_contactlist_contacts(contact_list_id, contact_ids) + + Delete contacts from a contact list. Wraps DELETE /api/v2/outbound/contactlists/{contactListId}/contacts +Requires ANY permissions: +* outbound:contact:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -630,17 +685,23 @@ <a name="delete_outbound_contactlistfilter"></a> ## - delete_outbound_contactlistfilter(contact_list_filter_id) + + Delete Contact List Filter Wraps DELETE /api/v2/outbound/contactlistfilters/{contactListFilterId} +Requires ANY permissions: +* outbound:contactListFilter:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -688,17 +749,23 @@ <a name="delete_outbound_contactlists"></a> ## - delete_outbound_contactlists(id) + + Delete multiple contact lists. Wraps DELETE /api/v2/outbound/contactlists +Requires ANY permissions: +* outbound:contactList:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -746,17 +813,23 @@ <a name="delete_outbound_dnclist"></a> ## - delete_outbound_dnclist(dnc_list_id) + + Delete dialer DNC list Wraps DELETE /api/v2/outbound/dnclists/{dncListId} +Requires ANY permissions: +* outbound:dncList:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -804,17 +877,23 @@ <a name="delete_outbound_ruleset"></a> ## - delete_outbound_ruleset(rule_set_id) + + Delete a Rule set. Wraps DELETE /api/v2/outbound/rulesets/{ruleSetId} +Requires ANY permissions: +* outbound:ruleSet:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -862,17 +941,23 @@ <a name="delete_outbound_schedules_campaign"></a> ## - delete_outbound_schedules_campaign(campaign_id) + + Delete a dialer campaign schedule. Wraps DELETE /api/v2/outbound/schedules/campaigns/{campaignId} +Requires ANY permissions: +* outbound:schedule:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -920,17 +1005,23 @@ <a name="delete_outbound_schedules_sequence"></a> ## - delete_outbound_schedules_sequence(sequence_id) + + Delete a dialer sequence schedule. Wraps DELETE /api/v2/outbound/schedules/sequences/{sequenceId} +Requires ANY permissions: +* outbound:schedule:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -978,17 +1069,23 @@ <a name="delete_outbound_sequence"></a> ## - delete_outbound_sequence(sequence_id) + + Delete a dialer campaign sequence. Wraps DELETE /api/v2/outbound/sequences/{sequenceId} +Requires ANY permissions: +* outbound:campaignSequence:delete + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1036,17 +1133,23 @@ <a name="get_outbound_attemptlimit"></a> ## -[**AttemptLimits**](AttemptLimits.html) get_outbound_attemptlimit(attempt_limits_id) + + Get attempt limits Wraps GET /api/v2/outbound/attemptlimits/{attemptLimitsId} +Requires ANY permissions: +* outbound:attemptLimits:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1095,17 +1198,23 @@ <a name="get_outbound_attemptlimits"></a> ## -[**AttemptLimitsEntityListing**](AttemptLimitsEntityListing.html) get_outbound_attemptlimits(opts) + + Query attempt limits list Wraps GET /api/v2/outbound/attemptlimits +Requires ANY permissions: +* outbound:attemptLimits:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1165,17 +1274,23 @@ <a name="get_outbound_callabletimeset"></a> ## -[**CallableTimeSet**](CallableTimeSet.html) get_outbound_callabletimeset(callable_time_set_id) + + Get callable time set Wraps GET /api/v2/outbound/callabletimesets/{callableTimeSetId} +Requires ANY permissions: +* outbound:callableTimeSet:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1224,17 +1339,23 @@ <a name="get_outbound_callabletimesets"></a> ## -[**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html) get_outbound_callabletimesets(opts) + + Query callable time set list Wraps GET /api/v2/outbound/callabletimesets +Requires ANY permissions: +* outbound:callableTimeSet:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1294,17 +1415,23 @@ <a name="get_outbound_callanalysisresponseset"></a> ## -[**ResponseSet**](ResponseSet.html) get_outbound_callanalysisresponseset(call_analysis_set_id) + + Get a dialer call analysis response set. Wraps GET /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} +Requires ANY permissions: +* outbound:responseSet:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1353,17 +1480,23 @@ <a name="get_outbound_callanalysisresponsesets"></a> ## -[**ResponseSetEntityListing**](ResponseSetEntityListing.html) get_outbound_callanalysisresponsesets(opts) + + Query a list of dialer call analysis response sets. Wraps GET /api/v2/outbound/callanalysisresponsesets +Requires ANY permissions: +* outbound:responseSet:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1423,17 +1556,23 @@ <a name="get_outbound_campaign"></a> ## -[**Campaign**](Campaign.html) get_outbound_campaign(campaign_id) + + Get dialer campaign. Wraps GET /api/v2/outbound/campaigns/{campaignId} +Requires ANY permissions: +* outbound:campaign:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1482,17 +1621,23 @@ <a name="get_outbound_campaign_diagnostics"></a> ## -[**CampaignDiagnostics**](CampaignDiagnostics.html) get_outbound_campaign_diagnostics(campaign_id) + + Get campaign diagnostics Wraps GET /api/v2/outbound/campaigns/{campaignId}/diagnostics +Requires ANY permissions: +* outbound:campaign:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1541,17 +1686,23 @@ <a name="get_outbound_campaign_interactions"></a> ## -[**CampaignInteractions**](CampaignInteractions.html) get_outbound_campaign_interactions(campaign_id) + + Get dialer campaign interactions. Wraps GET /api/v2/outbound/campaigns/{campaignId}/interactions +Requires ANY permissions: +* outbound:campaign:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1600,17 +1751,23 @@ <a name="get_outbound_campaign_progress"></a> ## -[**CampaignProgress**](CampaignProgress.html) get_outbound_campaign_progress(campaign_id) + + Get campaign progress Wraps GET /api/v2/outbound/campaigns/{campaignId}/progress +Requires ANY permissions: +* outbound:campaign:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1659,17 +1816,23 @@ <a name="get_outbound_campaign_stats"></a> ## -[**CampaignStats**](CampaignStats.html) get_outbound_campaign_stats(campaign_id) + + Get statistics about a Dialer Campaign Wraps GET /api/v2/outbound/campaigns/{campaignId}/stats +Requires ANY permissions: +* outbound:campaign:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1718,17 +1881,23 @@ <a name="get_outbound_campaignrule"></a> ## -[**CampaignRule**](CampaignRule.html) get_outbound_campaignrule(campaign_rule_id) + + Get Campaign Rule Wraps GET /api/v2/outbound/campaignrules/{campaignRuleId} +Requires ANY permissions: +* outbound:campaignRule:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1777,17 +1946,23 @@ <a name="get_outbound_campaignrules"></a> ## -[**CampaignRuleEntityListing**](CampaignRuleEntityListing.html) get_outbound_campaignrules(opts) + + Query Campaign Rule list Wraps GET /api/v2/outbound/campaignrules +Requires ANY permissions: +* outbound:campaignRule:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1847,17 +2022,23 @@ <a name="get_outbound_campaigns"></a> ## -[**CampaignEntityListing**](CampaignEntityListing.html) get_outbound_campaigns(opts) + + Query a list of dialer campaigns. Wraps GET /api/v2/outbound/campaigns +Requires ANY permissions: +* outbound:campaign:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1925,21 +2106,103 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_outbound_campaigns_divisionviews"></a> + +## -[**CampaignDivisionViewListing**](CampaignDivisionViewListing.html) get_outbound_campaigns_divisionviews(opts) + + + +Query a list of basic Campaign information objects + +This returns a simplified version of a Campaign, consisting of name and division. + +Wraps GET /api/v2/outbound/campaigns/divisionviews + +Requires ANY permissions: + +* outbound:campaign:search + + +### Example +~~~ruby +# load the gem +require 'purecloudplatformclientv2' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::OutboundApi.new + +opts = { + page_size: 25, # Integer | Page size + page_number: 1, # Integer | Page number + filter_type: "Prefix", # String | Filter type + name: "name_example", # String | Name + sort_by: "sort_by_example", # String | Sort by + sort_order: "a" # String | Sort order +} + +begin + #Query a list of basic Campaign information objects + 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 +------------- | ------------- | ------------- | ------------- + **page_size** | **Integer**| Page size | [optional] [default to 25] | + **page_number** | **Integer**| Page number | [optional] [default to 1] | + **filter_type** | **String**| Filter type | [optional] [default to Prefix]<br />**Values**: Equals, RegEx, Contains, Prefix, LessThan, LessThanEqualTo, GreaterThan, GreaterThanEqualTo, BeginsWith, EndsWith | + **name** | **String**| Name | [optional] | + **sort_by** | **String**| Sort by | [optional] | + **sort_order** | **String**| Sort order | [optional] [default to a]<br />**Values**: ascending, descending | +{: class="table table-striped"} + + +### Return type + +[**CampaignDivisionViewListing**](CampaignDivisionViewListing.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + <a name="get_outbound_contactlist"></a> ## -[**ContactList**](ContactList.html) get_outbound_contactlist(contact_list_id, opts) + + Get a dialer contact list. Wraps GET /api/v2/outbound/contactlists/{contactListId} +Requires ANY permissions: +* outbound:contactList:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -1994,17 +2257,23 @@ <a name="get_outbound_contactlist_contact"></a> ## -[**DialerContact**](DialerContact.html) get_outbound_contactlist_contact(contact_list_id, contact_id) + + Get a contact. Wraps GET /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} +Requires ANY permissions: +* outbound:contact:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2056,17 +2325,23 @@ <a name="get_outbound_contactlist_export"></a> ## -[**ExportUri**](ExportUri.html) get_outbound_contactlist_export(contact_list_id, opts) + + Get the URI of a contact list export. Wraps GET /api/v2/outbound/contactlists/{contactListId}/export +Requires ALL permissions: +* outbound:contact:view* outbound:contactList:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2119,17 +2394,23 @@ <a name="get_outbound_contactlist_importstatus"></a> ## -[**ImportStatus**](ImportStatus.html) get_outbound_contactlist_importstatus(contact_list_id) + + Get dialer contactList import status. Wraps GET /api/v2/outbound/contactlists/{contactListId}/importstatus +Requires ANY permissions: +* outbound:contactList:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2178,17 +2459,23 @@ <a name="get_outbound_contactlistfilter"></a> ## -[**ContactListFilter**](ContactListFilter.html) get_outbound_contactlistfilter(contact_list_filter_id) + + Get Contact list filter Wraps GET /api/v2/outbound/contactlistfilters/{contactListFilterId} +Requires ANY permissions: +* outbound:contactListFilter:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2237,17 +2524,23 @@ <a name="get_outbound_contactlistfilters"></a> ## -[**ContactListFilterEntityListing**](ContactListFilterEntityListing.html) get_outbound_contactlistfilters(opts) + + Query Contact list filters Wraps GET /api/v2/outbound/contactlistfilters +Requires ANY permissions: +* outbound:contactListFilter:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2309,17 +2602,23 @@ <a name="get_outbound_contactlists"></a> ## -[**ContactListEntityListing**](ContactListEntityListing.html) get_outbound_contactlists(opts) + + Query a list of contact lists. Wraps GET /api/v2/outbound/contactlists +Requires ANY permissions: +* outbound:contactList:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2385,17 +2684,23 @@ <a name="get_outbound_dnclist"></a> ## -[**DncList**](DncList.html) get_outbound_dnclist(dnc_list_id, opts) + + Get dialer DNC list Wraps GET /api/v2/outbound/dnclists/{dncListId} +Requires ANY permissions: +* outbound:dncList:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2450,17 +2755,23 @@ <a name="get_outbound_dnclist_export"></a> ## -[**ExportUri**](ExportUri.html) get_outbound_dnclist_export(dnc_list_id, opts) + + Get the URI of a DNC list export. Wraps GET /api/v2/outbound/dnclists/{dncListId}/export +Requires ALL permissions: +* outbound:dnc:view* outbound:dncList:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2513,17 +2824,23 @@ <a name="get_outbound_dnclist_importstatus"></a> ## -[**ImportStatus**](ImportStatus.html) get_outbound_dnclist_importstatus(dnc_list_id) + + Get dialer dncList import status. Wraps GET /api/v2/outbound/dnclists/{dncListId}/importstatus +Requires ANY permissions: +* outbound:dncList:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2572,17 +2889,23 @@ <a name="get_outbound_dnclists"></a> ## -[**DncListEntityListing**](DncListEntityListing.html) get_outbound_dnclists(opts) + + Query dialer DNC lists Wraps GET /api/v2/outbound/dnclists +Requires ANY permissions: +* outbound:dncList:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2646,17 +2969,23 @@ <a name="get_outbound_event"></a> ## -[**EventLog**](EventLog.html) get_outbound_event(event_id) + + Get Dialer Event Wraps GET /api/v2/outbound/events/{eventId} +Requires ANY permissions: +* outbound:eventLog:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2705,17 +3034,23 @@ <a name="get_outbound_events"></a> ## -[**DialerEventEntityListing**](DialerEventEntityListing.html) get_outbound_events(opts) + + Query Event Logs Wraps GET /api/v2/outbound/events +Requires ANY permissions: +* outbound:eventLog:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2777,17 +3112,23 @@ <a name="get_outbound_ruleset"></a> ## -[**RuleSet**](RuleSet.html) get_outbound_ruleset(rule_set_id) + + Get a Rule Set by ID. Wraps GET /api/v2/outbound/rulesets/{ruleSetId} +Requires ANY permissions: +* outbound:ruleSet:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2836,17 +3177,23 @@ <a name="get_outbound_rulesets"></a> ## -[**RuleSetEntityListing**](RuleSetEntityListing.html) get_outbound_rulesets(opts) + + Query a list of Rule Sets. Wraps GET /api/v2/outbound/rulesets +Requires ANY permissions: +* outbound:ruleSet:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2906,17 +3253,23 @@ <a name="get_outbound_schedules_campaign"></a> ## -[**CampaignSchedule**](CampaignSchedule.html) get_outbound_schedules_campaign(campaign_id) + + Get a dialer campaign schedule. Wraps GET /api/v2/outbound/schedules/campaigns/{campaignId} +Requires ANY permissions: +* outbound:schedule:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -2965,17 +3318,23 @@ <a name="get_outbound_schedules_campaigns"></a> ## -[**Array&lt;CampaignSchedule&gt;**](CampaignSchedule.html) get_outbound_schedules_campaigns + + Query for a list of dialer campaign schedules. Wraps GET /api/v2/outbound/schedules/campaigns +Requires ANY permissions: +* outbound:schedule:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3018,17 +3377,23 @@ <a name="get_outbound_schedules_sequence"></a> ## -[**SequenceSchedule**](SequenceSchedule.html) get_outbound_schedules_sequence(sequence_id) + + Get a dialer sequence schedule. Wraps GET /api/v2/outbound/schedules/sequences/{sequenceId} +Requires ANY permissions: +* outbound:schedule:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3077,17 +3442,23 @@ <a name="get_outbound_schedules_sequences"></a> ## -[**Array&lt;SequenceSchedule&gt;**](SequenceSchedule.html) get_outbound_schedules_sequences + + Query for a list of dialer sequence schedules. Wraps GET /api/v2/outbound/schedules/sequences +Requires ANY permissions: +* outbound:schedule:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3130,17 +3501,23 @@ <a name="get_outbound_sequence"></a> ## -[**CampaignSequence**](CampaignSequence.html) get_outbound_sequence(sequence_id) + + Get a dialer campaign sequence. Wraps GET /api/v2/outbound/sequences/{sequenceId} +Requires ANY permissions: +* outbound:campaignSequence:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3189,17 +3566,23 @@ <a name="get_outbound_sequences"></a> ## -[**CampaignSequenceEntityListing**](CampaignSequenceEntityListing.html) get_outbound_sequences(opts) + + Query a list of dialer campaign sequences. Wraps GET /api/v2/outbound/sequences +Requires ANY permissions: +* outbound:campaignSequence:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3259,17 +3642,23 @@ <a name="get_outbound_settings"></a> ## -[**OutboundSettings**](OutboundSettings.html) get_outbound_settings + + Get the outbound settings for this organization Wraps GET /api/v2/outbound/settings +Requires ANY permissions: +* outbound:settings:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3312,17 +3701,23 @@ <a name="get_outbound_wrapupcodemappings"></a> ## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) get_outbound_wrapupcodemappings + + Get the Dialer wrap up code mapping. Wraps GET /api/v2/outbound/wrapupcodemappings +Requires ANY permissions: +* outbound:wrapUpCodeMapping:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3365,17 +3760,23 @@ <a name="patch_outbound_settings"></a> ## - patch_outbound_settings(body) + + Update the outbound settings for this organization Wraps PATCH /api/v2/outbound/settings +Requires ANY permissions: +* outbound:settings:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3423,17 +3824,23 @@ <a name="post_outbound_attemptlimits"></a> ## -[**AttemptLimits**](AttemptLimits.html) post_outbound_attemptlimits(body) + + Create attempt limits Wraps POST /api/v2/outbound/attemptlimits +Requires ANY permissions: +* outbound:attemptLimits:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3482,17 +3889,23 @@ <a name="post_outbound_audits"></a> ## -[**AuditSearchResult**](AuditSearchResult.html) post_outbound_audits(body, opts) + + Retrieves audits for dialer. Wraps POST /api/v2/outbound/audits +Requires ANY permissions: +* outbound:audit:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3553,17 +3966,23 @@ <a name="post_outbound_callabletimesets"></a> ## -[**CallableTimeSet**](CallableTimeSet.html) post_outbound_callabletimesets(body) + + Create callable time set Wraps POST /api/v2/outbound/callabletimesets +Requires ANY permissions: +* outbound:callableTimeSet:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3612,17 +4031,23 @@ <a name="post_outbound_callanalysisresponsesets"></a> ## -[**ResponseSet**](ResponseSet.html) post_outbound_callanalysisresponsesets(body) + + Create a dialer call analysis response set. Wraps POST /api/v2/outbound/callanalysisresponsesets +Requires ANY permissions: +* outbound:responseSet:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3671,17 +4096,23 @@ <a name="post_outbound_campaign_callback_schedule"></a> ## -[**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) This endpoint is deprecated and may have unexpected results. Please use \"/conversations/{conversationId}/participants/{participantId}/callbacks instead.\" Wraps POST /api/v2/outbound/campaigns/{campaignId}/callback/schedule +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3733,17 +4164,23 @@ <a name="post_outbound_campaignrules"></a> ## -[**CampaignRule**](CampaignRule.html) post_outbound_campaignrules(body) + + Create Campaign Rule Wraps POST /api/v2/outbound/campaignrules +Requires ANY permissions: +* outbound:campaignRule:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3792,17 +4229,23 @@ <a name="post_outbound_campaigns"></a> ## -[**Campaign**](Campaign.html) post_outbound_campaigns(body) + + Create a campaign. Wraps POST /api/v2/outbound/campaigns +Requires ANY permissions: +* outbound:campaign:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3851,17 +4294,23 @@ <a name="post_outbound_campaigns_progress"></a> ## -[**Array&lt;CampaignProgress&gt;**](CampaignProgress.html) post_outbound_campaigns_progress(body) + + Get progress for a list of campaigns Wraps POST /api/v2/outbound/campaigns/progress +Requires ANY permissions: +* outbound:campaign:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3910,17 +4359,23 @@ <a name="post_outbound_contactlist_contacts"></a> ## -[**Array&lt;DialerContact&gt;**](DialerContact.html) post_outbound_contactlist_contacts(contact_list_id, body, opts) + + Add contacts to a contact list. Wraps POST /api/v2/outbound/contactlists/{contactListId}/contacts +Requires ANY permissions: +* outbound:contact:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -3980,17 +4435,23 @@ <a name="post_outbound_contactlist_contacts_bulk"></a> ## -[**Array&lt;DialerContact&gt;**](DialerContact.html) post_outbound_contactlist_contacts_bulk(contact_list_id, body) + + Get contacts from a contact list. Wraps POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk +Requires ANY permissions: +* outbound:contact:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4042,17 +4503,23 @@ <a name="post_outbound_contactlist_export"></a> ## -[**UriReference**](UriReference.html) post_outbound_contactlist_export(contact_list_id) + + Initiate the export of a contact list. Returns 200 if received OK. Wraps POST /api/v2/outbound/contactlists/{contactListId}/export +Requires ALL permissions: +* outbound:contact:view* outbound:contactList:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4101,17 +4568,23 @@ <a name="post_outbound_contactlistfilters"></a> ## -[**ContactListFilter**](ContactListFilter.html) post_outbound_contactlistfilters(body) + + Create Contact List Filter Wraps POST /api/v2/outbound/contactlistfilters +Requires ANY permissions: +* outbound:contactListFilter:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4160,17 +4633,23 @@ <a name="post_outbound_contactlistfilters_preview"></a> ## -[**FilterPreviewResponse**](FilterPreviewResponse.html) post_outbound_contactlistfilters_preview(body) + + Get a preview of the output of a contact list filter Wraps POST /api/v2/outbound/contactlistfilters/preview +Requires ANY permissions: +* outbound:contact:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4219,17 +4698,23 @@ <a name="post_outbound_contactlists"></a> ## -[**ContactList**](ContactList.html) post_outbound_contactlists(body) + + Create a contact List. Wraps POST /api/v2/outbound/contactlists +Requires ANY permissions: +* outbound:contactList:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4278,17 +4763,23 @@ <a name="post_outbound_conversation_dnc"></a> ## - post_outbound_conversation_dnc(conversation_id) + + Add phone numbers to a Dialer DNC list. Wraps POST /api/v2/outbound/conversations/{conversationId}/dnc +Requires ANY permissions: +* outbound:dnc:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4336,17 +4827,23 @@ <a name="post_outbound_dnclist_export"></a> ## -[**UriReference**](UriReference.html) post_outbound_dnclist_export(dnc_list_id) + + Initiate the export of a dnc list. Returns 200 if received OK. Wraps POST /api/v2/outbound/dnclists/{dncListId}/export +Requires ALL permissions: +* outbound:dnc:view* outbound:dncList:view + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4395,17 +4892,23 @@ <a name="post_outbound_dnclist_phonenumbers"></a> ## - post_outbound_dnclist_phonenumbers(dnc_list_id, body) + + Add phone numbers to a Dialer DNC list. Only Internal DNC lists may be appended to Wraps POST /api/v2/outbound/dnclists/{dncListId}/phonenumbers +Requires ANY permissions: +* outbound:dnc:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4456,17 +4959,23 @@ <a name="post_outbound_dnclists"></a> ## -[**DncList**](DncList.html) post_outbound_dnclists(body) + + Create dialer DNC list Wraps POST /api/v2/outbound/dnclists +Requires ANY permissions: +* outbound:dncList:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4515,17 +5024,23 @@ <a name="post_outbound_rulesets"></a> ## -[**RuleSet**](RuleSet.html) post_outbound_rulesets(body) + + Create a Dialer Call Analysis Response Set. Wraps POST /api/v2/outbound/rulesets +Requires ANY permissions: +* outbound:ruleSet:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4574,17 +5089,23 @@ <a name="post_outbound_sequences"></a> ## -[**CampaignSequence**](CampaignSequence.html) post_outbound_sequences(body) + + Create a new campaign sequence. Wraps POST /api/v2/outbound/sequences +Requires ANY permissions: +* outbound:campaignSequence:add + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4633,17 +5154,23 @@ <a name="put_outbound_attemptlimit"></a> ## -[**AttemptLimits**](AttemptLimits.html) put_outbound_attemptlimit(attempt_limits_id, body) + + Update attempt limits Wraps PUT /api/v2/outbound/attemptlimits/{attemptLimitsId} +Requires ANY permissions: +* outbound:attemptLimits:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4695,17 +5222,23 @@ <a name="put_outbound_callabletimeset"></a> ## -[**CallableTimeSet**](CallableTimeSet.html) put_outbound_callabletimeset(callable_time_set_id, body) + + Update callable time set Wraps PUT /api/v2/outbound/callabletimesets/{callableTimeSetId} +Requires ANY permissions: +* outbound:callableTimeSet:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4757,17 +5290,23 @@ <a name="put_outbound_callanalysisresponseset"></a> ## -[**ResponseSet**](ResponseSet.html) put_outbound_callanalysisresponseset(call_analysis_set_id, body) + + Update a dialer call analysis response set. Wraps PUT /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} +Requires ANY permissions: +* outbound:responseSet:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4819,17 +5358,23 @@ <a name="put_outbound_campaign"></a> ## -[**Campaign**](Campaign.html) put_outbound_campaign(campaign_id, body) + + Update a campaign. Wraps PUT /api/v2/outbound/campaigns/{campaignId} +Requires ANY permissions: +* outbound:campaign:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4881,17 +5426,23 @@ <a name="put_outbound_campaign_agent"></a> ## -String** put_outbound_campaign_agent(campaign_id, user_id, body) + + Send notification that an agent's state changed New agent state. Wraps PUT /api/v2/outbound/campaigns/{campaignId}/agents/{userId} +Requires NO permissions: + + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -4946,17 +5497,23 @@ <a name="put_outbound_campaignrule"></a> ## -[**CampaignRule**](CampaignRule.html) put_outbound_campaignrule(campaign_rule_id, body) + + Update Campaign Rule Wraps PUT /api/v2/outbound/campaignrules/{campaignRuleId} +Requires ANY permissions: +* outbound:campaignRule:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -5008,17 +5565,23 @@ <a name="put_outbound_contactlist"></a> ## -[**ContactList**](ContactList.html) put_outbound_contactlist(contact_list_id, body) + + Update a contact list. Wraps PUT /api/v2/outbound/contactlists/{contactListId} +Requires ANY permissions: +* outbound:contactList:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -5070,17 +5633,23 @@ <a name="put_outbound_contactlist_contact"></a> ## -[**DialerContact**](DialerContact.html) put_outbound_contactlist_contact(contact_list_id, contact_id, body) + + Update a contact. Wraps PUT /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} +Requires ANY permissions: +* outbound:contact:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -5135,17 +5704,23 @@ <a name="put_outbound_contactlistfilter"></a> ## -[**ContactListFilter**](ContactListFilter.html) put_outbound_contactlistfilter(contact_list_filter_id, body) + + Update Contact List Filter Wraps PUT /api/v2/outbound/contactlistfilters/{contactListFilterId} +Requires ANY permissions: +* outbound:contactListFilter:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -5197,17 +5772,23 @@ <a name="put_outbound_dnclist"></a> ## -[**DncList**](DncList.html) put_outbound_dnclist(dnc_list_id, body) + + Update dialer DNC list Wraps PUT /api/v2/outbound/dnclists/{dncListId} +Requires ANY permissions: +* outbound:dncList:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -5259,17 +5840,23 @@ <a name="put_outbound_ruleset"></a> ## -[**RuleSet**](RuleSet.html) put_outbound_ruleset(rule_set_id, body) + + Update a RuleSet. Wraps PUT /api/v2/outbound/rulesets/{ruleSetId} +Requires ANY permissions: +* outbound:ruleSet:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -5321,17 +5908,23 @@ <a name="put_outbound_schedules_campaign"></a> ## -[**CampaignSchedule**](CampaignSchedule.html) put_outbound_schedules_campaign(campaign_id, body) + + Update a new campaign schedule. Wraps PUT /api/v2/outbound/schedules/campaigns/{campaignId} +Requires ANY permissions: +* outbound:schedule:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -5383,17 +5976,23 @@ <a name="put_outbound_schedules_sequence"></a> ## -[**SequenceSchedule**](SequenceSchedule.html) put_outbound_schedules_sequence(sequence_id, body) + + Update a new sequence schedule. Wraps PUT /api/v2/outbound/schedules/sequences/{sequenceId} +Requires ANY permissions: +* outbound:schedule:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -5445,17 +6044,23 @@ <a name="put_outbound_sequence"></a> ## -[**CampaignSequence**](CampaignSequence.html) put_outbound_sequence(sequence_id, body) + + Update a new campaign sequence. Wraps PUT /api/v2/outbound/sequences/{sequenceId} +Requires ANY permissions: +* outbound:campaignSequence:edit + + ### Example ~~~ruby # load the gem require 'purecloudplatformclientv2' # setup authorization @@ -5507,14 +6112,20 @@ <a name="put_outbound_wrapupcodemappings"></a> ## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) put_outbound_wrapupcodemappings(body) + + Update the Dialer wrap up code mapping. Wraps PUT /api/v2/outbound/wrapupcodemappings + +Requires ANY permissions: + +* outbound:wrapUpCodeMapping:edit ### Example ~~~ruby # load the gem