doc_out/OutboundApi.html.md in purecloud-0.50.1 vs doc_out/OutboundApi.html.md in purecloud-0.51.1

- old
+ new

@@ -6,10 +6,11 @@ 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_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.| @@ -17,17 +18,20 @@ |[**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_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.| @@ -44,10 +48,11 @@ |[**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_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| @@ -59,10 +64,11 @@ |[**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_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&#39;s state changed | |[**put_contactlists_contactlist_id**](OutboundApi.html#put_contactlists_contactlist_id) | **PUT** /api/v2/outbound/contactlists/{contactListId} | Update a contact list.| @@ -73,10 +79,66 @@ |[**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"} +<a name="delete_attemptlimits_attemptlimits_id"></a> + +## -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 + + + <a name="delete_callabletimesets_callabletimeset_id"></a> ## -String** delete_callabletimesets_callabletimeset_id(callable_time_set_id) Delete callable time set @@ -692,10 +754,133 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_attemptlimits"></a> + +## -[**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 + + + +<a name="get_attemptlimits_attemptlimits_id"></a> + +## -[**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 + + + <a name="get_callabletimesets"></a> ## -[**CallableTimeSetEntityListing**](CallableTimeSetEntityListing.html) get_callabletimesets(opts) Query callable time set list @@ -1127,10 +1312,66 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="get_campaigns_campaign_id_interactions"></a> + +## -[**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 + + + <a name="get_campaigns_campaign_id_progress"></a> ## -[**CampaignProgress**](CampaignProgress.html) get_campaigns_campaign_id_progress(campaign_id) Get campaign progress @@ -2304,10 +2545,66 @@ - **Content-Type**: application/json - **Accept**: application/json +<a name="post_attemptlimits"></a> + +## -[**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 + + + <a name="post_audits"></a> ## -[**AuditSearchResult**](AuditSearchResult.html) post_audits(body, opts) Retrieves audits for dialer. @@ -3159,9 +3456,68 @@ ### Return type [**CampaignSequence**](CampaignSequence.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="put_attemptlimits_attemptlimits_id"></a> + +## -[**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