--- title: OutboundApi --- ## PureCloud::OutboundApi All URIs are relative to *https://api.mypurecloud.com* Method | HTTP request | Description ------------- | ------------- | ------------- |[**delete_attemptlimits_attemptlimits_id**](OutboundApi.html#delete_attemptlimits_attemptlimits_id) | **DELETE** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Delete attempt limits| |[**delete_callabletimesets_callabletimeset_id**](OutboundApi.html#delete_callabletimesets_callabletimeset_id) | **DELETE** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Delete callable time set| |[**delete_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#delete_callanalysisresponsesets_callanalysisset_id) | **DELETE** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Delete a dialer call analysis response set.| |[**delete_campaignrules_campaignrule_id**](OutboundApi.html#delete_campaignrules_campaignrule_id) | **DELETE** /api/v2/outbound/campaignrules/{campaignRuleId} | Delete Campaign Rule| |[**delete_campaigns_campaign_id**](OutboundApi.html#delete_campaigns_campaign_id) | **DELETE** /api/v2/outbound/campaigns/{campaignId} | Delete a campaign.| |[**delete_campaigns_campaign_id_progress**](OutboundApi.html#delete_campaigns_campaign_id_progress) | **DELETE** /api/v2/outbound/campaigns/{campaignId}/progress | Reset campaign progress and recycle the campaign| |[**delete_contactlists_contactlist_id**](OutboundApi.html#delete_contactlists_contactlist_id) | **DELETE** /api/v2/outbound/contactlists/{contactListId} | Delete a contact list.| |[**delete_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#delete_contactlists_contactlist_id_contacts_contact_id) | **DELETE** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Delete a contact.| |[**delete_dnclists_dnclist_id**](OutboundApi.html#delete_dnclists_dnclist_id) | **DELETE** /api/v2/outbound/dnclists/{dncListId} | Delete dialer DNC list| |[**delete_rulesets_ruleset_id**](OutboundApi.html#delete_rulesets_ruleset_id) | **DELETE** /api/v2/outbound/rulesets/{ruleSetId} | Delete a Rule set.| |[**delete_schedules_campaigns_campaign_id**](OutboundApi.html#delete_schedules_campaigns_campaign_id) | **DELETE** /api/v2/outbound/schedules/campaigns/{campaignId} | Delete a dialer campaign schedule.| |[**delete_schedules_sequences_sequence_id**](OutboundApi.html#delete_schedules_sequences_sequence_id) | **DELETE** /api/v2/outbound/schedules/sequences/{sequenceId} | Delete a dialer sequence schedule.| |[**delete_sequences_sequence_id**](OutboundApi.html#delete_sequences_sequence_id) | **DELETE** /api/v2/outbound/sequences/{sequenceId} | Delete a dialer campaign sequence.| |[**get_attemptlimits**](OutboundApi.html#get_attemptlimits) | **GET** /api/v2/outbound/attemptlimits | Query attempt limits list| |[**get_attemptlimits_attemptlimits_id**](OutboundApi.html#get_attemptlimits_attemptlimits_id) | **GET** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Get attempt limits| |[**get_callabletimesets**](OutboundApi.html#get_callabletimesets) | **GET** /api/v2/outbound/callabletimesets | Query callable time set list| |[**get_callabletimesets_callabletimeset_id**](OutboundApi.html#get_callabletimesets_callabletimeset_id) | **GET** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Get callable time set| |[**get_callanalysisresponsesets**](OutboundApi.html#get_callanalysisresponsesets) | **GET** /api/v2/outbound/callanalysisresponsesets | Query a list of dialer call analysis response sets.| |[**get_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#get_callanalysisresponsesets_callanalysisset_id) | **GET** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Get a dialer call analysis response set.| |[**get_campaignrules**](OutboundApi.html#get_campaignrules) | **GET** /api/v2/outbound/campaignrules | Query Campaign Rule list| |[**get_campaignrules_campaignrule_id**](OutboundApi.html#get_campaignrules_campaignrule_id) | **GET** /api/v2/outbound/campaignrules/{campaignRuleId} | Get Campaign Rule| |[**get_campaigns**](OutboundApi.html#get_campaigns) | **GET** /api/v2/outbound/campaigns | Query a list of dialer campaigns.| |[**get_campaigns_campaign_id**](OutboundApi.html#get_campaigns_campaign_id) | **GET** /api/v2/outbound/campaigns/{campaignId} | Get dialer campaign.| |[**get_campaigns_campaign_id_diagnostics**](OutboundApi.html#get_campaigns_campaign_id_diagnostics) | **GET** /api/v2/outbound/campaigns/{campaignId}/diagnostics | Get campaign diagnostics| |[**get_campaigns_campaign_id_interactions**](OutboundApi.html#get_campaigns_campaign_id_interactions) | **GET** /api/v2/outbound/campaigns/{campaignId}/interactions | Get dialer campaign interactions.| |[**get_campaigns_campaign_id_progress**](OutboundApi.html#get_campaigns_campaign_id_progress) | **GET** /api/v2/outbound/campaigns/{campaignId}/progress | Get campaign progress| |[**get_campaigns_campaign_id_stats**](OutboundApi.html#get_campaigns_campaign_id_stats) | **GET** /api/v2/outbound/campaigns/{campaignId}/stats | Get statistics about a Dialer Campaign| |[**get_contactlists**](OutboundApi.html#get_contactlists) | **GET** /api/v2/outbound/contactlists | Query a list of contact lists.| |[**get_contactlists_contactlist_id**](OutboundApi.html#get_contactlists_contactlist_id) | **GET** /api/v2/outbound/contactlists/{contactListId} | Get a dialer contact list.| |[**get_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#get_contactlists_contactlist_id_contacts_contact_id) | **GET** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Get a contact.| |[**get_contactlists_contactlist_id_export**](OutboundApi.html#get_contactlists_contactlist_id_export) | **GET** /api/v2/outbound/contactlists/{contactListId}/export | Get the URI of a contact list export.| |[**get_contactlists_contactlist_id_importstatus**](OutboundApi.html#get_contactlists_contactlist_id_importstatus) | **GET** /api/v2/outbound/contactlists/{contactListId}/importstatus | Get dialer contactList import status.| |[**get_dnclists**](OutboundApi.html#get_dnclists) | **GET** /api/v2/outbound/dnclists | Query dialer DNC lists| |[**get_dnclists_dnclist_id**](OutboundApi.html#get_dnclists_dnclist_id) | **GET** /api/v2/outbound/dnclists/{dncListId} | Get dialer DNC list| |[**get_dnclists_dnclist_id_export**](OutboundApi.html#get_dnclists_dnclist_id_export) | **GET** /api/v2/outbound/dnclists/{dncListId}/export | Get the URI of a DNC list export.| |[**get_dnclists_dnclist_id_importstatus**](OutboundApi.html#get_dnclists_dnclist_id_importstatus) | **GET** /api/v2/outbound/dnclists/{dncListId}/importstatus | Get dialer dncList import status.| |[**get_rulesets**](OutboundApi.html#get_rulesets) | **GET** /api/v2/outbound/rulesets | Query a list of Rule Sets.| |[**get_rulesets_ruleset_id**](OutboundApi.html#get_rulesets_ruleset_id) | **GET** /api/v2/outbound/rulesets/{ruleSetId} | Get a Rule Set by ID.| |[**get_schedules_campaigns**](OutboundApi.html#get_schedules_campaigns) | **GET** /api/v2/outbound/schedules/campaigns | Query for a list of dialer campaign schedules.| |[**get_schedules_campaigns_campaign_id**](OutboundApi.html#get_schedules_campaigns_campaign_id) | **GET** /api/v2/outbound/schedules/campaigns/{campaignId} | Get a dialer campaign schedule.| |[**get_schedules_sequences**](OutboundApi.html#get_schedules_sequences) | **GET** /api/v2/outbound/schedules/sequences | Query for a list of dialer sequence schedules.| |[**get_schedules_sequences_sequence_id**](OutboundApi.html#get_schedules_sequences_sequence_id) | **GET** /api/v2/outbound/schedules/sequences/{sequenceId} | Get a dialer sequence schedule.| |[**get_sequences**](OutboundApi.html#get_sequences) | **GET** /api/v2/outbound/sequences | Query a list of dialer campaign sequences.| |[**get_sequences_sequence_id**](OutboundApi.html#get_sequences_sequence_id) | **GET** /api/v2/outbound/sequences/{sequenceId} | Get a dialer campaign sequence.| |[**get_wrapupcodemappings**](OutboundApi.html#get_wrapupcodemappings) | **GET** /api/v2/outbound/wrapupcodemappings | Get the Dialer wrap up code mapping.| |[**post_attemptlimits**](OutboundApi.html#post_attemptlimits) | **POST** /api/v2/outbound/attemptlimits | Create attempt limits| |[**post_audits**](OutboundApi.html#post_audits) | **POST** /api/v2/outbound/audits | Retrieves audits for dialer.| |[**post_callabletimesets**](OutboundApi.html#post_callabletimesets) | **POST** /api/v2/outbound/callabletimesets | Create callable time set| |[**post_callanalysisresponsesets**](OutboundApi.html#post_callanalysisresponsesets) | **POST** /api/v2/outbound/callanalysisresponsesets | Create a dialer call analysis response set.| |[**post_campaignrules**](OutboundApi.html#post_campaignrules) | **POST** /api/v2/outbound/campaignrules | Create Campaign Rule| |[**post_campaigns**](OutboundApi.html#post_campaigns) | **POST** /api/v2/outbound/campaigns | Create a campaign.| |[**post_campaigns_campaign_id_callback_schedule**](OutboundApi.html#post_campaigns_campaign_id_callback_schedule) | **POST** /api/v2/outbound/campaigns/{campaignId}/callback/schedule | Schedule a Callback for a Dialer Campaign (Deprecated)| |[**post_campaigns_progress**](OutboundApi.html#post_campaigns_progress) | **POST** /api/v2/outbound/campaigns/progress | Get progress for a list of campaigns| |[**post_contactlists**](OutboundApi.html#post_contactlists) | **POST** /api/v2/outbound/contactlists | Create a contact List.| |[**post_contactlists_contactlist_id_contacts**](OutboundApi.html#post_contactlists_contactlist_id_contacts) | **POST** /api/v2/outbound/contactlists/{contactListId}/contacts | Add contacts to a contact list.| |[**post_contactlists_contactlist_id_export**](OutboundApi.html#post_contactlists_contactlist_id_export) | **POST** /api/v2/outbound/contactlists/{contactListId}/export | Initiate the export of a contact list.| |[**post_conversations_conversation_id_dnc**](OutboundApi.html#post_conversations_conversation_id_dnc) | **POST** /api/v2/outbound/conversations/{conversationId}/dnc | Add phone numbers to a Dialer DNC list.| |[**post_dnclists**](OutboundApi.html#post_dnclists) | **POST** /api/v2/outbound/dnclists | Create dialer DNC list| |[**post_dnclists_dnclist_id_export**](OutboundApi.html#post_dnclists_dnclist_id_export) | **POST** /api/v2/outbound/dnclists/{dncListId}/export | Initiate the export of a dnc list.| |[**post_dnclists_dnclist_id_phonenumbers**](OutboundApi.html#post_dnclists_dnclist_id_phonenumbers) | **POST** /api/v2/outbound/dnclists/{dncListId}/phonenumbers | Add phone numbers to a Dialer DNC list.| |[**post_rulesets**](OutboundApi.html#post_rulesets) | **POST** /api/v2/outbound/rulesets | Create a Dialer Call Analysis Response Set.| |[**post_sequences**](OutboundApi.html#post_sequences) | **POST** /api/v2/outbound/sequences | Create a new campaign sequence.| |[**put_attemptlimits_attemptlimits_id**](OutboundApi.html#put_attemptlimits_attemptlimits_id) | **PUT** /api/v2/outbound/attemptlimits/{attemptLimitsId} | Update attempt limits| |[**put_callabletimesets_callabletimeset_id**](OutboundApi.html#put_callabletimesets_callabletimeset_id) | **PUT** /api/v2/outbound/callabletimesets/{callableTimeSetId} | Update callable time set| |[**put_callanalysisresponsesets_callanalysisset_id**](OutboundApi.html#put_callanalysisresponsesets_callanalysisset_id) | **PUT** /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} | Update a dialer call analysis response set.| |[**put_campaignrules_campaignrule_id**](OutboundApi.html#put_campaignrules_campaignrule_id) | **PUT** /api/v2/outbound/campaignrules/{campaignRuleId} | Update Campaign Rule| |[**put_campaigns_campaign_id**](OutboundApi.html#put_campaigns_campaign_id) | **PUT** /api/v2/outbound/campaigns/{campaignId} | Update a campaign.| |[**put_campaigns_campaign_id_agents_user_id**](OutboundApi.html#put_campaigns_campaign_id_agents_user_id) | **PUT** /api/v2/outbound/campaigns/{campaignId}/agents/{userId} | Send notification that an agent's state changed | |[**put_contactlists_contactlist_id**](OutboundApi.html#put_contactlists_contactlist_id) | **PUT** /api/v2/outbound/contactlists/{contactListId} | Update a contact list.| |[**put_contactlists_contactlist_id_contacts_contact_id**](OutboundApi.html#put_contactlists_contactlist_id_contacts_contact_id) | **PUT** /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} | Update a contact.| |[**put_dnclists_dnclist_id**](OutboundApi.html#put_dnclists_dnclist_id) | **PUT** /api/v2/outbound/dnclists/{dncListId} | Update dialer DNC list| |[**put_rulesets_ruleset_id**](OutboundApi.html#put_rulesets_ruleset_id) | **PUT** /api/v2/outbound/rulesets/{ruleSetId} | Update a RuleSet.| |[**put_schedules_campaigns_campaign_id**](OutboundApi.html#put_schedules_campaigns_campaign_id) | **PUT** /api/v2/outbound/schedules/campaigns/{campaignId} | Update a new campaign schedule.| |[**put_schedules_sequences_sequence_id**](OutboundApi.html#put_schedules_sequences_sequence_id) | **PUT** /api/v2/outbound/schedules/sequences/{sequenceId} | Update a new sequence schedule.| |[**put_sequences_sequence_id**](OutboundApi.html#put_sequences_sequence_id) | **PUT** /api/v2/outbound/sequences/{sequenceId} | Update a new campaign sequence.| |[**put_wrapupcodemappings**](OutboundApi.html#put_wrapupcodemappings) | **PUT** /api/v2/outbound/wrapupcodemappings | Update the Dialer wrap up code mapping.| {: class="table table-striped"} ## -String** delete_attemptlimits_attemptlimits_id(attempt_limits_id) Delete attempt limits ### Example ~~~ruby # load the gem require 'purecloud' # 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 attempt_limits_id = "attempt_limits_id_example" # String | Attempt limits ID begin #Delete attempt limits result = api_instance.delete_attemptlimits_attemptlimits_id(attempt_limits_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_attemptlimits_attemptlimits_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **attempt_limits_id** | **String**| Attempt limits ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_callabletimesets_callabletimeset_id(callable_time_set_id) Delete callable time set ### Example ~~~ruby # load the gem require 'purecloud' # 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 callable_time_set_id = "callable_time_set_id_example" # String | Callable Time Set ID begin #Delete callable time set result = api_instance.delete_callabletimesets_callabletimeset_id(callable_time_set_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_callabletimesets_callabletimeset_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **callable_time_set_id** | **String**| Callable Time Set ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id) Delete a dialer call analysis response set. ### Example ~~~ruby # load the gem require 'purecloud' # 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 call_analysis_set_id = "call_analysis_set_id_example" # String | Call Analysis Response Set ID begin #Delete a dialer call analysis response set. result = api_instance.delete_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_callanalysisresponsesets_callanalysisset_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **call_analysis_set_id** | **String**| Call Analysis Response Set ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_campaignrules_campaignrule_id(campaign_rule_id) Delete Campaign Rule ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_rule_id = "campaign_rule_id_example" # String | Campaign Rule ID begin #Delete Campaign Rule result = api_instance.delete_campaignrules_campaignrule_id(campaign_rule_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_campaignrules_campaignrule_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_rule_id** | **String**| Campaign Rule ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_campaigns_campaign_id(campaign_id) Delete a campaign. ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID begin #Delete a campaign. result = api_instance.delete_campaigns_campaign_id(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_campaigns_campaign_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - delete_campaigns_campaign_id_progress(campaign_id) Reset campaign progress and recycle the campaign ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID begin #Reset campaign progress and recycle the campaign api_instance.delete_campaigns_campaign_id_progress(campaign_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_campaigns_campaign_id_progress: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_contactlists_contactlist_id(contact_list_id) Delete a contact list. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id = "contact_list_id_example" # String | ContactList ID begin #Delete a contact list. result = api_instance.delete_contactlists_contactlist_id(contact_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_contactlists_contactlist_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| ContactList ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id) Delete a contact. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id = "contact_list_id_example" # String | Contact List ID contact_id = "contact_id_example" # String | Contact ID begin #Delete a contact. result = api_instance.delete_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_contactlists_contactlist_id_contacts_contact_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| Contact List ID | **contact_id** | **String**| Contact ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_dnclists_dnclist_id(dnc_list_id) Delete dialer DNC list ### Example ~~~ruby # load the gem require 'purecloud' # 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 dnc_list_id = "dnc_list_id_example" # String | DncList ID begin #Delete dialer DNC list result = api_instance.delete_dnclists_dnclist_id(dnc_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_dnclists_dnclist_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **dnc_list_id** | **String**| DncList ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_rulesets_ruleset_id(rule_set_id) Delete a Rule set. ### Example ~~~ruby # load the gem require 'purecloud' # 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 rule_set_id = "rule_set_id_example" # String | Rule Set ID begin #Delete a Rule set. result = api_instance.delete_rulesets_ruleset_id(rule_set_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_rulesets_ruleset_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **rule_set_id** | **String**| Rule Set ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_schedules_campaigns_campaign_id(campaign_id) Delete a dialer campaign schedule. ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID begin #Delete a dialer campaign schedule. result = api_instance.delete_schedules_campaigns_campaign_id(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_schedules_campaigns_campaign_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_schedules_sequences_sequence_id(sequence_id) Delete a dialer sequence schedule. ### Example ~~~ruby # load the gem require 'purecloud' # 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 sequence_id = "sequence_id_example" # String | Sequence ID begin #Delete a dialer sequence schedule. result = api_instance.delete_schedules_sequences_sequence_id(sequence_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_schedules_sequences_sequence_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sequence_id** | **String**| Sequence ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** delete_sequences_sequence_id(sequence_id) Delete a dialer campaign sequence. ### Example ~~~ruby # load the gem require 'purecloud' # 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 sequence_id = "sequence_id_example" # String | Campaign Sequence ID begin #Delete a dialer campaign sequence. result = api_instance.delete_sequences_sequence_id(sequence_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->delete_sequences_sequence_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sequence_id** | **String**| Campaign Sequence ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**AttemptLimitsEntityListing**](AttemptLimitsEntityListing.html) get_attemptlimits(opts) Query attempt limits list ### Example ~~~ruby # load the gem require 'purecloud' # 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 attempt limits list result = api_instance.get_attemptlimits(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_attemptlimits: #{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] **name** | **String**| Name | [optional] **sort_by** | **String**| Sort by | [optional] **sort_order** | **String**| Sort order | [optional] [default to a] {: class="table table-striped"} ### Return type [**AttemptLimitsEntityListing**](AttemptLimitsEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**AttemptLimits**](AttemptLimits.html) get_attemptlimits_attemptlimits_id(attempt_limits_id) Get attempt limits ### Example ~~~ruby # load the gem require 'purecloud' # 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 attempt_limits_id = "attempt_limits_id_example" # String | Attempt limits ID begin #Get attempt limits result = api_instance.get_attemptlimits_attemptlimits_id(attempt_limits_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_attemptlimits_attemptlimits_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **attempt_limits_id** | **String**| Attempt limits ID | {: class="table table-striped"} ### Return type [**AttemptLimits**](AttemptLimits.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html) get_callabletimesets(opts) Query callable time set list ### Example ~~~ruby # load the gem require 'purecloud' # 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 callable time set list result = api_instance.get_callabletimesets(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_callabletimesets: #{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] **name** | **String**| Name | [optional] **sort_by** | **String**| Sort by | [optional] **sort_order** | **String**| Sort order | [optional] [default to a] {: class="table table-striped"} ### Return type [**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CallableTimeSet**](CallableTimeSet.html) get_callabletimesets_callabletimeset_id(callable_time_set_id) Get callable time set ### Example ~~~ruby # load the gem require 'purecloud' # 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 callable_time_set_id = "callable_time_set_id_example" # String | Callable Time Set ID begin #Get callable time set result = api_instance.get_callabletimesets_callabletimeset_id(callable_time_set_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_callabletimesets_callabletimeset_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **callable_time_set_id** | **String**| Callable Time Set ID | {: class="table table-striped"} ### Return type [**CallableTimeSet**](CallableTimeSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ResponseSetEntityListing**](ResponseSetEntityListing.html) get_callanalysisresponsesets(opts) Query a list of dialer call analysis response sets. ### Example ~~~ruby # load the gem require 'purecloud' # 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 dialer call analysis response sets. result = api_instance.get_callanalysisresponsesets(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_callanalysisresponsesets: #{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] **name** | **String**| Name | [optional] **sort_by** | **String**| Sort by | [optional] **sort_order** | **String**| Sort order | [optional] [default to a] {: class="table table-striped"} ### Return type [**ResponseSetEntityListing**](ResponseSetEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ResponseSet**](ResponseSet.html) get_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id) Get a dialer call analysis response set. ### Example ~~~ruby # load the gem require 'purecloud' # 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 call_analysis_set_id = "call_analysis_set_id_example" # String | Call Analysis Response Set ID begin #Get a dialer call analysis response set. result = api_instance.get_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_callanalysisresponsesets_callanalysisset_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **call_analysis_set_id** | **String**| Call Analysis Response Set ID | {: class="table table-striped"} ### Return type [**ResponseSet**](ResponseSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignRuleEntityListing**](CampaignRuleEntityListing.html) get_campaignrules(opts) Query Campaign Rule list ### Example ~~~ruby # load the gem require 'purecloud' # 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 Campaign Rule list result = api_instance.get_campaignrules(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_campaignrules: #{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] **name** | **String**| Name | [optional] **sort_by** | **String**| Sort by | [optional] **sort_order** | **String**| Sort order | [optional] [default to a] {: class="table table-striped"} ### Return type [**CampaignRuleEntityListing**](CampaignRuleEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignRule**](CampaignRule.html) get_campaignrules_campaignrule_id(campaign_rule_id) Get Campaign Rule ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_rule_id = "campaign_rule_id_example" # String | Campaign Rule ID begin #Get Campaign Rule result = api_instance.get_campaignrules_campaignrule_id(campaign_rule_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_campaignrules_campaignrule_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_rule_id** | **String**| Campaign Rule ID | {: class="table table-striped"} ### Return type [**CampaignRule**](CampaignRule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignEntityListing**](CampaignEntityListing.html) get_campaigns(opts) Query a list of dialer campaigns. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id: "contact_list_id_example", # String | Contact List ID dnc_list_id: "dnc_list_id_example", # String | DNC list ID distribution_queue_id: "distribution_queue_id_example", # String | Distribution queue ID edge_group_id: "edge_group_id_example", # String | Edge group ID call_analysis_response_set_id: "call_analysis_response_set_id_example", # String | Call analysis response set ID sort_by: "sort_by_example", # String | Sort by sort_order: "a" # String | Sort order } begin #Query a list of dialer campaigns. result = api_instance.get_campaigns(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_campaigns: #{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] **name** | **String**| Name | [optional] **contact_list_id** | **String**| Contact List ID | [optional] **dnc_list_id** | **String**| DNC list ID | [optional] **distribution_queue_id** | **String**| Distribution queue ID | [optional] **edge_group_id** | **String**| Edge group ID | [optional] **call_analysis_response_set_id** | **String**| Call analysis response set ID | [optional] **sort_by** | **String**| Sort by | [optional] **sort_order** | **String**| Sort order | [optional] [default to a] {: class="table table-striped"} ### Return type [**CampaignEntityListing**](CampaignEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Campaign**](Campaign.html) get_campaigns_campaign_id(campaign_id) Get dialer campaign. ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID begin #Get dialer campaign. result = api_instance.get_campaigns_campaign_id(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_campaigns_campaign_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | {: class="table table-striped"} ### Return type [**Campaign**](Campaign.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignDiagnostics**](CampaignDiagnostics.html) get_campaigns_campaign_id_diagnostics(campaign_id) Get campaign diagnostics ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID begin #Get campaign diagnostics result = api_instance.get_campaigns_campaign_id_diagnostics(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_campaigns_campaign_id_diagnostics: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | {: class="table table-striped"} ### Return type [**CampaignDiagnostics**](CampaignDiagnostics.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignInteractions**](CampaignInteractions.html) get_campaigns_campaign_id_interactions(campaign_id) Get dialer campaign interactions. ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID begin #Get dialer campaign interactions. result = api_instance.get_campaigns_campaign_id_interactions(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_campaigns_campaign_id_interactions: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | {: class="table table-striped"} ### Return type [**CampaignInteractions**](CampaignInteractions.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignProgress**](CampaignProgress.html) get_campaigns_campaign_id_progress(campaign_id) Get campaign progress ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID begin #Get campaign progress result = api_instance.get_campaigns_campaign_id_progress(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_campaigns_campaign_id_progress: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | {: class="table table-striped"} ### Return type [**CampaignProgress**](CampaignProgress.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignStats**](CampaignStats.html) get_campaigns_campaign_id_stats(campaign_id) Get statistics about a Dialer Campaign ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID begin #Get statistics about a Dialer Campaign result = api_instance.get_campaigns_campaign_id_stats(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_campaigns_campaign_id_stats: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | {: class="table table-striped"} ### Return type [**CampaignStats**](CampaignStats.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ContactListEntityListing**](ContactListEntityListing.html) get_contactlists(opts) Query a list of contact lists. ### Example ~~~ruby # load the gem require 'purecloud' # 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 = { include_import_status: false, # BOOLEAN | Include import status include_size: false, # BOOLEAN | Include size 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 contact lists. result = api_instance.get_contactlists(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_contactlists: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **include_import_status** | **BOOLEAN**| Include import status | [optional] [default to false] **include_size** | **BOOLEAN**| Include size | [optional] [default to false] **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] **name** | **String**| Name | [optional] **sort_by** | **String**| Sort by | [optional] **sort_order** | **String**| Sort order | [optional] [default to a] {: class="table table-striped"} ### Return type [**ContactListEntityListing**](ContactListEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ContactList**](ContactList.html) get_contactlists_contactlist_id(contact_list_id, opts) Get a dialer contact list. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id = "contact_list_id_example" # String | ContactList ID opts = { include_import_status: false, # BOOLEAN | Import status include_size: false # BOOLEAN | Include size } begin #Get a dialer contact list. result = api_instance.get_contactlists_contactlist_id(contact_list_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_contactlists_contactlist_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| ContactList ID | **include_import_status** | **BOOLEAN**| Import status | [optional] [default to false] **include_size** | **BOOLEAN**| Include size | [optional] [default to false] {: class="table table-striped"} ### Return type [**ContactList**](ContactList.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DialerContact**](DialerContact.html) get_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id) Get a contact. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id = "contact_list_id_example" # String | Contact List ID contact_id = "contact_id_example" # String | Contact ID begin #Get a contact. result = api_instance.get_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_contactlists_contactlist_id_contacts_contact_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| Contact List ID | **contact_id** | **String**| Contact ID | {: class="table table-striped"} ### Return type [**DialerContact**](DialerContact.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ExportUri**](ExportUri.html) get_contactlists_contactlist_id_export(contact_list_id, opts) Get the URI of a contact list export. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id = "contact_list_id_example" # String | ContactList ID opts = { download: "false" # String | Redirect to download uri } begin #Get the URI of a contact list export. result = api_instance.get_contactlists_contactlist_id_export(contact_list_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_contactlists_contactlist_id_export: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| ContactList ID | **download** | **String**| Redirect to download uri | [optional] [default to false] {: class="table table-striped"} ### Return type [**ExportUri**](ExportUri.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ImportStatus**](ImportStatus.html) get_contactlists_contactlist_id_importstatus(contact_list_id) Get dialer contactList import status. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id = "contact_list_id_example" # String | ContactList ID begin #Get dialer contactList import status. result = api_instance.get_contactlists_contactlist_id_importstatus(contact_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_contactlists_contactlist_id_importstatus: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| ContactList ID | {: class="table table-striped"} ### Return type [**ImportStatus**](ImportStatus.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DncListEntityListing**](DncListEntityListing.html) get_dnclists(opts) Query dialer DNC lists ### Example ~~~ruby # load the gem require 'purecloud' # 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 = { include_import_status: false, # BOOLEAN | Import status include_size: false, # BOOLEAN | Include size 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: "sort_order_example" # String | Sort order } begin #Query dialer DNC lists result = api_instance.get_dnclists(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_dnclists: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **include_import_status** | **BOOLEAN**| Import status | [optional] [default to false] **include_size** | **BOOLEAN**| Include size | [optional] [default to false] **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] **name** | **String**| Name | [optional] **sort_by** | **String**| Sort by | [optional] **sort_order** | **String**| Sort order | [optional] {: class="table table-striped"} ### Return type [**DncListEntityListing**](DncListEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DncList**](DncList.html) get_dnclists_dnclist_id(dnc_list_id, opts) Get dialer DNC list ### Example ~~~ruby # load the gem require 'purecloud' # 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 dnc_list_id = "dnc_list_id_example" # String | DncList ID opts = { include_import_status: false, # BOOLEAN | Import status include_size: false # BOOLEAN | Include size } begin #Get dialer DNC list result = api_instance.get_dnclists_dnclist_id(dnc_list_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_dnclists_dnclist_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **dnc_list_id** | **String**| DncList ID | **include_import_status** | **BOOLEAN**| Import status | [optional] [default to false] **include_size** | **BOOLEAN**| Include size | [optional] [default to false] {: class="table table-striped"} ### Return type [**DncList**](DncList.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ExportUri**](ExportUri.html) get_dnclists_dnclist_id_export(dnc_list_id, opts) Get the URI of a DNC list export. ### Example ~~~ruby # load the gem require 'purecloud' # 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 dnc_list_id = "dnc_list_id_example" # String | DncList ID opts = { download: "false" # String | Redirect to download uri } begin #Get the URI of a DNC list export. result = api_instance.get_dnclists_dnclist_id_export(dnc_list_id, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_dnclists_dnclist_id_export: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **dnc_list_id** | **String**| DncList ID | **download** | **String**| Redirect to download uri | [optional] [default to false] {: class="table table-striped"} ### Return type [**ExportUri**](ExportUri.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ImportStatus**](ImportStatus.html) get_dnclists_dnclist_id_importstatus(dnc_list_id) Get dialer dncList import status. ### Example ~~~ruby # load the gem require 'purecloud' # 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 dnc_list_id = "dnc_list_id_example" # String | DncList ID begin #Get dialer dncList import status. result = api_instance.get_dnclists_dnclist_id_importstatus(dnc_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_dnclists_dnclist_id_importstatus: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **dnc_list_id** | **String**| DncList ID | {: class="table table-striped"} ### Return type [**ImportStatus**](ImportStatus.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**RuleSetEntityListing**](RuleSetEntityListing.html) get_rulesets(opts) Query a list of Rule Sets. ### Example ~~~ruby # load the gem require 'purecloud' # 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 Rule Sets. result = api_instance.get_rulesets(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_rulesets: #{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] **name** | **String**| Name | [optional] **sort_by** | **String**| Sort by | [optional] **sort_order** | **String**| Sort order | [optional] [default to a] {: class="table table-striped"} ### Return type [**RuleSetEntityListing**](RuleSetEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**RuleSet**](RuleSet.html) get_rulesets_ruleset_id(rule_set_id) Get a Rule Set by ID. ### Example ~~~ruby # load the gem require 'purecloud' # 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 rule_set_id = "rule_set_id_example" # String | Rule Set ID begin #Get a Rule Set by ID. result = api_instance.get_rulesets_ruleset_id(rule_set_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_rulesets_ruleset_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **rule_set_id** | **String**| Rule Set ID | {: class="table table-striped"} ### Return type [**RuleSet**](RuleSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Array<CampaignSchedule>**](CampaignSchedule.html) get_schedules_campaigns Query for a list of dialer campaign schedules. ### Example ~~~ruby # load the gem require 'purecloud' # 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 begin #Query for a list of dialer campaign schedules. result = api_instance.get_schedules_campaigns p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_schedules_campaigns: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**Array<CampaignSchedule>**](CampaignSchedule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignSchedule**](CampaignSchedule.html) get_schedules_campaigns_campaign_id(campaign_id) Get a dialer campaign schedule. ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID begin #Get a dialer campaign schedule. result = api_instance.get_schedules_campaigns_campaign_id(campaign_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_schedules_campaigns_campaign_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | {: class="table table-striped"} ### Return type [**CampaignSchedule**](CampaignSchedule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Array<SequenceSchedule>**](SequenceSchedule.html) get_schedules_sequences Query for a list of dialer sequence schedules. ### Example ~~~ruby # load the gem require 'purecloud' # 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 begin #Query for a list of dialer sequence schedules. result = api_instance.get_schedules_sequences p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_schedules_sequences: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**Array<SequenceSchedule>**](SequenceSchedule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**SequenceSchedule**](SequenceSchedule.html) get_schedules_sequences_sequence_id(sequence_id) Get a dialer sequence schedule. ### Example ~~~ruby # load the gem require 'purecloud' # 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 sequence_id = "sequence_id_example" # String | Sequence ID begin #Get a dialer sequence schedule. result = api_instance.get_schedules_sequences_sequence_id(sequence_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_schedules_sequences_sequence_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sequence_id** | **String**| Sequence ID | {: class="table table-striped"} ### Return type [**SequenceSchedule**](SequenceSchedule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignSequenceEntityListing**](CampaignSequenceEntityListing.html) get_sequences(opts) Query a list of dialer campaign sequences. ### Example ~~~ruby # load the gem require 'purecloud' # 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 dialer campaign sequences. result = api_instance.get_sequences(opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_sequences: #{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] **name** | **String**| Name | [optional] **sort_by** | **String**| Sort by | [optional] **sort_order** | **String**| Sort order | [optional] [default to a] {: class="table table-striped"} ### Return type [**CampaignSequenceEntityListing**](CampaignSequenceEntityListing.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignSequence**](CampaignSequence.html) get_sequences_sequence_id(sequence_id) Get a dialer campaign sequence. ### Example ~~~ruby # load the gem require 'purecloud' # 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 sequence_id = "sequence_id_example" # String | Campaign Sequence ID begin #Get a dialer campaign sequence. result = api_instance.get_sequences_sequence_id(sequence_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_sequences_sequence_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sequence_id** | **String**| Campaign Sequence ID | {: class="table table-striped"} ### Return type [**CampaignSequence**](CampaignSequence.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) get_wrapupcodemappings Get the Dialer wrap up code mapping. ### Example ~~~ruby # load the gem require 'purecloud' # 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 begin #Get the Dialer wrap up code mapping. result = api_instance.get_wrapupcodemappings p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->get_wrapupcodemappings: #{e}" end ~~~ ### Parameters This endpoint does not need any parameter. {: class="table table-striped"} ### Return type [**WrapUpCodeMapping**](WrapUpCodeMapping.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**AttemptLimits**](AttemptLimits.html) post_attemptlimits(body) Create attempt limits ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::AttemptLimits.new # AttemptLimits | AttemptLimits begin #Create attempt limits result = api_instance.post_attemptlimits(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_attemptlimits: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**AttemptLimits**](AttemptLimits.html)| AttemptLimits | {: class="table table-striped"} ### Return type [**AttemptLimits**](AttemptLimits.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**AuditSearchResult**](AuditSearchResult.html) post_audits(body, opts) Retrieves audits for dialer. ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::DialerAuditRequest.new # DialerAuditRequest | AuditSearch opts = { page_size: 25, # Integer | Page size page_number: 1, # Integer | Page number sort_by: "entity.name", # String | Sort by sort_order: "ascending", # String | Sort order facets_only: false # BOOLEAN | Facets only } begin #Retrieves audits for dialer. result = api_instance.post_audits(body, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_audits: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**DialerAuditRequest**](DialerAuditRequest.html)| AuditSearch | **page_size** | **Integer**| Page size | [optional] [default to 25] **page_number** | **Integer**| Page number | [optional] [default to 1] **sort_by** | **String**| Sort by | [optional] [default to entity.name] **sort_order** | **String**| Sort order | [optional] [default to ascending] **facets_only** | **BOOLEAN**| Facets only | [optional] [default to false] {: class="table table-striped"} ### Return type [**AuditSearchResult**](AuditSearchResult.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CallableTimeSet**](CallableTimeSet.html) post_callabletimesets(body) Create callable time set ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::CallableTimeSet.new # CallableTimeSet | DialerCallableTimeSet begin #Create callable time set result = api_instance.post_callabletimesets(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_callabletimesets: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**CallableTimeSet**](CallableTimeSet.html)| DialerCallableTimeSet | {: class="table table-striped"} ### Return type [**CallableTimeSet**](CallableTimeSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ResponseSet**](ResponseSet.html) post_callanalysisresponsesets(body) Create a dialer call analysis response set. ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::ResponseSet.new # ResponseSet | ResponseSet begin #Create a dialer call analysis response set. result = api_instance.post_callanalysisresponsesets(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_callanalysisresponsesets: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**ResponseSet**](ResponseSet.html)| ResponseSet | {: class="table table-striped"} ### Return type [**ResponseSet**](ResponseSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignRule**](CampaignRule.html) post_campaignrules(body) Create Campaign Rule ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::CampaignRule.new # CampaignRule | CampaignRule begin #Create Campaign Rule result = api_instance.post_campaignrules(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_campaignrules: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**CampaignRule**](CampaignRule.html)| CampaignRule | {: class="table table-striped"} ### Return type [**CampaignRule**](CampaignRule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Campaign**](Campaign.html) post_campaigns(body) Create a campaign. ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::Campaign.new # Campaign | Campaign begin #Create a campaign. result = api_instance.post_campaigns(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_campaigns: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Campaign**](Campaign.html)| Campaign | {: class="table table-striped"} ### Return type [**Campaign**](Campaign.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ContactCallbackRequest**](ContactCallbackRequest.html) post_campaigns_campaign_id_callback_schedule(campaign_id, body) 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.\" ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID body = PureCloud::ContactCallbackRequest.new # ContactCallbackRequest | ContactCallbackRequest begin #Schedule a Callback for a Dialer Campaign (Deprecated) result = api_instance.post_campaigns_campaign_id_callback_schedule(campaign_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_campaigns_campaign_id_callback_schedule: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | **body** | [**ContactCallbackRequest**](ContactCallbackRequest.html)| ContactCallbackRequest | {: class="table table-striped"} ### Return type [**ContactCallbackRequest**](ContactCallbackRequest.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Array<CampaignProgress>**](CampaignProgress.html) post_campaigns_progress(body) Get progress for a list of campaigns ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = [PureCloud::Array.new] # Array | Campaign IDs begin #Get progress for a list of campaigns result = api_instance.post_campaigns_progress(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_campaigns_progress: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Array<String>**| Campaign IDs | {: class="table table-striped"} ### Return type [**Array<CampaignProgress>**](CampaignProgress.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ContactList**](ContactList.html) post_contactlists(body) Create a contact List. ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::ContactList.new # ContactList | ContactList begin #Create a contact List. result = api_instance.post_contactlists(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_contactlists: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**ContactList**](ContactList.html)| ContactList | {: class="table table-striped"} ### Return type [**ContactList**](ContactList.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Array<DialerContact>**](DialerContact.html) post_contactlists_contactlist_id_contacts(contact_list_id, body, opts) Add contacts to a contact list. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id = "contact_list_id_example" # String | Contact List ID body = [PureCloud::DialerContact.new] # Array | Contact opts = { priority: true, # BOOLEAN | Contact priority. True means the contact(s) will go to the beginning of the list, false means at the end. clear_system_data: true # BOOLEAN | Clear system data. True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won't. } begin #Add contacts to a contact list. result = api_instance.post_contactlists_contactlist_id_contacts(contact_list_id, body, opts) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_contactlists_contactlist_id_contacts: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| Contact List ID | **body** | [**Array<DialerContact>**](DialerContact.html)| Contact | **priority** | **BOOLEAN**| Contact priority. True means the contact(s) will go to the beginning of the list, false means at the end. | [optional] **clear_system_data** | **BOOLEAN**| Clear system data. True means the system data stored on the contact will be cleared if the contact already exists (attempts, callable status, etc), false means it won't. | [optional] {: class="table table-striped"} ### Return type [**Array<DialerContact>**](DialerContact.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** post_contactlists_contactlist_id_export(contact_list_id) Initiate the export of a contact list. Returns 200 if received OK. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id = "contact_list_id_example" # String | ContactList ID begin #Initiate the export of a contact list. result = api_instance.post_contactlists_contactlist_id_export(contact_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_contactlists_contactlist_id_export: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| ContactList ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - post_conversations_conversation_id_dnc(conversation_id) Add phone numbers to a Dialer DNC list. ### Example ~~~ruby # load the gem require 'purecloud' # 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 conversation_id = "conversation_id_example" # String | Conversation ID begin #Add phone numbers to a Dialer DNC list. api_instance.post_conversations_conversation_id_dnc(conversation_id) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_conversations_conversation_id_dnc: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **conversation_id** | **String**| Conversation ID | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DncList**](DncList.html) post_dnclists(body) Create dialer DNC list ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::DncList.new # DncList | DncList begin #Create dialer DNC list result = api_instance.post_dnclists(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_dnclists: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**DncList**](DncList.html)| DncList | {: class="table table-striped"} ### Return type [**DncList**](DncList.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** post_dnclists_dnclist_id_export(dnc_list_id) Initiate the export of a dnc list. Returns 200 if received OK. ### Example ~~~ruby # load the gem require 'purecloud' # 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 dnc_list_id = "dnc_list_id_example" # String | DncList ID begin #Initiate the export of a dnc list. result = api_instance.post_dnclists_dnclist_id_export(dnc_list_id) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_dnclists_dnclist_id_export: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **dnc_list_id** | **String**| DncList ID | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## - post_dnclists_dnclist_id_phonenumbers(dnc_list_id, body) Add phone numbers to a Dialer DNC list. Only Internal DNC lists may be appended to ### Example ~~~ruby # load the gem require 'purecloud' # 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 dnc_list_id = "dnc_list_id_example" # String | DncList ID body = [PureCloud::Array.new] # Array | DNC Phone Numbers begin #Add phone numbers to a Dialer DNC list. api_instance.post_dnclists_dnclist_id_phonenumbers(dnc_list_id, body) rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_dnclists_dnclist_id_phonenumbers: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **dnc_list_id** | **String**| DncList ID | **body** | **Array<String>**| DNC Phone Numbers | {: class="table table-striped"} ### Return type nil (empty response body) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**RuleSet**](RuleSet.html) post_rulesets(body) Create a Dialer Call Analysis Response Set. ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::RuleSet.new # RuleSet | RuleSet begin #Create a Dialer Call Analysis Response Set. result = api_instance.post_rulesets(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_rulesets: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**RuleSet**](RuleSet.html)| RuleSet | {: class="table table-striped"} ### Return type [**RuleSet**](RuleSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignSequence**](CampaignSequence.html) post_sequences(body) Create a new campaign sequence. ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::CampaignSequence.new # CampaignSequence | Organization begin #Create a new campaign sequence. result = api_instance.post_sequences(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->post_sequences: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**CampaignSequence**](CampaignSequence.html)| Organization | {: class="table table-striped"} ### Return type [**CampaignSequence**](CampaignSequence.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**AttemptLimits**](AttemptLimits.html) put_attemptlimits_attemptlimits_id(attempt_limits_id, body) Update attempt limits ### Example ~~~ruby # load the gem require 'purecloud' # 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 attempt_limits_id = "attempt_limits_id_example" # String | Attempt limits ID body = PureCloud::AttemptLimits.new # AttemptLimits | AttemptLimits begin #Update attempt limits result = api_instance.put_attemptlimits_attemptlimits_id(attempt_limits_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_attemptlimits_attemptlimits_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **attempt_limits_id** | **String**| Attempt limits ID | **body** | [**AttemptLimits**](AttemptLimits.html)| AttemptLimits | {: class="table table-striped"} ### Return type [**AttemptLimits**](AttemptLimits.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CallableTimeSet**](CallableTimeSet.html) put_callabletimesets_callabletimeset_id(callable_time_set_id, body) Update callable time set ### Example ~~~ruby # load the gem require 'purecloud' # 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 callable_time_set_id = "callable_time_set_id_example" # String | Callable Time Set ID body = PureCloud::CallableTimeSet.new # CallableTimeSet | DialerCallableTimeSet begin #Update callable time set result = api_instance.put_callabletimesets_callabletimeset_id(callable_time_set_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_callabletimesets_callabletimeset_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **callable_time_set_id** | **String**| Callable Time Set ID | **body** | [**CallableTimeSet**](CallableTimeSet.html)| DialerCallableTimeSet | {: class="table table-striped"} ### Return type [**CallableTimeSet**](CallableTimeSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ResponseSet**](ResponseSet.html) put_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id, body) Update a dialer call analysis response set. ### Example ~~~ruby # load the gem require 'purecloud' # 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 call_analysis_set_id = "call_analysis_set_id_example" # String | Call Analysis Response Set ID body = PureCloud::ResponseSet.new # ResponseSet | ResponseSet begin #Update a dialer call analysis response set. result = api_instance.put_callanalysisresponsesets_callanalysisset_id(call_analysis_set_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_callanalysisresponsesets_callanalysisset_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **call_analysis_set_id** | **String**| Call Analysis Response Set ID | **body** | [**ResponseSet**](ResponseSet.html)| ResponseSet | {: class="table table-striped"} ### Return type [**ResponseSet**](ResponseSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignRule**](CampaignRule.html) put_campaignrules_campaignrule_id(campaign_rule_id, body) Update Campaign Rule ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_rule_id = "campaign_rule_id_example" # String | Campaign Rule ID body = PureCloud::CampaignRule.new # CampaignRule | CampaignRule begin #Update Campaign Rule result = api_instance.put_campaignrules_campaignrule_id(campaign_rule_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_campaignrules_campaignrule_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_rule_id** | **String**| Campaign Rule ID | **body** | [**CampaignRule**](CampaignRule.html)| CampaignRule | {: class="table table-striped"} ### Return type [**CampaignRule**](CampaignRule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**Campaign**](Campaign.html) put_campaigns_campaign_id(campaign_id, body) Update a campaign. ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID body = PureCloud::Campaign.new # Campaign | Campaign begin #Update a campaign. result = api_instance.put_campaigns_campaign_id(campaign_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_campaigns_campaign_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | **body** | [**Campaign**](Campaign.html)| Campaign | {: class="table table-striped"} ### Return type [**Campaign**](Campaign.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -String** put_campaigns_campaign_id_agents_user_id(campaign_id, user_id, body) Send notification that an agent's state changed New agent state. ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID user_id = "user_id_example" # String | Agent's user ID body = PureCloud::Agent.new # Agent | agent begin #Send notification that an agent's state changed result = api_instance.put_campaigns_campaign_id_agents_user_id(campaign_id, user_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_campaigns_campaign_id_agents_user_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | **user_id** | **String**| Agent's user ID | **body** | [**Agent**](Agent.html)| agent | {: class="table table-striped"} ### Return type **String** ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**ContactList**](ContactList.html) put_contactlists_contactlist_id(contact_list_id, body) Update a contact list. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id = "contact_list_id_example" # String | ContactList ID body = PureCloud::ContactList.new # ContactList | ContactList begin #Update a contact list. result = api_instance.put_contactlists_contactlist_id(contact_list_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_contactlists_contactlist_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| ContactList ID | **body** | [**ContactList**](ContactList.html)| ContactList | {: class="table table-striped"} ### Return type [**ContactList**](ContactList.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DialerContact**](DialerContact.html) put_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, body) Update a contact. ### Example ~~~ruby # load the gem require 'purecloud' # 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 contact_list_id = "contact_list_id_example" # String | Contact List ID contact_id = "contact_id_example" # String | Contact ID body = PureCloud::DialerContact.new # DialerContact | Contact begin #Update a contact. result = api_instance.put_contactlists_contactlist_id_contacts_contact_id(contact_list_id, contact_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_contactlists_contactlist_id_contacts_contact_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| Contact List ID | **contact_id** | **String**| Contact ID | **body** | [**DialerContact**](DialerContact.html)| Contact | {: class="table table-striped"} ### Return type [**DialerContact**](DialerContact.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**DncList**](DncList.html) put_dnclists_dnclist_id(dnc_list_id, body) Update dialer DNC list ### Example ~~~ruby # load the gem require 'purecloud' # 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 dnc_list_id = "dnc_list_id_example" # String | DncList ID body = PureCloud::DncList.new # DncList | DncList begin #Update dialer DNC list result = api_instance.put_dnclists_dnclist_id(dnc_list_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_dnclists_dnclist_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **dnc_list_id** | **String**| DncList ID | **body** | [**DncList**](DncList.html)| DncList | {: class="table table-striped"} ### Return type [**DncList**](DncList.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**RuleSet**](RuleSet.html) put_rulesets_ruleset_id(rule_set_id, body) Update a RuleSet. ### Example ~~~ruby # load the gem require 'purecloud' # 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 rule_set_id = "rule_set_id_example" # String | Rule Set ID body = PureCloud::RuleSet.new # RuleSet | RuleSet begin #Update a RuleSet. result = api_instance.put_rulesets_ruleset_id(rule_set_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_rulesets_ruleset_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **rule_set_id** | **String**| Rule Set ID | **body** | [**RuleSet**](RuleSet.html)| RuleSet | {: class="table table-striped"} ### Return type [**RuleSet**](RuleSet.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignSchedule**](CampaignSchedule.html) put_schedules_campaigns_campaign_id(campaign_id, body) Update a new campaign schedule. ### Example ~~~ruby # load the gem require 'purecloud' # 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 campaign_id = "campaign_id_example" # String | Campaign ID body = PureCloud::CampaignSchedule.new # CampaignSchedule | CampaignSchedule begin #Update a new campaign schedule. result = api_instance.put_schedules_campaigns_campaign_id(campaign_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_schedules_campaigns_campaign_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **campaign_id** | **String**| Campaign ID | **body** | [**CampaignSchedule**](CampaignSchedule.html)| CampaignSchedule | {: class="table table-striped"} ### Return type [**CampaignSchedule**](CampaignSchedule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**SequenceSchedule**](SequenceSchedule.html) put_schedules_sequences_sequence_id(sequence_id, body) Update a new sequence schedule. ### Example ~~~ruby # load the gem require 'purecloud' # 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 sequence_id = "sequence_id_example" # String | Sequence ID body = PureCloud::SequenceSchedule.new # SequenceSchedule | SequenceSchedule begin #Update a new sequence schedule. result = api_instance.put_schedules_sequences_sequence_id(sequence_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_schedules_sequences_sequence_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sequence_id** | **String**| Sequence ID | **body** | [**SequenceSchedule**](SequenceSchedule.html)| SequenceSchedule | {: class="table table-striped"} ### Return type [**SequenceSchedule**](SequenceSchedule.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**CampaignSequence**](CampaignSequence.html) put_sequences_sequence_id(sequence_id, body) Update a new campaign sequence. ### Example ~~~ruby # load the gem require 'purecloud' # 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 sequence_id = "sequence_id_example" # String | Campaign Sequence ID body = PureCloud::CampaignSequence.new # CampaignSequence | Organization begin #Update a new campaign sequence. result = api_instance.put_sequences_sequence_id(sequence_id, body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_sequences_sequence_id: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sequence_id** | **String**| Campaign Sequence ID | **body** | [**CampaignSequence**](CampaignSequence.html)| Organization | {: class="table table-striped"} ### Return type [**CampaignSequence**](CampaignSequence.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## -[**WrapUpCodeMapping**](WrapUpCodeMapping.html) put_wrapupcodemappings(body) Update the Dialer wrap up code mapping. ### Example ~~~ruby # load the gem require 'purecloud' # 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 body = PureCloud::WrapUpCodeMapping.new # WrapUpCodeMapping | wrapUpCodeMapping begin #Update the Dialer wrap up code mapping. result = api_instance.put_wrapupcodemappings(body) p result rescue PureCloud::ApiError => e puts "Exception when calling OutboundApi->put_wrapupcodemappings: #{e}" end ~~~ ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**WrapUpCodeMapping**](WrapUpCodeMapping.html)| wrapUpCodeMapping | {: class="table table-striped"} ### Return type [**WrapUpCodeMapping**](WrapUpCodeMapping.html) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json