instruction
stringlengths 81
221
| input
stringlengths 50
1.19k
| output
stringlengths 525
3.61k
|
|---|---|---|
Provide a Python example that uses the GET /api/v2/identityproviders/salesforce Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Salesforce Identity Provider
|
```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.IdentityProviderApi();
try:
# Get Salesforce Identity Provider
api_response = api_instance.get_identityproviders_salesforce()
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityproviders_salesforce: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/salesforce Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update/Create Salesforce Identity Provider
|
```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.IdentityProviderApi();
body = PureCloudPlatformClientV2.Salesforce() # Salesforce | Provider
try:
# Update/Create Salesforce Identity Provider
api_response = api_instance.put_identityproviders_salesforce(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityproviders_salesforce: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/identityproviders/{providerId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete Identity Provider
|
```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.IdentityProviderApi();
provider_id = 'provider_id_example' # str | Provider ID
try:
# Delete Identity Provider
api_instance.delete_identityprovider(provider_id)
except ApiException as e:
print("Exception when calling IdentityProviderApi->delete_identityprovider: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/identityproviders/{providerId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Identity Provider
|
```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.IdentityProviderApi();
provider_id = 'provider_id_example' # str | Provider ID
try:
# Get Identity Provider
api_response = api_instance.get_identityprovider(provider_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->get_identityprovider: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/identityproviders/{providerId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update Identity Provider
|
```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.IdentityProviderApi();
provider_id = 'provider_id_example' # str | Provider ID
body = PureCloudPlatformClientV2.CustomProvider() # CustomProvider | Provider
try:
# Update Identity Provider
api_response = api_instance.put_identityprovider(provider_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IdentityProviderApi->put_identityprovider: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/infrastructureascode/accelerators Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of available accelerators. Search for accelerators that can be run.
|
```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.InfrastructureAsCodeApi();
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
sort_by = 'sort_by_example' # str | variable name requested to sort by (optional)
sort_order = ''asc'' # str | Sort order (optional) (default to 'asc')
name = 'name_example' # str | Filter by name (optional)
description = 'description_example' # str | Filter by description (optional)
origin = 'origin_example' # str | Filter by origin (optional)
type = 'type_example' # str | Filter by type (optional)
classification = 'classification_example' # str | Filter by classification (optional)
tags = 'tags_example' # str | Filter by tags (optional)
try:
# Get a list of available accelerators
api_response = api_instance.get_infrastructureascode_accelerators(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, name=name, description=description, origin=origin, type=type, classification=classification, tags=tags)
pprint(api_response)
except ApiException as e:
print("Exception when calling InfrastructureAsCodeApi->get_infrastructureascode_accelerators: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/infrastructureascode/accelerators/{acceleratorId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get information about an accelerator. Get the complete metadata specification for an accelerator, including requirements and parameters.
|
```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.InfrastructureAsCodeApi();
accelerator_id = 'accelerator_id_example' # str | Accelerator ID
preferred_language = ''en-US'' # str | Preferred Language (optional) (default to 'en-US')
try:
# Get information about an accelerator
api_response = api_instance.get_infrastructureascode_accelerator(accelerator_id, preferred_language=preferred_language)
pprint(api_response)
except ApiException as e:
print("Exception when calling InfrastructureAsCodeApi->get_infrastructureascode_accelerator: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/infrastructureascode/jobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get job history. Get a history of submitted jobs, optionally including error messages.
|
```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.InfrastructureAsCodeApi();
max_results = 1 # int | Number of jobs to show (optional) (default to 1)
include_errors = False # bool | Include error messages (optional) (default to False)
sort_by = ''dateSubmitted'' # str | Sort by (optional) (default to 'dateSubmitted')
sort_order = ''desc'' # str | Sort order (optional) (default to 'desc')
accelerator_id = 'accelerator_id_example' # str | Find only jobs associated with this accelerator (optional)
submitted_by = 'submitted_by_example' # str | Find only jobs submitted by this user (optional)
status = 'status_example' # str | Find only jobs in this state (optional)
try:
# Get job history
api_response = api_instance.get_infrastructureascode_jobs(max_results=max_results, include_errors=include_errors, sort_by=sort_by, sort_order=sort_order, accelerator_id=accelerator_id, submitted_by=submitted_by, status=status)
pprint(api_response)
except ApiException as e:
print("Exception when calling InfrastructureAsCodeApi->get_infrastructureascode_jobs: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/infrastructureascode/jobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a Job. Create and submit a job for remote execution or see job planning results.
|
```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.InfrastructureAsCodeApi();
body = PureCloudPlatformClientV2.AcceleratorInput() # AcceleratorInput |
try:
# Create a Job
api_response = api_instance.post_infrastructureascode_jobs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling InfrastructureAsCodeApi->post_infrastructureascode_jobs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/infrastructureascode/jobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get job status and results. Get the execution status of a submitted job, optionally including results and error details.
|
```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.InfrastructureAsCodeApi();
job_id = 'job_id_example' # str | Job ID
details = False # bool | Include details of execution, including job results or error information (optional) (default to False)
try:
# Get job status and results
api_response = api_instance.get_infrastructureascode_job(job_id, details=details)
pprint(api_response)
except ApiException as e:
print("Exception when calling InfrastructureAsCodeApi->get_infrastructureascode_job: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: List integrations
|
```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.IntegrationsApi();
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
sort_by = 'sort_by_example' # str | variable name requested to sort by (optional)
expand = ['expand_example'] # list[str] | variable name requested by expand list (optional)
next_page = 'next_page_example' # str | next page token (optional)
previous_page = 'previous_page_example' # str | Previous page token (optional)
try:
# List integrations
api_response = api_instance.get_integrations(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create an integration.
|
```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.IntegrationsApi();
body = PureCloudPlatformClientV2.CreateIntegrationRequest() # CreateIntegrationRequest | Integration (optional)
try:
# Create an integration.
api_response = api_instance.post_integrations(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieves all actions associated with filters passed in via query param.
|
```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.IntegrationsApi();
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
next_page = 'next_page_example' # str | next page token (optional)
previous_page = 'previous_page_example' # str | Previous page token (optional)
sort_by = 'sort_by_example' # str | Root level field name to sort on. (optional)
sort_order = ''asc'' # str | Direction to sort 'sortBy' field. (optional) (default to 'asc')
category = 'category_example' # str | Filter by category name. (optional)
name = 'name_example' # str | Filter by partial or complete action name. (optional)
ids = 'ids_example' # str | Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids. (optional)
secure = 'secure_example' # str | Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions. (optional)
include_auth_actions = ''false'' # str | Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (optional) (default to 'false')
try:
# Retrieves all actions associated with filters passed in via query param.
api_response = api_instance.get_integrations_actions(page_size=page_size, page_number=page_number, next_page=next_page, previous_page=previous_page, sort_by=sort_by, sort_order=sort_order, category=category, name=name, ids=ids, secure=secure, include_auth_actions=include_auth_actions)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_actions: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/actions Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.
|
```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.IntegrationsApi();
body = PureCloudPlatformClientV2.PostActionInput() # PostActionInput | Input used to create Action.
try:
# Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.
api_response = api_instance.post_integrations_actions(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_actions: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/categories Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieves all categories of available Actions
|
```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.IntegrationsApi();
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
next_page = 'next_page_example' # str | next page token (optional)
previous_page = 'previous_page_example' # str | Previous page token (optional)
sort_by = 'sort_by_example' # str | Root level field name to sort on. Only 'name' is supported on this endpoint. (optional)
sort_order = ''asc'' # str | Direction to sort 'sortBy' field. (optional) (default to 'asc')
secure = 'secure_example' # str | Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions. (optional)
try:
# Retrieves all categories of available Actions
api_response = api_instance.get_integrations_actions_categories(page_size=page_size, page_number=page_number, next_page=next_page, previous_page=previous_page, sort_by=sort_by, sort_order=sort_order, secure=secure)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_actions_categories: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/certificates Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in 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.IntegrationsApi();
status = 'status_example' # str | Indicates the validity of the certificate in question. (optional)
type = 'type_example' # str | Indicates the type of the certificate. (optional)
try:
# Retrieves the available mTLS client certificates in use. This endpoint will return inconsistent results while a certificate rotation is in progress.
api_response = api_instance.get_integrations_actions_certificates(status=status, type=type)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_actions_certificates: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/certificates/truststore Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieves basic info about trusted root CA certificates
|
```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.IntegrationsApi();
try:
# Retrieves basic info about trusted root CA certificates
api_response = api_instance.get_integrations_actions_certificates_truststore()
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_actions_certificates_truststore: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/drafts Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieves all action drafts associated with the filters passed in via query param.
|
```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.IntegrationsApi();
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
next_page = 'next_page_example' # str | next page token (optional)
previous_page = 'previous_page_example' # str | Previous page token (optional)
sort_by = 'sort_by_example' # str | Root level field name to sort on. (optional)
sort_order = ''asc'' # str | Direction to sort 'sortBy' field. (optional) (default to 'asc')
category = 'category_example' # str | Filter by category name. (optional)
name = 'name_example' # str | Filter by partial or complete action name. (optional)
ids = 'ids_example' # str | Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids. (optional)
secure = 'secure_example' # str | Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions. (optional)
include_auth_actions = ''false'' # str | Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (optional) (default to 'false')
try:
# Retrieves all action drafts associated with the filters passed in via query param.
api_response = api_instance.get_integrations_actions_drafts(page_size=page_size, page_number=page_number, next_page=next_page, previous_page=previous_page, sort_by=sort_by, sort_order=sort_order, category=category, name=name, ids=ids, secure=secure, include_auth_actions=include_auth_actions)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_actions_drafts: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/actions/drafts Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a new Draft
|
```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.IntegrationsApi();
body = PureCloudPlatformClientV2.PostActionInput() # PostActionInput | Input used to create Action Draft.
try:
# Create a new Draft
api_response = api_instance.post_integrations_actions_drafts(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_actions_drafts: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/integrations/actions/{actionId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete an Action
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
try:
# Delete an Action
api_instance.delete_integrations_action(action_id)
except ApiException as e:
print("Exception when calling IntegrationsApi->delete_integrations_action: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/{actionId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieves a single Action matching id.
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
expand = 'expand_example' # str | Indicates a field in the response which should be expanded. (optional)
include_config = False # bool | Return config in response. (optional) (default to False)
try:
# Retrieves a single Action matching id.
api_response = api_instance.get_integrations_action(action_id, expand=expand, include_config=include_config)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_action: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/integrations/actions/{actionId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Patch an Action
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
body = PureCloudPlatformClientV2.UpdateActionInput() # UpdateActionInput | Input used to patch the Action.
try:
# Patch an Action
api_response = api_instance.patch_integrations_action(action_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->patch_integrations_action: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/integrations/actions/{actionId}/draft Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a Draft
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
try:
# Delete a Draft
api_instance.delete_integrations_action_draft(action_id)
except ApiException as e:
print("Exception when calling IntegrationsApi->delete_integrations_action_draft: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/{actionId}/draft Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve a Draft
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
expand = 'expand_example' # str | Indicates a field in the response which should be expanded. (optional)
include_config = False # bool | Return config in response. (optional) (default to False)
try:
# Retrieve a Draft
api_response = api_instance.get_integrations_action_draft(action_id, expand=expand, include_config=include_config)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_action_draft: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/integrations/actions/{actionId}/draft Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update an existing Draft
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
body = PureCloudPlatformClientV2.UpdateDraftInput() # UpdateDraftInput | Input used to patch the Action Draft.
try:
# Update an existing Draft
api_response = api_instance.patch_integrations_action_draft(action_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->patch_integrations_action_draft: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/actions/{actionId}/draft Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a new Draft from existing Action
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
try:
# Create a new Draft from existing Action
api_response = api_instance.post_integrations_action_draft(action_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_action_draft: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/actions/{actionId}/draft/publish Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Publish a Draft and make it the active Action configuration
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
body = PureCloudPlatformClientV2.PublishDraftInput() # PublishDraftInput | Input used to patch the Action.
try:
# Publish a Draft and make it the active Action configuration
api_response = api_instance.post_integrations_action_draft_publish(action_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_action_draft_publish: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/{actionId}/draft/schemas/{fileName} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve schema for a Draft based on filename.
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
file_name = 'file_name_example' # str | Name of schema file to be retrieved for this draft.
try:
# Retrieve schema for a Draft based on filename.
api_response = api_instance.get_integrations_action_draft_schema(action_id, file_name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_action_draft_schema: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/{actionId}/draft/templates/{fileName} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve templates for a Draft based on filename.
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
file_name = 'file_name_example' # str | Name of template file to be retrieved for this action draft.
try:
# Retrieve templates for a Draft based on filename.
api_response = api_instance.get_integrations_action_draft_template(action_id, file_name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_action_draft_template: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/actions/{actionId}/draft/test Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
body = NULL # object | Map of parameters used for variable substitution.
try:
# Test the execution of a draft. Responses will show execution steps broken out with intermediate results to help in debugging.
api_response = api_instance.post_integrations_action_draft_test(action_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_action_draft_test: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/{actionId}/draft/validation Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Validate current Draft configuration.
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
try:
# Validate current Draft configuration.
api_response = api_instance.get_integrations_action_draft_validation(action_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_action_draft_validation: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/actions/{actionId}/execute Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
body = NULL # object | Map of parameters used for variable substitution.
try:
# Execute Action and return response from 3rd party. Responses will follow the schemas defined on the Action for success and error.
api_response = api_instance.post_integrations_action_execute(action_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_action_execute: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/{actionId}/schemas/{fileName} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve schema for an action based on filename.
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
file_name = 'file_name_example' # str | Name of schema file to be retrieved for this action.
try:
# Retrieve schema for an action based on filename.
api_response = api_instance.get_integrations_action_schema(action_id, file_name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_action_schema: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/actions/{actionId}/templates/{fileName} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve text of templates for an action based on filename.
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
file_name = 'file_name_example' # str | Name of template file to be retrieved for this action.
try:
# Retrieve text of templates for an action based on filename.
api_response = api_instance.get_integrations_action_template(action_id, file_name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_action_template: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/actions/{actionId}/test Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
|
```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.IntegrationsApi();
action_id = 'action_id_example' # str | actionId
body = NULL # object | Map of parameters used for variable substitution.
try:
# Test the execution of an action. Responses will show execution steps broken out with intermediate results to help in debugging.
api_response = api_instance.post_integrations_action_test(action_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_action_test: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/botconnector/{integrationId}/bots Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of botConnector bots for this integration
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | The integration ID for this group of bots
try:
# Get a list of botConnector bots for this integration
api_response = api_instance.get_integrations_botconnector_integration_id_bots(integration_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_botconnector_integration_id_bots: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/integrations/botconnector/{integrationId}/bots Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Set a list of botConnector bots plus versions for this integration
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | The integration ID for this group of bots
bot_list = PureCloudPlatformClientV2.BotList() # BotList |
try:
# Set a list of botConnector bots plus versions for this integration
api_instance.put_integrations_botconnector_integration_id_bots(integration_id, bot_list)
except ApiException as e:
print("Exception when calling IntegrationsApi->put_integrations_botconnector_integration_id_bots: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/botconnector/{integrationId}/bots/summaries Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a summary list of botConnector bots for this integration
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | The integration ID for this group of bots
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get a summary list of botConnector bots for this integration
api_response = api_instance.get_integrations_botconnector_integration_id_bots_summaries(integration_id, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_botconnector_integration_id_bots_summaries: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/botconnector/{integrationId}/bots/{botId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a specific botConnector bot, plus versions, for this integration
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | The integration ID for this group of bots
bot_id = 'bot_id_example' # str | The botID for this bot
version = 'version_example' # str | Specific Version (optional)
try:
# Get a specific botConnector bot, plus versions, for this integration
api_response = api_instance.get_integrations_botconnector_integration_id_bot(integration_id, bot_id, version=version)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_botconnector_integration_id_bot: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/botconnector/{integrationId}/bots/{botId}/versions Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of bot versions for a bot
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | The integration ID for this bot group
bot_id = 'bot_id_example' # str | The botID for this bot
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get a list of bot versions for a bot
api_response = api_instance.get_integrations_botconnector_integration_id_bot_versions(integration_id, bot_id, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_botconnector_integration_id_bot_versions: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/clientapps Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: List permitted client app integrations for the logged in user
|
```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.IntegrationsApi();
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
sort_by = 'sort_by_example' # str | variable name requested to sort by (optional)
expand = ['expand_example'] # list[str] | variable name requested by expand list (optional)
next_page = 'next_page_example' # str | next page token (optional)
previous_page = 'previous_page_example' # str | Previous page token (optional)
try:
# List permitted client app integrations for the logged in user
api_response = api_instance.get_integrations_clientapps(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_clientapps: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/credentials Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: List multiple sets of credentials
|
```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.IntegrationsApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# List multiple sets of credentials
api_response = api_instance.get_integrations_credentials(page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_credentials: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/credentials Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a set of credentials
|
```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.IntegrationsApi();
body = PureCloudPlatformClientV2.Credential() # Credential | Credential (optional)
try:
# Create a set of credentials
api_response = api_instance.post_integrations_credentials(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_credentials: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/credentials/types Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: List all credential types
|
```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.IntegrationsApi();
try:
# List all credential types
api_response = api_instance.get_integrations_credentials_types()
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_credentials_types: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/integrations/credentials/{credentialId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a set of credentials
|
```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.IntegrationsApi();
credential_id = 'credential_id_example' # str | Credential ID
try:
# Delete a set of credentials
api_instance.delete_integrations_credential(credential_id)
except ApiException as e:
print("Exception when calling IntegrationsApi->delete_integrations_credential: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/credentials/{credentialId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a single credential with sensitive fields redacted
|
```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.IntegrationsApi();
credential_id = 'credential_id_example' # str | Credential ID
try:
# Get a single credential with sensitive fields redacted
api_response = api_instance.get_integrations_credential(credential_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_credential: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/integrations/credentials/{credentialId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a set of credentials
|
```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.IntegrationsApi();
credential_id = 'credential_id_example' # str | Credential ID
body = PureCloudPlatformClientV2.Credential() # Credential | Credential (optional)
try:
# Update a set of credentials
api_response = api_instance.put_integrations_credential(credential_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->put_integrations_credential: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/audioconnector Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of Audio Connector integrations
|
```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.IntegrationsApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get a list of Audio Connector integrations
api_response = api_instance.get_integrations_speech_audioconnector(page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_audioconnector: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/audioconnector/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get an Audio Connector integration
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | The integration ID
try:
# Get an Audio Connector integration
api_response = api_instance.get_integrations_speech_audioconnector_integration_id(integration_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_audioconnector_integration_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/dialogflow/agents Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of Dialogflow agents in the customers' Google accounts
|
```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.IntegrationsApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
name = 'name_example' # str | Filter on agent name (optional)
try:
# Get a list of Dialogflow agents in the customers' Google accounts
api_response = api_instance.get_integrations_speech_dialogflow_agents(page_number=page_number, page_size=page_size, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_dialogflow_agents: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/dialogflow/agents/{agentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get details about a Dialogflow agent
|
```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.IntegrationsApi();
agent_id = 'agent_id_example' # str | The agent ID
try:
# Get details about a Dialogflow agent
api_response = api_instance.get_integrations_speech_dialogflow_agent(agent_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_dialogflow_agent: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/dialogflowcx/agents Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of Dialogflow CX agents in the customers' Google accounts
|
```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.IntegrationsApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
name = 'name_example' # str | Filter on agent name (optional)
try:
# Get a list of Dialogflow CX agents in the customers' Google accounts
api_response = api_instance.get_integrations_speech_dialogflowcx_agents(page_number=page_number, page_size=page_size, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_dialogflowcx_agents: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/dialogflowcx/agents/{agentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get details about a Dialogflow CX agent
|
```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.IntegrationsApi();
agent_id = 'agent_id_example' # str | The agent ID
try:
# Get details about a Dialogflow CX agent
api_response = api_instance.get_integrations_speech_dialogflowcx_agent(agent_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_dialogflowcx_agent: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/lex/bot/alias/{aliasId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get details about a Lex bot alias
|
```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.IntegrationsApi();
alias_id = 'alias_id_example' # str | The alias ID
try:
# Get details about a Lex bot alias
api_response = api_instance.get_integrations_speech_lex_bot_alias(alias_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_lex_bot_alias: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/lex/bot/{botId}/aliases Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of aliases for a bot in the customer's AWS accounts
|
```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.IntegrationsApi();
bot_id = 'bot_id_example' # str | The bot ID
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
status = 'status_example' # str | Filter on alias status (optional)
name = 'name_example' # str | Filter on alias name (optional)
try:
# Get a list of aliases for a bot in the customer's AWS accounts
api_response = api_instance.get_integrations_speech_lex_bot_bot_id_aliases(bot_id, page_number=page_number, page_size=page_size, status=status, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_lex_bot_bot_id_aliases: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/lex/bots Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of Lex bots in the customers' AWS accounts
|
```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.IntegrationsApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
name = 'name_example' # str | Filter on bot name (optional)
try:
# Get a list of Lex bots in the customers' AWS accounts
api_response = api_instance.get_integrations_speech_lex_bots(page_number=page_number, page_size=page_size, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_lex_bots: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/lexv2/bot/alias/{aliasId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get details about a Lex V2 bot alias
|
```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.IntegrationsApi();
alias_id = 'alias_id_example' # str | The Alias ID
try:
# Get details about a Lex V2 bot alias
api_response = api_instance.get_integrations_speech_lexv2_bot_alias(alias_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_lexv2_bot_alias: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/lexv2/bot/{botId}/aliases Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of aliases for a Lex V2 bot
|
```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.IntegrationsApi();
bot_id = 'bot_id_example' # str | The Bot ID
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
status = 'status_example' # str | Filter on alias status (optional)
name = 'name_example' # str | Filter on alias name (optional)
try:
# Get a list of aliases for a Lex V2 bot
api_response = api_instance.get_integrations_speech_lexv2_bot_bot_id_aliases(bot_id, page_number=page_number, page_size=page_size, status=status, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_lexv2_bot_bot_id_aliases: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/lexv2/bots Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of Lex V2 bots
|
```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.IntegrationsApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
name = 'name_example' # str | Filter on bot name (optional)
try:
# Get a list of Lex V2 bots
api_response = api_instance.get_integrations_speech_lexv2_bots(page_number=page_number, page_size=page_size, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_lexv2_bots: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of Nuance bots available in the specified Integration. If the 'onlyRegisteredBots' param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integration's configured discovery credentials are returned.
|
```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.IntegrationsApi();
nuance_integration_id = 'nuance_integration_id_example' # str | The integration ID for this group of bots
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
only_registered_bots = True # bool | Limit bots to the ones configured for Genesys Cloud usage (optional) (default to True)
try:
# Get a list of Nuance bots available in the specified Integration
api_response = api_instance.get_integrations_speech_nuance_nuance_integration_id_bots(nuance_integration_id, page_number=page_number, page_size=page_size, only_registered_bots=only_registered_bots)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_nuance_nuance_integration_id_bots: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of Nuance bots in the specified Integration asynchronously
|
```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.IntegrationsApi();
nuance_integration_id = 'nuance_integration_id_example' # str | The integration ID for this group of bots
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
only_registered_bots = True # bool | Limit bots to the ones configured for Genesys Cloud usage (optional) (default to True)
try:
# Get a list of Nuance bots in the specified Integration asynchronously
api_response = api_instance.post_integrations_speech_nuance_nuance_integration_id_bots_jobs(nuance_integration_id, page_number=page_number, page_size=page_size, only_registered_bots=only_registered_bots)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_speech_nuance_nuance_integration_id_bots_jobs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the status of an asynchronous Nuance bots GET 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.IntegrationsApi();
nuance_integration_id = 'nuance_integration_id_example' # str | The integration ID for this group of bots
job_id = 'job_id_example' # str | The asynchronous job ID
try:
# Get the status of an asynchronous Nuance bots GET job
api_response = api_instance.get_integrations_speech_nuance_nuance_integration_id_bots_job(nuance_integration_id, job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_nuance_nuance_integration_id_bots_job: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}/results Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the result of an asynchronous Nuance bots GET 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.IntegrationsApi();
nuance_integration_id = 'nuance_integration_id_example' # str | The integration ID for this group of bots
job_id = 'job_id_example' # str | The asynchronous job ID
try:
# Get the result of an asynchronous Nuance bots GET job
api_response = api_instance.get_integrations_speech_nuance_nuance_integration_id_bots_job_results(nuance_integration_id, job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_nuance_nuance_integration_id_bots_job_results: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration
|
```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.IntegrationsApi();
nuance_integration_id = 'nuance_integration_id_example' # str | The integration ID for this group of bots
settings = PureCloudPlatformClientV2.NuanceBotLaunchSettings() # NuanceBotLaunchSettings |
try:
# Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration
api_instance.put_integrations_speech_nuance_nuance_integration_id_bots_launch_settings(nuance_integration_id, settings)
except ApiException as e:
print("Exception when calling IntegrationsApi->put_integrations_speech_nuance_nuance_integration_id_bots_launch_settings: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/validate Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Try out a single credential for a Nuance bot to know if the secret is correct
|
```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.IntegrationsApi();
nuance_integration_id = 'nuance_integration_id_example' # str | The integration ID for this group of bots
settings = PureCloudPlatformClientV2.BotExecutionConfiguration() # BotExecutionConfiguration |
try:
# Try out a single credential for a Nuance bot to know if the secret is correct
api_instance.post_integrations_speech_nuance_nuance_integration_id_bots_launch_validate(nuance_integration_id, settings)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_speech_nuance_nuance_integration_id_bots_launch_validate: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Nuance bot in the specified Integration
|
```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.IntegrationsApi();
nuance_integration_id = 'nuance_integration_id_example' # str | The integration ID for this group of bots
bot_id = 'bot_id_example' # str | The Nuance bot ID to get
expand = ['expand_example'] # list[str] | expand (optional)
target_channel = 'target_channel_example' # str | targetChannel (optional)
try:
# Get a Nuance bot in the specified Integration
api_response = api_instance.get_integrations_speech_nuance_nuance_integration_id_bot(nuance_integration_id, bot_id, expand=expand, target_channel=target_channel)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_nuance_nuance_integration_id_bot: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Nuance bot in the specified Integration asynchronously
|
```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.IntegrationsApi();
nuance_integration_id = 'nuance_integration_id_example' # str | The integration ID for this group of bots
bot_id = 'bot_id_example' # str | The Nuance bot ID
expand = ['expand_example'] # list[str] | expand (optional)
body = 'body_example' # str | targetChannel (optional)
try:
# Get a Nuance bot in the specified Integration asynchronously
api_response = api_instance.post_integrations_speech_nuance_nuance_integration_id_bot_jobs(nuance_integration_id, bot_id, expand=expand, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->post_integrations_speech_nuance_nuance_integration_id_bot_jobs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the status of an asynchronous Nuance bot GET 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.IntegrationsApi();
nuance_integration_id = 'nuance_integration_id_example' # str | The integration ID for this group of bots
bot_id = 'bot_id_example' # str | The Nuance bot ID
job_id = 'job_id_example' # str | The asynchronous job ID
try:
# Get the status of an asynchronous Nuance bot GET job
api_response = api_instance.get_integrations_speech_nuance_nuance_integration_id_bot_job(nuance_integration_id, bot_id, job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_nuance_nuance_integration_id_bot_job: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}/results Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the result of an asynchronous Nuance bot GET 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.IntegrationsApi();
nuance_integration_id = 'nuance_integration_id_example' # str | The integration ID for this group of bots
bot_id = 'bot_id_example' # str | The Nuance bot ID
job_id = 'job_id_example' # str | The asynchronous job ID
try:
# Get the result of an asynchronous Nuance bot GET job
api_response = api_instance.get_integrations_speech_nuance_nuance_integration_id_bot_job_results(nuance_integration_id, bot_id, job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_nuance_nuance_integration_id_bot_job_results: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/stt/engines Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of STT engines enabled for org
|
```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.IntegrationsApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
name = 'name_example' # str | Filter on engine name (optional)
try:
# Get a list of STT engines enabled for org
api_response = api_instance.get_integrations_speech_stt_engines(page_number=page_number, page_size=page_size, name=name)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_stt_engines: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/stt/engines/{engineId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get details about a STT engine
|
```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.IntegrationsApi();
engine_id = 'engine_id_example' # str | The engine ID
try:
# Get details about a STT engine
api_response = api_instance.get_integrations_speech_stt_engine(engine_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_stt_engine: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/tts/engines Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of TTS engines enabled for org
|
```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.IntegrationsApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
include_voices = False # bool | Include voices for the engine (optional) (default to False)
name = 'name_example' # str | Filter on engine name (optional)
language = 'language_example' # str | Filter on supported language. If includeVoices=true then the voices are also filtered. (optional)
try:
# Get a list of TTS engines enabled for org
api_response = api_instance.get_integrations_speech_tts_engines(page_number=page_number, page_size=page_size, include_voices=include_voices, name=name, language=language)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_tts_engines: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/tts/engines/{engineId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get details about a TTS engine
|
```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.IntegrationsApi();
engine_id = 'engine_id_example' # str | The engine ID
include_voices = False # bool | Include voices for the engine (optional) (default to False)
try:
# Get details about a TTS engine
api_response = api_instance.get_integrations_speech_tts_engine(engine_id, include_voices=include_voices)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_tts_engine: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/tts/engines/{engineId}/voices Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of voices for a TTS engine
|
```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.IntegrationsApi();
engine_id = 'engine_id_example' # str | The engine ID
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get a list of voices for a TTS engine
api_response = api_instance.get_integrations_speech_tts_engine_voices(engine_id, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_tts_engine_voices: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/tts/engines/{engineId}/voices/{voiceId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get details about a specific voice for a TTS engine
|
```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.IntegrationsApi();
engine_id = 'engine_id_example' # str | The engine ID
voice_id = 'voice_id_example' # str | The voice ID
try:
# Get details about a specific voice for a TTS engine
api_response = api_instance.get_integrations_speech_tts_engine_voice(engine_id, voice_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_tts_engine_voice: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/speech/tts/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get TTS settings for an org
|
```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.IntegrationsApi();
try:
# Get TTS settings for an org
api_response = api_instance.get_integrations_speech_tts_settings()
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_speech_tts_settings: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/integrations/speech/tts/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update TTS settings for an org
|
```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.IntegrationsApi();
body = PureCloudPlatformClientV2.TtsSettings() # TtsSettings | Updated TtsSettings
try:
# Update TTS settings for an org
api_response = api_instance.put_integrations_speech_tts_settings(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->put_integrations_speech_tts_settings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/types Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: List integration types
|
```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.IntegrationsApi();
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
sort_by = 'sort_by_example' # str | variable name requested to sort by (optional)
expand = ['expand_example'] # list[str] | variable name requested by expand list (optional)
next_page = 'next_page_example' # str | next page token (optional)
previous_page = 'previous_page_example' # str | Previous page token (optional)
try:
# List integration types
api_response = api_instance.get_integrations_types(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_types: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/types/{typeId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get integration type.
|
```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.IntegrationsApi();
type_id = 'type_id_example' # str | Integration Type Id
try:
# Get integration type.
api_response = api_instance.get_integrations_type(type_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_type: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/types/{typeId}/configschemas/{configType} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get properties config schema for an integration type.
|
```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.IntegrationsApi();
type_id = 'type_id_example' # str | Integration Type Id
config_type = 'config_type_example' # str | Config schema type
try:
# Get properties config schema for an integration type.
api_response = api_instance.get_integrations_type_configschema(type_id, config_type)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_type_configschema: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/unifiedcommunications/clientapps Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: List UC integration client application configurations. This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled.
|
```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.IntegrationsApi();
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
sort_by = 'sort_by_example' # str | variable name requested to sort by (optional)
expand = ['expand_example'] # list[str] | variable name requested by expand list (optional)
next_page = 'next_page_example' # str | next page token (optional)
previous_page = 'previous_page_example' # str | Previous page token (optional)
try:
# List UC integration client application configurations.
api_response = api_instance.get_integrations_unifiedcommunications_clientapps(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_unifiedcommunications_clientapps: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/unifiedcommunications/clientapps/{ucIntegrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: UC integration client application configuration. This endpoint returns basic UI configuration data for the specified Unified Communications integration client application.
|
```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.IntegrationsApi();
uc_integration_id = 'uc_integration_id_example' # str | 3rd Party Service Type
try:
# UC integration client application configuration.
api_response = api_instance.get_integrations_unifiedcommunications_clientapp(uc_integration_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_unifiedcommunications_clientapp: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk integration presence ingestion. This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.
|
```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.IntegrationsApi();
uc_integration_id = 'uc_integration_id_example' # str | UC Integration ID
body = [PureCloudPlatformClientV2.UCThirdPartyPresence()] # list[UCThirdPartyPresence] | List of User presences
try:
# Bulk integration presence ingestion
api_response = api_instance.put_integrations_unifiedcommunication_thirdpartypresences(uc_integration_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->put_integrations_unifiedcommunication_thirdpartypresences: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/userapps Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: List permitted user app integrations for the logged in user
|
```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.IntegrationsApi();
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
sort_by = 'sort_by_example' # str | variable name requested to sort by (optional)
expand = ['expand_example'] # list[str] | variable name requested by expand list (optional)
next_page = 'next_page_example' # str | next page token (optional)
previous_page = 'previous_page_example' # str | Previous page token (optional)
app_host = 'app_host_example' # str | The type of UserApp to filter by (optional)
try:
# List permitted user app integrations for the logged in user
api_response = api_instance.get_integrations_userapps(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, app_host=app_host)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integrations_userapps: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/integrations/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete integration.
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | Integration Id
try:
# Delete integration.
api_response = api_instance.delete_integration(integration_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->delete_integration: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get integration.
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | Integration Id
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
sort_by = 'sort_by_example' # str | variable name requested to sort by (optional)
expand = ['expand_example'] # list[str] | variable name requested by expand list (optional)
next_page = 'next_page_example' # str | next page token (optional)
previous_page = 'previous_page_example' # str | Previous page token (optional)
try:
# Get integration.
api_response = api_instance.get_integration(integration_id, page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integration: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/integrations/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update an integration.
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | Integration Id
page_size = 25 # int | The total page size requested (optional) (default to 25)
page_number = 1 # int | The page number requested (optional) (default to 1)
sort_by = 'sort_by_example' # str | variable name requested to sort by (optional)
expand = ['expand_example'] # list[str] | variable name requested by expand list (optional)
next_page = 'next_page_example' # str | next page token (optional)
previous_page = 'previous_page_example' # str | Previous page token (optional)
body = PureCloudPlatformClientV2.Integration() # Integration | Integration Update (optional)
try:
# Update an integration.
api_response = api_instance.patch_integration(integration_id, page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->patch_integration: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/integrations/{integrationId}/config/current Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get integration configuration.
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | Integration Id
try:
# Get integration configuration.
api_response = api_instance.get_integration_config_current(integration_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->get_integration_config_current: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/integrations/{integrationId}/config/current Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update integration configuration.
|
```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.IntegrationsApi();
integration_id = 'integration_id_example' # str | Integration Id
body = PureCloudPlatformClientV2.IntegrationConfiguration() # IntegrationConfiguration | Integration Configuration (optional)
try:
# Update integration configuration.
api_response = api_instance.put_integration_config_current(integration_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling IntegrationsApi->put_integration_config_current: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/analytics/journeys/aggregates/query Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query for journey aggregates
|
```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.JourneyApi();
body = PureCloudPlatformClientV2.JourneyAggregationQuery() # JourneyAggregationQuery | query
try:
# Query for journey aggregates
api_response = api_instance.post_analytics_journeys_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->post_analytics_journeys_aggregates_query: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/externalcontacts/contacts/{contactId}/journey/sessions Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve all sessions for a given external 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.JourneyApi();
contact_id = 'contact_id_example' # str | ExternalContact ID
page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)
after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)
include_merged = True # bool | Indicates whether to return sessions from all external contacts in the merge-set of the given one. (optional)
try:
# Retrieve all sessions for a given external contact.
api_response = api_instance.get_externalcontacts_contact_journey_sessions(contact_id, page_size=page_size, after=after, include_merged=include_merged)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->get_externalcontacts_contact_journey_sessions: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/journey/actionmaps Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve all action maps.
|
```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.JourneyApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
sort_by = 'sort_by_example' # str | Field(s) to sort by. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). (optional)
filter_field = 'filter_field_example' # str | Field to filter by (e.g. filterField=weight or filterField=action.actionTemplate.id). Requires 'filterField' to also be set. (optional)
filter_value = 'filter_value_example' # str | Value to filter by. Requires 'filterValue' to also be set. (optional)
action_map_ids = ['action_map_ids_example'] # list[str] | IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request. (optional)
query_fields = ['query_fields_example'] # list[str] | Action Map field(s) to query on. Requires 'queryValue' to also be set. (optional)
query_value = 'query_value_example' # str | Value to query on. Requires 'queryFields' to also be set. (optional)
try:
# Retrieve all action maps.
api_response = api_instance.get_journey_actionmaps(page_number=page_number, page_size=page_size, sort_by=sort_by, filter_field=filter_field, filter_value=filter_value, action_map_ids=action_map_ids, query_fields=query_fields, query_value=query_value)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->get_journey_actionmaps: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/journey/actionmaps Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create an action map.
|
```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.JourneyApi();
body = PureCloudPlatformClientV2.ActionMap() # ActionMap | (optional)
try:
# Create an action map.
api_response = api_instance.post_journey_actionmaps(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->post_journey_actionmaps: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/journey/actionmaps/estimates/jobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query for estimates
|
```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.JourneyApi();
body = PureCloudPlatformClientV2.ActionMapEstimateRequest() # ActionMapEstimateRequest | audience estimator request
try:
# Query for estimates
api_response = api_instance.post_journey_actionmaps_estimates_jobs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->post_journey_actionmaps_estimates_jobs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/journey/actionmaps/estimates/jobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get status of 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.JourneyApi();
job_id = 'job_id_example' # str | ID of the job.
try:
# Get status of job.
api_response = api_instance.get_journey_actionmaps_estimates_job(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->get_journey_actionmaps_estimates_job: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/journey/actionmaps/estimates/jobs/{jobId}/results Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get estimates from completed 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.JourneyApi();
job_id = 'job_id_example' # str | ID of the job.
try:
# Get estimates from completed job.
api_response = api_instance.get_journey_actionmaps_estimates_job_results(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->get_journey_actionmaps_estimates_job_results: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/journey/actionmaps/{actionMapId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete single action map.
|
```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.JourneyApi();
action_map_id = 'action_map_id_example' # str | ID of the action map.
try:
# Delete single action map.
api_instance.delete_journey_actionmap(action_map_id)
except ApiException as e:
print("Exception when calling JourneyApi->delete_journey_actionmap: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/journey/actionmaps/{actionMapId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve a single action map.
|
```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.JourneyApi();
action_map_id = 'action_map_id_example' # str | ID of the action map.
try:
# Retrieve a single action map.
api_response = api_instance.get_journey_actionmap(action_map_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->get_journey_actionmap: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/journey/actionmaps/{actionMapId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update single action map.
|
```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.JourneyApi();
action_map_id = 'action_map_id_example' # str | ID of the action map.
body = PureCloudPlatformClientV2.PatchActionMap() # PatchActionMap | (optional)
try:
# Update single action map.
api_response = api_instance.patch_journey_actionmap(action_map_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->patch_journey_actionmap: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/journey/actiontargets Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve all action targets.
|
```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.JourneyApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Retrieve all action targets.
api_response = api_instance.get_journey_actiontargets(page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling JourneyApi->get_journey_actiontargets: %s\n" % e)```
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.