docs/OutboundApi.md in purecloudplatformclientv2-22.0.0 vs docs/OutboundApi.md in purecloudplatformclientv2-23.0.0

- old
+ new

@@ -69,10 +69,11 @@ [**post_outbound_campaign_callback_schedule**](OutboundApi.html#post_outbound_campaign_callback_schedule) | Schedule a Callback for a Dialer Campaign (Deprecated) [**post_outbound_campaignrules**](OutboundApi.html#post_outbound_campaignrules) | Create Campaign Rule [**post_outbound_campaigns**](OutboundApi.html#post_outbound_campaigns) | Create a campaign. [**post_outbound_campaigns_progress**](OutboundApi.html#post_outbound_campaigns_progress) | Get progress for a list of campaigns [**post_outbound_contactlist_contacts**](OutboundApi.html#post_outbound_contactlist_contacts) | Add contacts to a contact list. +[**post_outbound_contactlist_contacts_bulk**](OutboundApi.html#post_outbound_contactlist_contacts_bulk) | Get contacts from a contact list. [**post_outbound_contactlist_export**](OutboundApi.html#post_outbound_contactlist_export) | Initiate the export of a contact list. [**post_outbound_contactlistfilters**](OutboundApi.html#post_outbound_contactlistfilters) | Create Contact List Filter [**post_outbound_contactlistfilters_preview**](OutboundApi.html#post_outbound_contactlistfilters_preview) | Get a preview of the output of a contact list filter [**post_outbound_contactlists**](OutboundApi.html#post_outbound_contactlists) | Create a contact List. [**post_outbound_conversation_dnc**](OutboundApi.html#post_outbound_conversation_dnc) | Add phone numbers to a Dialer DNC list. @@ -3955,9 +3956,71 @@ ------------- | ------------- | ------------- | ------------- **contact_list_id** | **String**| Contact List ID | | **body** | [**Array&lt;DialerContact&gt;**](DialerContact.html)| Contact | | **priority** | **BOOLEAN**| Contact priority. True means the contact(s) will be dialed next, false means the contact will go to the end of the contact queue. | [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&#39;t. | [optional] | +{: class="table table-striped"} + + +### Return type + +[**Array&lt;DialerContact&gt;**](DialerContact.html) + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + + + +<a name="post_outbound_contactlist_contacts_bulk"></a> + +## -[**Array&lt;DialerContact&gt;**](DialerContact.html) post_outbound_contactlist_contacts_bulk(contact_list_id, body) + +Get contacts from a contact list. + + + +Wraps POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk + + +### Example +~~~ruby +# load the gem +require 'purecloudplatformclientv2' +# setup authorization +@secret = ENV['PURECLOUD_SECRET'] +@id = ENV['PURECLOUD_CLIENT_ID'] +environment = "mypurecloud.com" + +@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment + +PureCloud.configure do |config| + config.access_token = @authToken +end + +api_instance = PureCloud::OutboundApi.new + +contact_list_id = "contact_list_id_example" # String | Contact List ID + +body = [PureCloud::Array<String>.new] # Array<String> | ContactIds to get. + + +begin + #Get contacts from a contact list. + result = api_instance.post_outbound_contactlist_contacts_bulk(contact_list_id, body) + p result +rescue PureCloud::ApiError => e + puts "Exception when calling OutboundApi->post_outbound_contactlist_contacts_bulk: #{e}" +end +~~~ + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **contact_list_id** | **String**| Contact List ID | | + **body** | **Array&lt;String&gt;**| ContactIds to get. | | {: class="table table-striped"} ### Return type