instruction
stringlengths 81
221
| input
stringlengths 50
1.19k
| output
stringlengths 525
3.61k
|
|---|---|---|
Provide a Python example that uses the GET /api/v2/outbound/attemptlimits/{attemptLimitsId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get attempt limits
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
attempt_limits_id = 'attempt_limits_id_example' # str | Attempt limits ID
try:
# Get attempt limits
api_response = api_instance.get_outbound_attemptlimit(attempt_limits_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_attemptlimit: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/attemptlimits/{attemptLimitsId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update attempt limits
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
attempt_limits_id = 'attempt_limits_id_example' # str | Attempt limits ID
body = PureCloudPlatformClientV2.AttemptLimits() # AttemptLimits | AttemptLimits
try:
# Update attempt limits
api_response = api_instance.put_outbound_attemptlimit(attempt_limits_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_attemptlimit: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/callabletimesets Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query callable time set list
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query callable time set list
api_response = api_instance.get_outbound_callabletimesets(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_callabletimesets: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/callabletimesets Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create callable time set
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.CallableTimeSet() # CallableTimeSet | DialerCallableTimeSet
try:
# Create callable time set
api_response = api_instance.post_outbound_callabletimesets(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_callabletimesets: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/callabletimesets/{callableTimeSetId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete callable time set
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
callable_time_set_id = 'callable_time_set_id_example' # str | Callable Time Set ID
try:
# Delete callable time set
api_instance.delete_outbound_callabletimeset(callable_time_set_id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_callabletimeset: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/callabletimesets/{callableTimeSetId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get callable time set
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
callable_time_set_id = 'callable_time_set_id_example' # str | Callable Time Set ID
try:
# Get callable time set
api_response = api_instance.get_outbound_callabletimeset(callable_time_set_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_callabletimeset: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/callabletimesets/{callableTimeSetId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update callable time set
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
callable_time_set_id = 'callable_time_set_id_example' # str | Callable Time Set ID
body = PureCloudPlatformClientV2.CallableTimeSet() # CallableTimeSet | DialerCallableTimeSet
try:
# Update callable time set
api_response = api_instance.put_outbound_callabletimeset(callable_time_set_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_callabletimeset: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/callanalysisresponsesets Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query a list of dialer call analysis response sets.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query a list of dialer call analysis response sets.
api_response = api_instance.get_outbound_callanalysisresponsesets(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_callanalysisresponsesets: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/callanalysisresponsesets Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a dialer call analysis response set.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.ResponseSet() # ResponseSet | ResponseSet
try:
# Create a dialer call analysis response set.
api_response = api_instance.post_outbound_callanalysisresponsesets(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_callanalysisresponsesets: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a dialer call analysis response set.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
call_analysis_set_id = 'call_analysis_set_id_example' # str | Call Analysis Response Set ID
try:
# Delete a dialer call analysis response set.
api_instance.delete_outbound_callanalysisresponseset(call_analysis_set_id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_callanalysisresponseset: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a dialer call analysis response set.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
call_analysis_set_id = 'call_analysis_set_id_example' # str | Call Analysis Response Set ID
try:
# Get a dialer call analysis response set.
api_response = api_instance.get_outbound_callanalysisresponseset(call_analysis_set_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_callanalysisresponseset: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a dialer call analysis response set.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
call_analysis_set_id = 'call_analysis_set_id_example' # str | Call Analysis Response Set ID
body = PureCloudPlatformClientV2.ResponseSet() # ResponseSet | ResponseSet
try:
# Update a dialer call analysis response set.
api_response = api_instance.put_outbound_callanalysisresponseset(call_analysis_set_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_callanalysisresponseset: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaignrules Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query Campaign Rule list
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query Campaign Rule list
api_response = api_instance.get_outbound_campaignrules(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaignrules: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/campaignrules Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create Campaign Rule
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.CampaignRule() # CampaignRule | CampaignRule
try:
# Create Campaign Rule
api_response = api_instance.post_outbound_campaignrules(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_campaignrules: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/campaignrules/{campaignRuleId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete Campaign Rule
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_rule_id = 'campaign_rule_id_example' # str | Campaign Rule ID
try:
# Delete Campaign Rule
api_instance.delete_outbound_campaignrule(campaign_rule_id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_campaignrule: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaignrules/{campaignRuleId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Campaign Rule
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_rule_id = 'campaign_rule_id_example' # str | Campaign Rule ID
try:
# Get Campaign Rule
api_response = api_instance.get_outbound_campaignrule(campaign_rule_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaignrule: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/campaignrules/{campaignRuleId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update Campaign Rule
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_rule_id = 'campaign_rule_id_example' # str | Campaign Rule ID
body = PureCloudPlatformClientV2.CampaignRule() # CampaignRule | CampaignRule
try:
# Update Campaign Rule
api_response = api_instance.put_outbound_campaignrule(campaign_rule_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_campaignrule: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query a list of dialer campaigns.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
id = ['id_example'] # list[str] | id (optional)
contact_list_id = 'contact_list_id_example' # str | Contact List ID (optional)
dnc_list_ids = 'dnc_list_ids_example' # str | DNC list ID (optional)
distribution_queue_id = 'distribution_queue_id_example' # str | Distribution queue ID (optional)
edge_group_id = 'edge_group_id_example' # str | Edge group ID (optional)
call_analysis_response_set_id = 'call_analysis_response_set_id_example' # str | Call analysis response set ID (optional)
division_id = ['division_id_example'] # list[str] | Division ID(s) (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query a list of dialer campaigns.
api_response = api_instance.get_outbound_campaigns(page_size=page_size, page_number=page_number, filter_type=filter_type, name=name, id=id, contact_list_id=contact_list_id, dnc_list_ids=dnc_list_ids, distribution_queue_id=distribution_queue_id, edge_group_id=edge_group_id, call_analysis_response_set_id=call_analysis_response_set_id, division_id=division_id, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaigns: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/campaigns Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a campaign.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.Campaign() # Campaign | Campaign
try:
# Create a campaign.
api_response = api_instance.post_outbound_campaigns(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_campaigns: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/all Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query across all types of campaigns by division
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
id = ['id_example'] # list[str] | Campaign ID(s) (optional)
name = 'name_example' # str | Campaign name(s) (optional)
division_id = ['division_id_example'] # list[str] | Division ID(s) (optional)
media_type = ['media_type_example'] # list[str] | Media type(s) (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query across all types of campaigns by division
api_response = api_instance.get_outbound_campaigns_all(page_size=page_size, page_number=page_number, id=id, name=name, division_id=division_id, media_type=media_type, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaigns_all: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/all/divisionviews Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query across all types of campaigns
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
id = ['id_example'] # list[str] | Campaign ID(s) (optional)
name = 'name_example' # str | Campaign name(s) (optional)
division_id = ['division_id_example'] # list[str] | Division ID(s) (optional)
media_type = ['media_type_example'] # list[str] | Media type(s) (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query across all types of campaigns
api_response = api_instance.get_outbound_campaigns_all_divisionviews(page_size=page_size, page_number=page_number, id=id, name=name, division_id=division_id, media_type=media_type, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaigns_all_divisionviews: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/divisionviews Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query a list of basic Campaign information objects. This returns a simplified version of a Campaign, consisting of name and division.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
id = ['id_example'] # list[str] | id (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query a list of basic Campaign information objects
api_response = api_instance.get_outbound_campaigns_divisionviews(page_size=page_size, page_number=page_number, filter_type=filter_type, name=name, id=id, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaigns_divisionviews: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/divisionviews/{campaignId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a basic Campaign information object. This returns a simplified version of a Campaign, consisting of name and division.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
try:
# Get a basic Campaign information object
api_response = api_instance.get_outbound_campaigns_divisionview(campaign_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaigns_divisionview: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/campaigns/progress Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get progress for a list of campaigns
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = ['body_example'] # list[str] | Campaign IDs
try:
# Get progress for a list of campaigns
api_response = api_instance.post_outbound_campaigns_progress(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_campaigns_progress: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/campaigns/{campaignId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a campaign.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
try:
# Delete a campaign.
api_response = api_instance.delete_outbound_campaign(campaign_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_campaign: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get dialer campaign.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
try:
# Get dialer campaign.
api_response = api_instance.get_outbound_campaign(campaign_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaign: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/outbound/campaigns/{campaignId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a campaign.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
body = PureCloudPlatformClientV2.CampaignPatchRequest() # CampaignPatchRequest | CampaignPatchRequest
try:
# Update a campaign.
api_instance.patch_outbound_campaign(campaign_id, body)
except ApiException as e:
print("Exception when calling OutboundApi->patch_outbound_campaign: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/campaigns/{campaignId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a campaign.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
body = PureCloudPlatformClientV2.Campaign() # Campaign | Campaign
try:
# Update a campaign.
api_response = api_instance.put_outbound_campaign(campaign_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_campaign: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Initiate request for a preview of how agents will be mapped to this campaign's contact list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
try:
# Initiate request for a preview of how agents will be mapped to this campaign's contact list.
api_response = api_instance.post_outbound_campaign_agentownedmappingpreview(campaign_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_campaign_agentownedmappingpreview: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a preview of how agents will be mapped to this campaign's contact list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
try:
# Get a preview of how agents will be mapped to this campaign's contact list.
api_response = api_instance.get_outbound_campaign_agentownedmappingpreview_results(campaign_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaign_agentownedmappingpreview_results: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/campaigns/{campaignId}/agents/{userId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Send notification that an agent's state changed. New agent state.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
user_id = 'user_id_example' # str | Agent's user ID
body = PureCloudPlatformClientV2.Agent() # Agent | agent
try:
# Send notification that an agent's state changed
api_response = api_instance.put_outbound_campaign_agent(campaign_id, user_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_campaign_agent: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/diagnostics Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get campaign diagnostics
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
try:
# Get campaign diagnostics
api_response = api_instance.get_outbound_campaign_diagnostics(campaign_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaign_diagnostics: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/interactions Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get dialer campaign interactions.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
try:
# Get dialer campaign interactions.
api_response = api_instance.get_outbound_campaign_interactions(campaign_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaign_interactions: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/linedistribution Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get line distribution information for campaigns using same Edge Group or Site as given campaign
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
include_only_active_campaigns = True # bool | If true will return only active Campaigns (optional) (default to True)
edge_group_id = 'edge_group_id_example' # str | Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive. (optional)
site_id = 'site_id_example' # str | Site to be used in line distribution calculations instead of current Campaign's Site. Campaign's Site and Edge Group are mutually exclusive. (optional)
use_weight = True # bool | Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations (optional)
relative_weight = 56 # int | Relative weight to be used in line distribution calculations instead of current Campaign's relative weight (optional)
outbound_line_count = 56 # int | The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count (optional)
try:
# Get line distribution information for campaigns using same Edge Group or Site as given campaign
api_response = api_instance.get_outbound_campaign_linedistribution(campaign_id, include_only_active_campaigns=include_only_active_campaigns, edge_group_id=edge_group_id, site_id=site_id, use_weight=use_weight, relative_weight=relative_weight, outbound_line_count=outbound_line_count)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaign_linedistribution: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/campaigns/{campaignId}/progress Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Reset campaign progress and recycle the campaign
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
try:
# Reset campaign progress and recycle the campaign
api_instance.delete_outbound_campaign_progress(campaign_id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_campaign_progress: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/progress Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get campaign progress
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
try:
# Get campaign progress
api_response = api_instance.get_outbound_campaign_progress(campaign_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaign_progress: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/skillcombinations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the remaining and total contact count for each skill combination in a skills campaign
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get the remaining and total contact count for each skill combination in a skills campaign
api_response = api_instance.get_outbound_campaign_skillcombinations(campaign_id, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaign_skillcombinations: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/stats Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get statistics about a Dialer Campaign
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
campaign_id = 'campaign_id_example' # str | Campaign ID
try:
# Get statistics about a Dialer Campaign
api_response = api_instance.get_outbound_campaign_stats(campaign_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_campaign_stats: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlistfilters Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query Contact list filters
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
contact_list_id = 'contact_list_id_example' # str | Contact List ID (optional)
try:
# Query Contact list filters
api_response = api_instance.get_outbound_contactlistfilters(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order, contact_list_id=contact_list_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlistfilters: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlistfilters Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create Contact List Filter
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.ContactListFilter() # ContactListFilter | ContactListFilter
try:
# Create Contact List Filter
api_response = api_instance.post_outbound_contactlistfilters(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlistfilters: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlistfilters/bulk/retrieve Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve multiple contact list filters
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.ContactListFilterBulkRetrieveBody() # ContactListFilterBulkRetrieveBody | The contact list filters to retrieve
try:
# Retrieve multiple contact list filters
api_response = api_instance.post_outbound_contactlistfilters_bulk_retrieve(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlistfilters_bulk_retrieve: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlistfilters/preview Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a preview of the output of a contact list filter
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.ContactListFilter() # ContactListFilter | ContactListFilter
try:
# Get a preview of the output of a contact list filter
api_response = api_instance.post_outbound_contactlistfilters_preview(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlistfilters_preview: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/contactlistfilters/{contactListFilterId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete Contact List Filter
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_filter_id = 'contact_list_filter_id_example' # str | Contact List Filter ID
try:
# Delete Contact List Filter
api_instance.delete_outbound_contactlistfilter(contact_list_filter_id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_contactlistfilter: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlistfilters/{contactListFilterId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Contact list filter
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_filter_id = 'contact_list_filter_id_example' # str | Contact List Filter ID
try:
# Get Contact list filter
api_response = api_instance.get_outbound_contactlistfilter(contact_list_filter_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlistfilter: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/contactlistfilters/{contactListFilterId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update Contact List Filter
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_filter_id = 'contact_list_filter_id_example' # str | Contact List Filter ID
body = PureCloudPlatformClientV2.ContactListFilter() # ContactListFilter | ContactListFilter
try:
# Update Contact List Filter
api_response = api_instance.put_outbound_contactlistfilter(contact_list_filter_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_contactlistfilter: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/contactlists Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete multiple contact lists.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
id = ['id_example'] # list[str] | contact list id(s) to delete
try:
# Delete multiple contact lists.
api_instance.delete_outbound_contactlists(id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_contactlists: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlists Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query a list of contact lists.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
include_import_status = False # bool | Include import status (optional) (default to False)
include_size = False # bool | Include size (optional) (default to False)
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
id = ['id_example'] # list[str] | id (optional)
division_id = ['division_id_example'] # list[str] | Division ID(s) (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query a list of contact lists.
api_response = api_instance.get_outbound_contactlists(include_import_status=include_import_status, include_size=include_size, page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, id=id, division_id=division_id, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlists: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlists Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a contact List.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.ContactList() # ContactList | ContactList
try:
# Create a contact List.
api_response = api_instance.post_outbound_contactlists(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlists: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlists/divisionviews Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
include_import_status = False # bool | Include import status (optional) (default to False)
include_size = False # bool | Include size (optional) (default to False)
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
id = ['id_example'] # list[str] | id (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query a list of simplified contact list objects.
api_response = api_instance.get_outbound_contactlists_divisionviews(include_import_status=include_import_status, include_size=include_size, page_size=page_size, page_number=page_number, filter_type=filter_type, name=name, id=id, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlists_divisionviews: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlists/divisionviews/{contactListId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a basic ContactList information object. This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contactlist ID
include_import_status = False # bool | Include import status (optional) (default to False)
include_size = False # bool | Include size (optional) (default to False)
try:
# Get a basic ContactList information object
api_response = api_instance.get_outbound_contactlists_divisionview(contact_list_id, include_import_status=include_import_status, include_size=include_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlists_divisionview: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/contactlists/{contactListId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a contact list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | ContactList ID
try:
# Delete a contact list.
api_instance.delete_outbound_contactlist(contact_list_id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_contactlist: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a dialer contact list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | ContactList ID
include_import_status = False # bool | Import status (optional) (default to False)
include_size = False # bool | Include size (optional) (default to False)
try:
# Get a dialer contact list.
api_response = api_instance.get_outbound_contactlist(contact_list_id, include_import_status=include_import_status, include_size=include_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlist: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/contactlists/{contactListId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a contact list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | ContactList ID
body = PureCloudPlatformClientV2.ContactList() # ContactList | ContactList
try:
# Update a contact list.
api_response = api_instance.put_outbound_contactlist(contact_list_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_contactlist: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/clear Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
try:
# Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.
api_instance.post_outbound_contactlist_clear(contact_list_id)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlist_clear: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/contactlists/{contactListId}/contacts Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete contacts from a contact list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
contact_ids = ['contact_ids_example'] # list[str] | ContactIds to delete.
try:
# Delete contacts from a contact list.
api_instance.delete_outbound_contactlist_contacts(contact_list_id, contact_ids)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_contactlist_contacts: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/contacts Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add contacts to a contact list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
body = [PureCloudPlatformClientV2.WritableDialerContact()] # list[WritableDialerContact] | Contact
priority = True # bool | 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 = True # bool | Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't. (optional)
do_not_queue = True # bool | Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter. (optional)
try:
# Add contacts to a contact list.
api_response = api_instance.post_outbound_contactlist_contacts(contact_list_id, body, priority=priority, clear_system_data=clear_system_data, do_not_queue=do_not_queue)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlist_contacts: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get contacts from a contact list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
body = ['body_example'] # list[str] | ContactIds to get.
try:
# Get contacts from a contact list.
api_response = api_instance.post_outbound_contactlist_contacts_bulk(contact_list_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlist_contacts_bulk: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get 10 most recent bulk operation jobs associated with contact list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
try:
# Get 10 most recent bulk operation jobs associated with contact list.
api_response = api_instance.get_outbound_contactlist_contacts_bulk_jobs(contact_list_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlist_contacts_bulk_jobs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get bulk operation job.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
job_id = 'job_id_example' # str | Job ID
try:
# Get bulk operation job.
api_response = api_instance.get_outbound_contactlist_contacts_bulk_job(contact_list_id, job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlist_contacts_bulk_job: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Start an async job to delete contacts using a filter.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
body = PureCloudPlatformClientV2.ContactBulkSearchParameters() # ContactBulkSearchParameters | Contact filter information.
try:
# Start an async job to delete contacts using a filter.
api_response = api_instance.post_outbound_contactlist_contacts_bulk_remove(contact_list_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlist_contacts_bulk_remove: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Start an async job to bulk edit contacts.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
body = PureCloudPlatformClientV2.ContactBulkEditRequest() # ContactBulkEditRequest | Contact bulk edit request information.
try:
# Start an async job to bulk edit contacts.
api_response = api_instance.post_outbound_contactlist_contacts_bulk_update(contact_list_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlist_contacts_bulk_update: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/contacts/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query contacts from a contact list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
body = PureCloudPlatformClientV2.ContactListingRequest() # ContactListingRequest | Contact search parameters.
try:
# Query contacts from a contact list.
api_response = api_instance.post_outbound_contactlist_contacts_search(contact_list_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlist_contacts_search: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a contact.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
contact_id = 'contact_id_example' # str | Contact ID
try:
# Delete a contact.
api_instance.delete_outbound_contactlist_contact(contact_list_id, contact_id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_contactlist_contact: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a contact.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
contact_id = 'contact_id_example' # str | Contact ID
try:
# Get a contact.
api_response = api_instance.get_outbound_contactlist_contact(contact_list_id, contact_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlist_contact: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a contact.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | Contact List ID
contact_id = 'contact_id_example' # str | Contact ID
body = PureCloudPlatformClientV2.DialerContact() # DialerContact | Contact
try:
# Update a contact.
api_response = api_instance.put_outbound_contactlist_contact(contact_list_id, contact_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_contactlist_contact: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/export Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the URI of a contact list export.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | ContactList ID
download = ''false'' # str | Redirect to download uri (optional) (default to 'false')
try:
# Get the URI of a contact list export.
api_response = api_instance.get_outbound_contactlist_export(contact_list_id, download=download)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlist_export: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/export Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Initiate the export of a contact list. Returns 200 if received OK.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | ContactList ID
body = PureCloudPlatformClientV2.ContactsExportRequest() # ContactsExportRequest | Export information to get (optional)
try:
# Initiate the export of a contact list.
api_response = api_instance.post_outbound_contactlist_export(contact_list_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlist_export: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/importstatus Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get dialer contactList import status.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | ContactList ID
try:
# Get dialer contactList import status.
api_response = api_instance.get_outbound_contactlist_importstatus(contact_list_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlist_importstatus: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Preview the result of applying Automatic Time Zone Mapping to a contact list
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_id = 'contact_list_id_example' # str | ContactList ID
try:
# Preview the result of applying Automatic Time Zone Mapping to a contact list
api_response = api_instance.get_outbound_contactlist_timezonemappingpreview(contact_list_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlist_timezonemappingpreview: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/contactlisttemplates Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete multiple contact list templates.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
id = ['id_example'] # list[str] | contact list template id(s) to delete
try:
# Delete multiple contact list templates.
api_instance.delete_outbound_contactlisttemplates(id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_contactlisttemplates: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlisttemplates Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query a list of contact list templates
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query a list of contact list templates
api_response = api_instance.get_outbound_contactlisttemplates(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlisttemplates: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlisttemplates Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create Contact List Template
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.ContactListTemplate() # ContactListTemplate | ContactListTemplate
try:
# Create Contact List Template
api_response = api_instance.post_outbound_contactlisttemplates(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlisttemplates: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlisttemplates/bulk/add Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add multiple contact list templates
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = [PureCloudPlatformClientV2.ContactListTemplate()] # list[ContactListTemplate] | contact list template(s) to add
try:
# Add multiple contact list templates
api_response = api_instance.post_outbound_contactlisttemplates_bulk_add(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlisttemplates_bulk_add: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/contactlisttemplates/bulk/retrieve Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get multiple contact list templates
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.ContactListTemplateBulkRetrieveBody() # ContactListTemplateBulkRetrieveBody | contact list templates to get
try:
# Get multiple contact list templates
api_response = api_instance.post_outbound_contactlisttemplates_bulk_retrieve(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_contactlisttemplates_bulk_retrieve: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/contactlisttemplates/{contactListTemplateId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete Contact List Template
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_template_id = 'contact_list_template_id_example' # str | ContactListTemplate ID
try:
# Delete Contact List Template
api_instance.delete_outbound_contactlisttemplate(contact_list_template_id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_contactlisttemplate: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/contactlisttemplates/{contactListTemplateId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Contact List Template
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_template_id = 'contact_list_template_id_example' # str | ContactListTemplate ID
try:
# Get Contact List Template
api_response = api_instance.get_outbound_contactlisttemplate(contact_list_template_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_contactlisttemplate: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/contactlisttemplates/{contactListTemplateId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a contact list template.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
contact_list_template_id = 'contact_list_template_id_example' # str | ContactListTemplate ID
body = PureCloudPlatformClientV2.ContactListTemplate() # ContactListTemplate | ContactListTemplate
try:
# Update a contact list template.
api_response = api_instance.put_outbound_contactlisttemplate(contact_list_template_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_contactlisttemplate: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/conversations/{conversationId}/dnc Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add phone numbers to a Dialer DNC list.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
conversation_id = 'conversation_id_example' # str | Conversation ID
try:
# Add phone numbers to a Dialer DNC list.
api_instance.post_outbound_conversation_dnc(conversation_id)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_conversation_dnc: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/digitalrulesets Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query a list of Outbound Digital Rule Sets
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
sort_by = ''name'' # str | The field to sort by (optional) (default to 'name')
sort_order = ''ascending'' # str | The direction to sort (optional) (default to 'ascending')
name = 'name_example' # str | Name (optional)
id = ['id_example'] # list[str] | A list of digital rule set ids to bulk fetch (optional)
try:
# Query a list of Outbound Digital Rule Sets
api_response = api_instance.get_outbound_digitalrulesets(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, name=name, id=id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_digitalrulesets: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/digitalrulesets Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create an Outbound Digital Rule Set
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.DigitalRuleSet() # DigitalRuleSet | Digital Rule Set
try:
# Create an Outbound Digital Rule Set
api_response = api_instance.post_outbound_digitalrulesets(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_digitalrulesets: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/digitalrulesets/{digitalRuleSetId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete an Outbound Digital Rule Set
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
digital_rule_set_id = 'digital_rule_set_id_example' # str | The Digital Rule Set ID
try:
# Delete an Outbound Digital Rule Set
api_instance.delete_outbound_digitalruleset(digital_rule_set_id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_digitalruleset: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/digitalrulesets/{digitalRuleSetId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get an Outbound Digital Rule Set
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
digital_rule_set_id = 'digital_rule_set_id_example' # str | The Digital Rule Set ID
try:
# Get an Outbound Digital Rule Set
api_response = api_instance.get_outbound_digitalruleset(digital_rule_set_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_digitalruleset: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/digitalrulesets/{digitalRuleSetId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update an Outbound Digital Rule Set
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
digital_rule_set_id = 'digital_rule_set_id_example' # str | The Digital Rule Set ID
body = PureCloudPlatformClientV2.DigitalRuleSet() # DigitalRuleSet | Digital Rule Set
try:
# Update an Outbound Digital Rule Set
api_response = api_instance.put_outbound_digitalruleset(digital_rule_set_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_digitalruleset: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/dnclists Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query dialer DNC lists
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
include_import_status = False # bool | Import status (optional) (default to False)
include_size = False # bool | Include size (optional) (default to False)
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
dnc_source_type = 'dnc_source_type_example' # str | DncSourceType (optional)
division_id = ['division_id_example'] # list[str] | Division ID(s) (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = 'sort_order_example' # str | Sort order (optional)
try:
# Query dialer DNC lists
api_response = api_instance.get_outbound_dnclists(include_import_status=include_import_status, include_size=include_size, page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, dnc_source_type=dnc_source_type, division_id=division_id, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_dnclists: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/dnclists Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create dialer DNC list
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
body = PureCloudPlatformClientV2.DncListCreate() # DncListCreate | DncList
try:
# Create dialer DNC list
api_response = api_instance.post_outbound_dnclists(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_dnclists: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/dnclists/divisionviews Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
include_import_status = False # bool | Include import status (optional) (default to False)
include_size = False # bool | Include size (optional) (default to False)
page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix')
name = 'name_example' # str | Name (optional)
dnc_source_type = 'dnc_source_type_example' # str | DncSourceType (optional)
id = ['id_example'] # list[str] | id (optional)
sort_by = 'sort_by_example' # str | Sort by (optional)
sort_order = ''a'' # str | Sort order (optional) (default to 'a')
try:
# Query a list of simplified dnc list objects.
api_response = api_instance.get_outbound_dnclists_divisionviews(include_import_status=include_import_status, include_size=include_size, page_size=page_size, page_number=page_number, filter_type=filter_type, name=name, dnc_source_type=dnc_source_type, id=id, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_dnclists_divisionviews: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/dnclists/divisionviews/{dncListId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a basic DncList information object. This returns a simplified version of a DncList, consisting of the name, division, import status, and size.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | Dnclist ID
include_import_status = False # bool | Include import status (optional) (default to False)
include_size = False # bool | Include size (optional) (default to False)
try:
# Get a basic DncList information object
api_response = api_instance.get_outbound_dnclists_divisionview(dnc_list_id, include_import_status=include_import_status, include_size=include_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_dnclists_divisionview: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/dnclists/{dncListId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete dialer DNC list
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
try:
# Delete dialer DNC list
api_instance.delete_outbound_dnclist(dnc_list_id)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_dnclist: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/dnclists/{dncListId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get dialer DNC list
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
include_import_status = False # bool | Import status (optional) (default to False)
include_size = False # bool | Include size (optional) (default to False)
try:
# Get dialer DNC list
api_response = api_instance.get_outbound_dnclist(dnc_list_id, include_import_status=include_import_status, include_size=include_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_dnclist: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/outbound/dnclists/{dncListId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update dialer DNC list
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
body = PureCloudPlatformClientV2.DncList() # DncList | DncList
try:
# Update dialer DNC list
api_response = api_instance.put_outbound_dnclist(dnc_list_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->put_outbound_dnclist: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Deletes all or expired custom exclusion column entries from a DNC list. This operation is only for Internal DNC lists of custom exclusion column entries
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
expired_only = False # bool | Set to true to only remove DNC entries that are expired (optional) (default to False)
try:
# Deletes all or expired custom exclusion column entries from a DNC list.
api_instance.delete_outbound_dnclist_customexclusioncolumns(dnc_list_id, expired_only=expired_only)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_dnclist_customexclusioncolumns: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
body = PureCloudPlatformClientV2.DncPatchCustomExclusionColumnsRequest() # DncPatchCustomExclusionColumnsRequest | DNC Custom exclusion column entries
try:
# Add entries to or delete entries from a DNC list.
api_instance.patch_outbound_dnclist_customexclusioncolumns(dnc_list_id, body)
except ApiException as e:
print("Exception when calling OutboundApi->patch_outbound_dnclist_customexclusioncolumns: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/dnclists/{dncListId}/emailaddresses Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Deletes all or expired email addresses from a DNC list. This operation is Only for Internal DNC lists of email addresses
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
expired_only = False # bool | Set to true to only remove DNC entries that are expired (optional) (default to False)
try:
# Deletes all or expired email addresses from a DNC list.
api_instance.delete_outbound_dnclist_emailaddresses(dnc_list_id, expired_only=expired_only)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_dnclist_emailaddresses: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/outbound/dnclists/{dncListId}/emailaddresses Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add emails to or Delete emails from a DNC list. Only Internal DNC lists may be added to or deleted from
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
body = PureCloudPlatformClientV2.DncPatchEmailsRequest() # DncPatchEmailsRequest | DNC Emails
try:
# Add emails to or Delete emails from a DNC list.
api_instance.patch_outbound_dnclist_emailaddresses(dnc_list_id, body)
except ApiException as e:
print("Exception when calling OutboundApi->patch_outbound_dnclist_emailaddresses: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/dnclists/{dncListId}/emailaddresses Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add email addresses to a DNC list. Only Internal DNC lists may be appended to
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
body = ['body_example'] # list[str] | DNC email addresses
try:
# Add email addresses to a DNC list.
api_instance.post_outbound_dnclist_emailaddresses(dnc_list_id, body)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_dnclist_emailaddresses: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/dnclists/{dncListId}/export Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the URI of a DNC list export.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
download = ''false'' # str | Redirect to download uri (optional) (default to 'false')
try:
# Get the URI of a DNC list export.
api_response = api_instance.get_outbound_dnclist_export(dnc_list_id, download=download)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_dnclist_export: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/outbound/dnclists/{dncListId}/export Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Initiate the export of a dnc list. Returns 200 if received OK.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
try:
# Initiate the export of a dnc list.
api_response = api_instance.post_outbound_dnclist_export(dnc_list_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->post_outbound_dnclist_export: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/outbound/dnclists/{dncListId}/importstatus Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get dialer dncList import status.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
try:
# Get dialer dncList import status.
api_response = api_instance.get_outbound_dnclist_importstatus(dnc_list_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling OutboundApi->get_outbound_dnclist_importstatus: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/outbound/dnclists/{dncListId}/phonenumbers Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Deletes all or expired phone numbers from a DNC list. This operation is Only for Internal DNC lists of phone numbers
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
expired_only = False # bool | Set to true to only remove DNC entries that are expired (optional) (default to False)
try:
# Deletes all or expired phone numbers from a DNC list.
api_instance.delete_outbound_dnclist_phonenumbers(dnc_list_id, expired_only=expired_only)
except ApiException as e:
print("Exception when calling OutboundApi->delete_outbound_dnclist_phonenumbers: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/outbound/dnclists/{dncListId}/phonenumbers Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add numbers to or delete numbers from a DNC list. Only Internal DNC lists may be added to deleted from
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.OutboundApi();
dnc_list_id = 'dnc_list_id_example' # str | DncList ID
body = PureCloudPlatformClientV2.DncPatchPhoneNumbersRequest() # DncPatchPhoneNumbersRequest | DNC Phone Numbers
try:
# Add numbers to or delete numbers from a DNC list.
api_instance.patch_outbound_dnclist_phonenumbers(dnc_list_id, body)
except ApiException as e:
print("Exception when calling OutboundApi->patch_outbound_dnclist_phonenumbers: %s\n" % e)```
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.