instruction,input,output Provide a Python example that uses the GET /api/v2/assistants Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all assistants.,"```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.AgentAssistantsApi(); before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) limit = 'limit_example' # str | Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) name = 'name_example' # str | Return the assistant by the given name. (optional) try: # Get all assistants. api_response = api_instance.get_assistants(before=before, after=after, limit=limit, page_size=page_size, name=name) pprint(api_response) except ApiException as e: print(""Exception when calling AgentAssistantsApi->get_assistants: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/assistants Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an Assistant.,"```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.AgentAssistantsApi(); body = PureCloudPlatformClientV2.Assistant() # Assistant | try: # Create an Assistant. api_response = api_instance.post_assistants(body) pprint(api_response) except ApiException as e: print(""Exception when calling AgentAssistantsApi->post_assistants: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/assistants/queues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all queues assigned to any assistant.,"```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.AgentAssistantsApi(); before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) queue_ids = 'queue_ids_example' # str | Comma-separated identifiers of the queues that need to be retrieved. (optional) expand = 'expand_example' # str | Which fields, if any, to expand. (optional) try: # Get all queues assigned to any assistant. api_response = api_instance.get_assistants_queues(before=before, after=after, page_size=page_size, queue_ids=queue_ids, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling AgentAssistantsApi->get_assistants_queues: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/assistants/{assistantId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an assistant.,"```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.AgentAssistantsApi(); assistant_id = 'assistant_id_example' # str | Assistant ID try: # Delete an assistant. api_instance.delete_assistant(assistant_id) except ApiException as e: print(""Exception when calling AgentAssistantsApi->delete_assistant: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/assistants/{assistantId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an assistant.,"```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.AgentAssistantsApi(); assistant_id = 'assistant_id_example' # str | Assistant ID expand = 'expand_example' # str | Which fields, if any, to expand. (optional) try: # Get an assistant. api_response = api_instance.get_assistant(assistant_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling AgentAssistantsApi->get_assistant: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/assistants/{assistantId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an assistant.,"```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.AgentAssistantsApi(); assistant_id = 'assistant_id_example' # str | Assistant ID body = PureCloudPlatformClientV2.Assistant() # Assistant | try: # Update an assistant. api_response = api_instance.patch_assistant(assistant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling AgentAssistantsApi->patch_assistant: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/assistants/{assistantId}/queues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Disassociate the queues from an assistant for the given assistant ID and queue IDs.,"```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.AgentAssistantsApi(); assistant_id = 'assistant_id_example' # str | Assistant ID queue_ids = 'queue_ids_example' # str | Comma-separated identifiers of the queues that need to be deleted. (optional) try: # Disassociate the queues from an assistant for the given assistant ID and queue IDs. api_instance.delete_assistant_queues(assistant_id, queue_ids=queue_ids) except ApiException as e: print(""Exception when calling AgentAssistantsApi->delete_assistant_queues: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/assistants/{assistantId}/queues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all the queues associated with an assistant.,"```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.AgentAssistantsApi(); assistant_id = 'assistant_id_example' # str | Assistant ID before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) expand = 'expand_example' # str | Which fields, if any, to expand. (optional) try: # Get all the queues associated with an assistant. api_response = api_instance.get_assistant_queues(assistant_id, before=before, after=after, page_size=page_size, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling AgentAssistantsApi->get_assistant_queues: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/assistants/{assistantId}/queues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Queues for an Assistant.,"```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.AgentAssistantsApi(); assistant_id = 'assistant_id_example' # str | Assistant ID body = [PureCloudPlatformClientV2.AssistantQueue()] # list[AssistantQueue] | try: # Update Queues for an Assistant. api_response = api_instance.patch_assistant_queues(assistant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling AgentAssistantsApi->patch_assistant_queues: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/assistants/{assistantId}/queues/{queueId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Disassociate a queue from an assistant.,"```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.AgentAssistantsApi(); assistant_id = 'assistant_id_example' # str | Assistant ID queue_id = 'queue_id_example' # str | Queue ID try: # Disassociate a queue from an assistant. api_instance.delete_assistant_queue(assistant_id, queue_id) except ApiException as e: print(""Exception when calling AgentAssistantsApi->delete_assistant_queue: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/assistants/{assistantId}/queues/{queueId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get queue Information for an assistant.,"```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.AgentAssistantsApi(); assistant_id = 'assistant_id_example' # str | Assistant ID queue_id = 'queue_id_example' # str | Queue ID expand = 'expand_example' # str | Which fields, if any, to expand. (optional) try: # Get queue Information for an assistant. api_response = api_instance.get_assistant_queue(assistant_id, queue_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling AgentAssistantsApi->get_assistant_queue: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/assistants/{assistantId}/queues/{queueId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a queue assistant association.,"```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.AgentAssistantsApi(); assistant_id = 'assistant_id_example' # str | Assistant ID queue_id = 'queue_id_example' # str | Queue ID body = PureCloudPlatformClientV2.AssistantQueue() # AssistantQueue | try: # Create a queue assistant association. api_response = api_instance.put_assistant_queue(assistant_id, queue_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling AgentAssistantsApi->put_assistant_queue: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/assistants/{assistantId}/copilot Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get copilot configuration of an assistant.,"```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.AgentCopilotApi(); assistant_id = 'assistant_id_example' # str | Assistant ID try: # Get copilot configuration of an assistant. api_response = api_instance.get_assistant_copilot(assistant_id) pprint(api_response) except ApiException as e: print(""Exception when calling AgentCopilotApi->get_assistant_copilot: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/assistants/{assistantId}/copilot Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update agent copilot 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.AgentCopilotApi(); assistant_id = 'assistant_id_example' # str | Assistant ID body = PureCloudPlatformClientV2.Copilot() # Copilot | try: # Update agent copilot configuration api_response = api_instance.put_assistant_copilot(assistant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling AgentCopilotApi->put_assistant_copilot: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete agent auto answer settings,"```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.SettingsApi(); agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to try: # Delete agent auto answer settings api_instance.delete_users_agentui_agents_autoanswer_agent_id_settings(agent_id) except ApiException as e: print(""Exception when calling SettingsApi->delete_users_agentui_agents_autoanswer_agent_id_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get agent auto answer settings,"```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.SettingsApi(); agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to try: # Get agent auto answer settings api_response = api_instance.get_users_agentui_agents_autoanswer_agent_id_settings(agent_id) pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->get_users_agentui_agents_autoanswer_agent_id_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update agent auto answer settings,"```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.SettingsApi(); agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to body = PureCloudPlatformClientV2.AutoAnswerSettings() # AutoAnswerSettings | AutoAnswerSettings try: # Update agent auto answer settings api_response = api_instance.patch_users_agentui_agents_autoanswer_agent_id_settings(agent_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->patch_users_agentui_agents_autoanswer_agent_id_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set agent auto answer settings,"```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.SettingsApi(); agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to body = PureCloudPlatformClientV2.AutoAnswerSettings() # AutoAnswerSettings | AutoAnswerSettings try: # Set agent auto answer settings api_response = api_instance.put_users_agentui_agents_autoanswer_agent_id_settings(agent_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->put_users_agentui_agents_autoanswer_agent_id_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/alerting/alerts/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk alert updates,"```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.AlertingApi(); body = PureCloudPlatformClientV2.CommonAlertBulkUpdateRequest() # CommonAlertBulkUpdateRequest | try: # Bulk alert updates api_response = api_instance.patch_alerting_alerts_bulk(body) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->patch_alerting_alerts_bulk: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/alerting/alerts/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a paged list of alerts. The max page size is 50,"```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.AlertingApi(); body = PureCloudPlatformClientV2.GetAlertQuery() # GetAlertQuery | (optional) try: # Gets a paged list of alerts. The max page size is 50 api_response = api_instance.post_alerting_alerts_query(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->post_alerting_alerts_query: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/alerting/alerts/{alertId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an alert,"```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.AlertingApi(); alert_id = 'alert_id_example' # str | Alert ID try: # Delete an alert api_instance.delete_alerting_alert(alert_id) except ApiException as e: print(""Exception when calling AlertingApi->delete_alerting_alert: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/alerting/alerts/{alertId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an alert,"```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.AlertingApi(); alert_id = 'alert_id_example' # str | Alert ID try: # Get an alert api_response = api_instance.get_alerting_alert(alert_id) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->get_alerting_alert: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/alerting/alerts/{alertId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Allows an entity to mute/snooze an alert or update the unread status of the alert. Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period. Muting an alert will only block the notifications to individuals.,"```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.AlertingApi(); alert_id = 'alert_id_example' # str | Alert ID body = PureCloudPlatformClientV2.AlertRequest() # AlertRequest | (optional) try: # Allows an entity to mute/snooze an alert or update the unread status of the alert. api_response = api_instance.patch_alerting_alert(alert_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->patch_alerting_alert: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/alerting/alerts/{alertId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an alert read status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.AlertingApi(); alert_id = 'alert_id_example' # str | Alert ID body = PureCloudPlatformClientV2.AlertingUnreadStatus() # AlertingUnreadStatus | (optional) try: # Update an alert read status api_response = api_instance.put_alerting_alert(alert_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->put_alerting_alert: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/alerting/rules Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Rule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.AlertingApi(); body = PureCloudPlatformClientV2.CommonRule() # CommonRule | rule to be created try: # Create a Rule. api_response = api_instance.post_alerting_rules(body) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->post_alerting_rules: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/alerting/rules/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk update of notification lists,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.AlertingApi(); body = PureCloudPlatformClientV2.CommonRuleBulkUpdateNotificationsRequest() # CommonRuleBulkUpdateNotificationsRequest | try: # Bulk update of notification lists api_response = api_instance.patch_alerting_rules_bulk(body) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->patch_alerting_rules_bulk: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/alerting/rules/bulk/remove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk remove rules,"```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.AlertingApi(); body = PureCloudPlatformClientV2.CommonRuleBulkDeleteRequest() # CommonRuleBulkDeleteRequest | try: # Bulk remove rules api_response = api_instance.post_alerting_rules_bulk_remove(body) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->post_alerting_rules_bulk_remove: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/alerting/rules/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a paged list of rules. The max size of the page is 50 items.,"```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.AlertingApi(); body = PureCloudPlatformClientV2.GetRulesQuery() # GetRulesQuery | (optional) try: # Get a paged list of rules. The max size of the page is 50 items. api_response = api_instance.post_alerting_rules_query(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->post_alerting_rules_query: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/alerting/rules/{ruleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a rule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.AlertingApi(); rule_id = 'rule_id_example' # str | Rule Id try: # Delete a rule. api_instance.delete_alerting_rule(rule_id) except ApiException as e: print(""Exception when calling AlertingApi->delete_alerting_rule: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/alerting/rules/{ruleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a rule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.AlertingApi(); rule_id = 'rule_id_example' # str | Rule Id try: # Get a rule. api_response = api_instance.get_alerting_rule(rule_id) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->get_alerting_rule: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/alerting/rules/{ruleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a rule,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.AlertingApi(); rule_id = 'rule_id_example' # str | Rule Id body = PureCloudPlatformClientV2.ModifiableRuleProperties() # ModifiableRuleProperties | rule to be updated try: # Update a rule api_response = api_instance.put_alerting_rule(rule_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling AlertingApi->put_alerting_rule: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/actions/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for action 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.AnalyticsApi(); body = PureCloudPlatformClientV2.ActionAggregationQuery() # ActionAggregationQuery | query try: # Query for action aggregates api_response = api_instance.post_analytics_actions_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_actions_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/agentcopilots/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for agent copilot 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.AnalyticsApi(); body = PureCloudPlatformClientV2.AgentCopilotAggregationQuery() # AgentCopilotAggregationQuery | query try: # Query for agent copilot aggregates api_response = api_instance.post_analytics_agentcopilots_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_agentcopilots_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get Reporting Turns (division aware). Returns the reporting turns for the specified flow, filtered by the clients divisions and grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","```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.AnalyticsApi(); bot_flow_id = 'bot_flow_id_example' # str | ID of the bot flow. after = 'after_example' # str | The cursor that points to the ID of the last item in the list of entities that has been returned. (optional) page_size = ''50'' # str | Max number of entities to return. Maximum of 250 (optional) (default to '50') interval = '2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z' # str | Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) action_id = 'action_id_example' # str | Optional action ID to get the reporting turns associated to a particular flow action (optional) session_id = 'session_id_example' # str | Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed. (optional) language = 'en-us' # str | Optional language code to get the reporting turns for a particular language (optional) ask_action_results = 'ask_action_results_example' # str | Optional case-insensitive comma separated list of ask action results to filter the reporting turns. (optional) try: # Get Reporting Turns (division aware). api_response = api_instance.get_analytics_botflow_divisions_reportingturns(bot_flow_id, after=after, page_size=page_size, interval=interval, action_id=action_id, session_id=session_id, language=language, ask_action_results=ask_action_results) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->get_analytics_botflow_divisions_reportingturns: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/botflows/{botFlowId}/sessions Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get Bot Flow Sessions. Returns the bot flow sessions in reverse chronological order from the date they were created. For pagination, clients should keep sending requests using the value of 'nextUri' in the response, until it's no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.","```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.AnalyticsApi(); bot_flow_id = 'bot_flow_id_example' # str | ID of the bot flow. after = 'after_example' # str | The cursor that points to the ID of the last item in the list of entities that has been returned. (optional) page_size = ''50'' # str | Max number of entities to return. Maximum of 250 (optional) (default to '50') interval = '2023-07-17T08:15:44.586Z/2023-07-26T09:22:33.111Z' # str | Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) bot_result_categories = 'bot_result_categories_example' # str | Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by. (optional) end_language = 'end_language_example' # str | Optional case-insensitive language code to filter sessions by the language the sessions ended in. (optional) try: # Get Bot Flow Sessions. api_response = api_instance.get_analytics_botflow_sessions(bot_flow_id, after=after, page_size=page_size, interval=interval, bot_result_categories=bot_result_categories, end_language=end_language) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->get_analytics_botflow_sessions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/bots/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for bot 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.AnalyticsApi(); body = PureCloudPlatformClientV2.BotAggregationQuery() # BotAggregationQuery | query try: # Query for bot aggregates api_response = api_instance.post_analytics_bots_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_bots_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/activity/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for conversation activity observations,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.ConversationActivityQuery() # ConversationActivityQuery | query page_size = 56 # int | The desired page size (optional) page_number = 56 # int | The desired page number (optional) try: # Query for conversation activity observations api_response = api_instance.post_analytics_conversations_activity_query(body, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_analytics_conversations_activity_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for conversation 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.ConversationsApi(); body = PureCloudPlatformClientV2.ConversationAggregationQuery() # ConversationAggregationQuery | query try: # Query for conversation aggregates api_response = api_instance.post_analytics_conversations_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_analytics_conversations_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/conversations/details Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets multiple conversations by 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.ConversationsApi(); id = ['id_example'] # list[str] | Comma-separated conversation ids (optional) try: # Gets multiple conversations by id api_response = api_instance.get_analytics_conversations_details(id=id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_analytics_conversations_details: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/details/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for conversation details 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.ConversationsApi(); body = PureCloudPlatformClientV2.AsyncConversationQuery() # AsyncConversationQuery | query try: # Query for conversation details asynchronously api_response = api_instance.post_analytics_conversations_details_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_analytics_conversations_details_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/availability Genesys Cloud Python SDK.,Genesys describes this as an API used to: Lookup the datalake availability date and time,"```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.ConversationsApi(); try: # Lookup the datalake availability date and time api_response = api_instance.get_analytics_conversations_details_jobs_availability() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_analytics_conversations_details_jobs_availability: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/analytics/conversations/details/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete/cancel an async details 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.ConversationsApi(); job_id = 'job_id_example' # str | jobId try: # Delete/cancel an async details job api_instance.delete_analytics_conversations_details_job(job_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_analytics_conversations_details_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get status for async query for conversation 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.ConversationsApi(); job_id = 'job_id_example' # str | jobId try: # Get status for async query for conversation details api_response = api_instance.get_analytics_conversations_details_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_analytics_conversations_details_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/{jobId}/results Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch a page of results for an async details 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.ConversationsApi(); job_id = 'job_id_example' # str | jobId cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional) page_size = 56 # int | The desired maximum number of results (optional) try: # Fetch a page of results for an async details job api_response = api_instance.get_analytics_conversations_details_job_results(job_id, cursor=cursor, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_analytics_conversations_details_job_results: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/details/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for conversation 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.ConversationsApi(); body = PureCloudPlatformClientV2.ConversationQuery() # ConversationQuery | query try: # Query for conversation details api_response = api_instance.post_analytics_conversations_details_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_analytics_conversations_details_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/transcripts/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search resources.,"```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.SearchApi(); body = PureCloudPlatformClientV2.TranscriptConversationDetailSearchRequest() # TranscriptConversationDetailSearchRequest | Search request options try: # Search resources. api_response = api_instance.post_analytics_conversations_transcripts_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->post_analytics_conversations_transcripts_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/conversations/{conversationId}/details Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a conversation by 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get a conversation by id api_response = api_instance.get_analytics_conversation_details(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_analytics_conversation_details: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/{conversationId}/details/properties Genesys Cloud Python SDK.,Genesys describes this as an API used to: Index conversation properties,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.PropertyIndexRequest() # PropertyIndexRequest | request try: # Index conversation properties api_response = api_instance.post_analytics_conversation_details_properties(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_analytics_conversation_details_properties: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/dataretention/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get analytics data retention setting,"```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.AnalyticsApi(); try: # Get analytics data retention setting api_response = api_instance.get_analytics_dataretention_settings() pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->get_analytics_dataretention_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/analytics/dataretention/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update analytics data retention setting,"```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.AnalyticsApi(); body = PureCloudPlatformClientV2.UpdateAnalyticsDataRetentionRequest() # UpdateAnalyticsDataRetentionRequest | retentionDays try: # Update analytics data retention setting api_response = api_instance.put_analytics_dataretention_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->put_analytics_dataretention_settings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/evaluations/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for evaluation 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.QualityApi(); body = PureCloudPlatformClientV2.EvaluationAggregationQuery() # EvaluationAggregationQuery | query try: # Query for evaluation aggregates api_response = api_instance.post_analytics_evaluations_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_analytics_evaluations_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/flowexecutions/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for flow execution 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.AnalyticsApi(); body = PureCloudPlatformClientV2.FlowExecutionAggregationQuery() # FlowExecutionAggregationQuery | query try: # Query for flow execution aggregates api_response = api_instance.post_analytics_flowexecutions_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_flowexecutions_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/flows/activity/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for flow activity observations,"```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.FlowsApi(); body = PureCloudPlatformClientV2.FlowActivityQuery() # FlowActivityQuery | query page_size = 56 # int | The desired page size (optional) page_number = 56 # int | The desired page number (optional) try: # Query for flow activity observations api_response = api_instance.post_analytics_flows_activity_query(body, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling FlowsApi->post_analytics_flows_activity_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/flows/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for flow 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.FlowsApi(); body = PureCloudPlatformClientV2.FlowAggregationQuery() # FlowAggregationQuery | query try: # Query for flow aggregates api_response = api_instance.post_analytics_flows_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling FlowsApi->post_analytics_flows_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/flows/observations/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for flow observations,"```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.FlowsApi(); body = PureCloudPlatformClientV2.FlowObservationQuery() # FlowObservationQuery | query try: # Query for flow observations api_response = api_instance.post_analytics_flows_observations_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling FlowsApi->post_analytics_flows_observations_query: %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 POST /api/v2/analytics/knowledge/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for knowledge 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.AnalyticsApi(); body = PureCloudPlatformClientV2.KnowledgeAggregationQuery() # KnowledgeAggregationQuery | query try: # Query for knowledge aggregates api_response = api_instance.post_analytics_knowledge_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_knowledge_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/queues/observations/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for queue observations,"```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.RoutingApi(); body = PureCloudPlatformClientV2.QueueObservationQuery() # QueueObservationQuery | query try: # Query for queue observations api_response = api_instance.post_analytics_queues_observations_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_analytics_queues_observations_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/ratelimits/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate. The 'max' property can be used to determine estimated rate limit value hit. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events 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.AnalyticsApi(); body = PureCloudPlatformClientV2.RateLimitAggregationQuery() # RateLimitAggregationQuery | query try: # Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate. api_response = api_instance.post_analytics_ratelimits_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_ratelimits_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/reporting/dashboards/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get dashboards summary for users in a 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.AnalyticsApi(); sort_by = ''asc'' # str | (optional) (default to 'asc') page_number = 1 # int | (optional) (default to 1) page_size = 25 # int | (optional) (default to 25) id = ['id_example'] # list[str] | A list of user IDs to fetch by bulk (optional) state = 'state_example' # str | Only list users of this state (optional) try: # Get dashboards summary for users in a org api_response = api_instance.get_analytics_reporting_dashboards_users(sort_by=sort_by, page_number=page_number, page_size=page_size, id=id, state=state) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->get_analytics_reporting_dashboards_users: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/reporting/dashboards/users/bulk/remove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk delete dashboards owned by other user(s),"```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.AnalyticsApi(); body = ['body_example'] # list[str] | List of userIds try: # Bulk delete dashboards owned by other user(s) api_instance.post_analytics_reporting_dashboards_users_bulk_remove(body) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_reporting_dashboards_users_bulk_remove: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/reporting/dashboards/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get dashboards summary for a 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.AnalyticsApi(); user_id = 'user_id_example' # str | User ID try: # Get dashboards summary for a user api_response = api_instance.get_analytics_reporting_dashboards_user(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->get_analytics_reporting_dashboards_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/reporting/exports Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all view export requests for a 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.AnalyticsApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get all view export requests for a user api_response = api_instance.get_analytics_reporting_exports(page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->get_analytics_reporting_exports: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/reporting/exports Genesys Cloud Python SDK.,Genesys describes this as an API used to: Generate a view export request. This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead,"```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.AnalyticsApi(); body = PureCloudPlatformClientV2.ReportingExportJobRequest() # ReportingExportJobRequest | ReportingExportJobRequest try: # Generate a view export request api_response = api_instance.post_analytics_reporting_exports(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_reporting_exports: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/reporting/exports/metadata Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all export metadata,"```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.AnalyticsApi(); try: # Get all export metadata api_response = api_instance.get_analytics_reporting_exports_metadata() pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->get_analytics_reporting_exports_metadata: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/reporting/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get AnalyticsReportingSettings for an organization,"```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.AnalyticsApi(); try: # Get AnalyticsReportingSettings for an organization api_response = api_instance.get_analytics_reporting_settings() pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->get_analytics_reporting_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/analytics/reporting/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch AnalyticsReportingSettings values for an organization,"```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.AnalyticsApi(); body = PureCloudPlatformClientV2.AnalyticsReportingSettings() # AnalyticsReportingSettings | AnalyticsReportingSettingsRequest try: # Patch AnalyticsReportingSettings values for an organization api_response = api_instance.patch_analytics_reporting_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->patch_analytics_reporting_settings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/reporting/settings/dashboards/bulk/remove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk remove dashboard configurations,"```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.AnalyticsApi(); body = PureCloudPlatformClientV2.DashboardConfigurationBulkRequest() # DashboardConfigurationBulkRequest | try: # Bulk remove dashboard configurations api_instance.post_analytics_reporting_settings_dashboards_bulk_remove(body) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_reporting_settings_dashboards_bulk_remove: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/reporting/settings/dashboards/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of dashboard configurations,"```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.AnalyticsApi(); dashboard_type = 'dashboard_type_example' # str | List dashboard of given type dashboard_access_filter = 'dashboard_access_filter_example' # str | Filter dashboard based on the owner of dashboard name = 'name_example' # str | name of the dashboard (optional) sort_by = ''desc'' # str | (optional) (default to 'desc') page_number = 1 # int | (optional) (default to 1) page_size = 9 # int | (optional) (default to 9) try: # Get list of dashboard configurations api_response = api_instance.get_analytics_reporting_settings_dashboards_query(dashboard_type, dashboard_access_filter, name=name, sort_by=sort_by, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->get_analytics_reporting_settings_dashboards_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/reporting/settings/dashboards/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query dashboard configurations,"```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.AnalyticsApi(); body = PureCloudPlatformClientV2.DashboardConfigurationQueryRequest() # DashboardConfigurationQueryRequest | try: # Query dashboard configurations api_response = api_instance.post_analytics_reporting_settings_dashboards_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_reporting_settings_dashboards_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/reporting/settings/users/{userId}/dashboards Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of dashboards for an 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.AnalyticsApi(); user_id = 'user_id_example' # str | User ID sort_by = ''asc'' # str | (optional) (default to 'asc') page_number = 1 # int | (optional) (default to 1) page_size = 50 # int | (optional) (default to 50) public_only = True # bool | If true, retrieve only public dashboards (optional) favorite_only = True # bool | If true, retrieve only favorite dashboards (optional) name = 'name_example' # str | retrieve dashboards that match with given name (optional) try: # Get list of dashboards for an user api_response = api_instance.get_analytics_reporting_settings_user_dashboards(user_id, sort_by=sort_by, page_number=page_number, page_size=page_size, public_only=public_only, favorite_only=favorite_only, name=name) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->get_analytics_reporting_settings_user_dashboards: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/routing/activity/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user activity observations,"```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.RoutingApi(); body = PureCloudPlatformClientV2.RoutingActivityQuery() # RoutingActivityQuery | query page_size = 56 # int | The desired page size (optional) page_number = 56 # int | The desired page number (optional) try: # Query for user activity observations api_response = api_instance.post_analytics_routing_activity_query(body, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_analytics_routing_activity_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/surveys/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for survey 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.QualityApi(); body = PureCloudPlatformClientV2.SurveyAggregationQuery() # SurveyAggregationQuery | query try: # Query for survey aggregates api_response = api_instance.post_analytics_surveys_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_analytics_surveys_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/teams/activity/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for team activity observations,"```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.TeamsApi(); body = PureCloudPlatformClientV2.TeamActivityQuery() # TeamActivityQuery | query page_size = 56 # int | The desired page size (optional) page_number = 56 # int | The desired page number (optional) try: # Query for team activity observations api_response = api_instance.post_analytics_teams_activity_query(body, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling TeamsApi->post_analytics_teams_activity_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/transcripts/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for transcript 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.AnalyticsApi(); body = PureCloudPlatformClientV2.TranscriptAggregationQuery() # TranscriptAggregationQuery | query try: # Query for transcript aggregates api_response = api_instance.post_analytics_transcripts_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling AnalyticsApi->post_analytics_transcripts_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/users/activity/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user activity observations,"```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.UsersApi(); body = PureCloudPlatformClientV2.UserActivityQuery() # UserActivityQuery | query page_size = 56 # int | The desired page size (optional) page_number = 56 # int | The desired page number (optional) try: # Query for user activity observations api_response = api_instance.post_analytics_users_activity_query(body, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_analytics_users_activity_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/users/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user 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.UsersApi(); body = PureCloudPlatformClientV2.UserAggregationQuery() # UserAggregationQuery | query try: # Query for user aggregates api_response = api_instance.post_analytics_users_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_analytics_users_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/users/details/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user details 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.UsersApi(); body = PureCloudPlatformClientV2.AsyncUserDetailsQuery() # AsyncUserDetailsQuery | query try: # Query for user details asynchronously api_response = api_instance.post_analytics_users_details_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_analytics_users_details_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/users/details/jobs/availability Genesys Cloud Python SDK.,Genesys describes this as an API used to: Lookup the datalake availability date and time,"```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.UsersApi(); try: # Lookup the datalake availability date and time api_response = api_instance.get_analytics_users_details_jobs_availability() pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_analytics_users_details_jobs_availability: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/analytics/users/details/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete/cancel an async request,"```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.UsersApi(); job_id = 'job_id_example' # str | jobId try: # Delete/cancel an async request api_instance.delete_analytics_users_details_job(job_id) except ApiException as e: print(""Exception when calling UsersApi->delete_analytics_users_details_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/users/details/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get status for async query for user 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.UsersApi(); job_id = 'job_id_example' # str | jobId try: # Get status for async query for user details api_response = api_instance.get_analytics_users_details_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_analytics_users_details_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/users/details/jobs/{jobId}/results Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch a page of results for an async query,"```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.UsersApi(); job_id = 'job_id_example' # str | jobId cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional) page_size = 56 # int | The desired maximum number of results (optional) try: # Fetch a page of results for an async query api_response = api_instance.get_analytics_users_details_job_results(job_id, cursor=cursor, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_analytics_users_details_job_results: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/users/details/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user 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.UsersApi(); body = PureCloudPlatformClientV2.UserDetailsQuery() # UserDetailsQuery | query try: # Query for user details api_response = api_instance.post_analytics_users_details_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_analytics_users_details_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/users/observations/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user observations,"```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.UsersApi(); body = PureCloudPlatformClientV2.UserObservationQuery() # UserObservationQuery | query try: # Query for user observations api_response = api_instance.post_analytics_users_observations_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_analytics_users_observations_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/dependencytracking Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Dependency Tracking objects that have a given display name,"```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.ArchitectApi(); name = 'name_example' # str | Object name to search for page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) object_type = ['object_type_example'] # list[str] | Object type(s) to search for (optional) consumed_resources = True # bool | Include resources each result item consumes (optional) consuming_resources = True # bool | Include resources that consume each result item (optional) consumed_resource_type = ['consumed_resource_type_example'] # list[str] | Types of consumed resources to return, if consumed resources are requested (optional) consuming_resource_type = ['consuming_resource_type_example'] # list[str] | Types of consuming resources to return, if consuming resources are requested (optional) try: # Get Dependency Tracking objects that have a given display name api_response = api_instance.get_architect_dependencytracking(name, page_number=page_number, page_size=page_size, object_type=object_type, consumed_resources=consumed_resources, consuming_resources=consuming_resources, consumed_resource_type=consumed_resource_type, consuming_resource_type=consuming_resource_type) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_dependencytracking: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/dependencytracking/build Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Dependency Tracking build status for an organization,"```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.ArchitectApi(); try: # Get Dependency Tracking build status for an organization api_response = api_instance.get_architect_dependencytracking_build() pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_dependencytracking_build: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/dependencytracking/build Genesys Cloud Python SDK.,Genesys describes this as an API used to: Rebuild Dependency Tracking data for an organization. Asynchronous. Notification topic: v2.architect.dependencytracking.build,"```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.ArchitectApi(); try: # Rebuild Dependency Tracking data for an organization api_instance.post_architect_dependencytracking_build() except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_dependencytracking_build: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/dependencytracking/consumedresources Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get resources that are consumed by a given Dependency Tracking object,"```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.ArchitectApi(); id = 'id_example' # str | Consuming object ID version = 'version_example' # str | Consuming object version object_type = 'object_type_example' # str | Consuming object type. Only versioned types are allowed here. resource_type = ['resource_type_example'] # list[str] | Types of consumed resources to show (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get resources that are consumed by a given Dependency Tracking object api_response = api_instance.get_architect_dependencytracking_consumedresources(id, version, object_type, resource_type=resource_type, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_dependencytracking_consumedresources: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/dependencytracking/consumingresources Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get resources that consume a given Dependency Tracking object,"```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.ArchitectApi(); id = 'id_example' # str | Consumed object ID object_type = 'object_type_example' # str | Consumed object type resource_type = ['resource_type_example'] # list[str] | Types of consuming resources to show. Only versioned types are allowed here. (optional) version = 'version_example' # str | Object version (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) flow_filter = 'flow_filter_example' # str | Show only checkedIn or published flows (optional) try: # Get resources that consume a given Dependency Tracking object api_response = api_instance.get_architect_dependencytracking_consumingresources(id, object_type, resource_type=resource_type, version=version, page_number=page_number, page_size=page_size, flow_filter=flow_filter) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_dependencytracking_consumingresources: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/dependencytracking/deletedresourceconsumers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Dependency Tracking objects that consume deleted resources,"```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.ArchitectApi(); name = 'name_example' # str | Name to search for (optional) object_type = ['object_type_example'] # list[str] | Object type(s) to search for (optional) flow_filter = 'flow_filter_example' # str | Show only checkedIn or published flows (optional) consumed_resources = False # bool | Return consumed resources? (optional) (default to False) consumed_resource_type = ['consumed_resource_type_example'] # list[str] | Resource type(s) to return (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get Dependency Tracking objects that consume deleted resources api_response = api_instance.get_architect_dependencytracking_deletedresourceconsumers(name=name, object_type=object_type, flow_filter=flow_filter, consumed_resources=consumed_resources, consumed_resource_type=consumed_resource_type, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_dependencytracking_deletedresourceconsumers: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/dependencytracking/object Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Dependency Tracking object,"```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.ArchitectApi(); id = 'id_example' # str | Object ID version = 'version_example' # str | Object version (optional) object_type = 'object_type_example' # str | Object type (optional) consumed_resources = True # bool | Include resources this item consumes (optional) consuming_resources = True # bool | Include resources that consume this item (optional) consumed_resource_type = ['consumed_resource_type_example'] # list[str] | Types of consumed resources to return, if consumed resources are requested (optional) consuming_resource_type = ['consuming_resource_type_example'] # list[str] | Types of consuming resources to return, if consuming resources are requested (optional) consumed_resource_request = True # bool | Indicate that this is going to look up a consumed resource object (optional) try: # Get a Dependency Tracking object api_response = api_instance.get_architect_dependencytracking_object(id, version=version, object_type=object_type, consumed_resources=consumed_resources, consuming_resources=consuming_resources, consumed_resource_type=consumed_resource_type, consuming_resource_type=consuming_resource_type, consumed_resource_request=consumed_resource_request) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_dependencytracking_object: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/dependencytracking/types Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Dependency Tracking 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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get Dependency Tracking types. api_response = api_instance.get_architect_dependencytracking_types(page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_dependencytracking_types: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/dependencytracking/types/{typeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Dependency Tracking 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.ArchitectApi(); type_id = 'type_id_example' # str | Type ID try: # Get a Dependency Tracking type. api_response = api_instance.get_architect_dependencytracking_type(type_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_dependencytracking_type: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/dependencytracking/updatedresourceconsumers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Dependency Tracking objects that depend on updated resources,"```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.ArchitectApi(); name = 'name_example' # str | Name to search for (optional) object_type = ['object_type_example'] # list[str] | Object type(s) to search for (optional) consumed_resources = False # bool | Return consumed resources? (optional) (default to False) consumed_resource_type = ['consumed_resource_type_example'] # list[str] | Resource type(s) to return (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get Dependency Tracking objects that depend on updated resources api_response = api_instance.get_architect_dependencytracking_updatedresourceconsumers(name=name, object_type=object_type, consumed_resources=consumed_resources, consumed_resource_type=consumed_resource_type, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_dependencytracking_updatedresourceconsumers: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/emergencygroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of emergency groups.,"```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') name = 'name_example' # str | Name of the Emergency Group to filter by. (optional) try: # Get a list of emergency groups. api_response = api_instance.get_architect_emergencygroups(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, name=name) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_emergencygroups: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/emergencygroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a new emergency group,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.EmergencyGroup() # EmergencyGroup | try: # Creates a new emergency group api_response = api_instance.post_architect_emergencygroups(body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_emergencygroups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/emergencygroups/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of basic emergency group objects filterable by query parameters. This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.","```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') id = ['id_example'] # list[str] | ID of the Emergency Groups to filter by. (optional) name = 'name_example' # str | Name of the Emergency Group to filter by. (optional) division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional) try: # Get a pageable list of basic emergency group objects filterable by query parameters. api_response = api_instance.get_architect_emergencygroups_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_emergencygroups_divisionviews: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/emergencygroups/{emergencyGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a emergency group by 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.ArchitectApi(); emergency_group_id = 'emergency_group_id_example' # str | Emergency group ID try: # Deletes a emergency group by ID api_instance.delete_architect_emergencygroup(emergency_group_id) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_emergencygroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/emergencygroups/{emergencyGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a emergency group by 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.ArchitectApi(); emergency_group_id = 'emergency_group_id_example' # str | Emergency group ID try: # Gets a emergency group by ID api_response = api_instance.get_architect_emergencygroup(emergency_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_emergencygroup: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/architect/emergencygroups/{emergencyGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a emergency group by 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.ArchitectApi(); emergency_group_id = 'emergency_group_id_example' # str | Emergency group ID body = PureCloudPlatformClientV2.EmergencyGroup() # EmergencyGroup | try: # Updates a emergency group by ID api_response = api_instance.put_architect_emergencygroup(emergency_group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_architect_emergencygroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/grammars Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of grammars, filtered by query parameters. Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.","```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') id = ['id_example'] # list[str] | ID (optional) name = 'name_example' # str | Name (optional) description = 'description_example' # str | Description (optional) name_or_description = 'name_or_description_example' # str | Name or description (optional) include_file_urls = True # bool | Include grammar language file URLs (optional) try: # Get a pageable list of grammars, filtered by query parameters api_response = api_instance.get_architect_grammars(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, description=description, name_or_description=name_or_description, include_file_urls=include_file_urls) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_grammars: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/grammars Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new grammar,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.Grammar() # Grammar | try: # Create a new grammar api_response = api_instance.post_architect_grammars(body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_grammars: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/grammars/{grammarId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a grammar.,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | grammar ID try: # Delete a grammar. api_response = api_instance.delete_architect_grammar(grammar_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_grammar: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/grammars/{grammarId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a grammar. Returns a specified grammar,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | grammar ID include_file_urls = True # bool | Include grammar language file URLs (optional) try: # Get a grammar api_response = api_instance.get_architect_grammar(grammar_id, include_file_urls=include_file_urls) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_grammar: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/architect/grammars/{grammarId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a grammar,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | grammar ID body = PureCloudPlatformClientV2.Grammar() # Grammar | (optional) try: # Updates a grammar api_response = api_instance.patch_architect_grammar(grammar_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->patch_architect_grammar: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/grammars/{grammarId}/languages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new language for a given grammar,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | Grammar ID body = PureCloudPlatformClientV2.GrammarLanguage() # GrammarLanguage | try: # Create a new language for a given grammar api_response = api_instance.post_architect_grammar_languages(grammar_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_grammar_languages: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete specified grammar language,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | Grammar ID language_code = 'language_code_example' # str | Language try: # Delete specified grammar language api_instance.delete_architect_grammar_language(grammar_id, language_code) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_grammar_language: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/grammars/{grammarId}/languages/{languageCode} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a grammar language.,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | Grammar ID language_code = 'language_code_example' # str | Language try: # Get a grammar language. api_response = api_instance.get_architect_grammar_language(grammar_id, language_code) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_grammar_language: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/architect/grammars/{grammarId}/languages/{languageCode} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a grammar language,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | Grammar ID language_code = 'language_code_example' # str | Language body = PureCloudPlatformClientV2.GrammarLanguageUpdate() # GrammarLanguageUpdate | (optional) try: # Updates a grammar language api_response = api_instance.patch_architect_grammar_language(grammar_id, language_code, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->patch_architect_grammar_language: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf Genesys Cloud Python SDK.,Genesys describes this as an API used to: Clear the DTMF mode file for the grammar language if there is one,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | Grammar ID language_code = 'language_code_example' # str | Language try: # Clear the DTMF mode file for the grammar language if there is one api_instance.delete_architect_grammar_language_files_dtmf(grammar_id, language_code) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_grammar_language_files_dtmf: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a presigned URL for uploading a grammar DTMF mode file,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | Grammar ID language_code = 'language_code_example' # str | Language body = PureCloudPlatformClientV2.GrammarFileUploadRequest() # GrammarFileUploadRequest | query try: # Creates a presigned URL for uploading a grammar DTMF mode file api_response = api_instance.post_architect_grammar_language_files_dtmf(grammar_id, language_code, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_grammar_language_files_dtmf: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice Genesys Cloud Python SDK.,Genesys describes this as an API used to: Clear the voice mode file for the grammar language if there is one,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | Grammar ID language_code = 'language_code_example' # str | Language try: # Clear the voice mode file for the grammar language if there is one api_instance.delete_architect_grammar_language_files_voice(grammar_id, language_code) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_grammar_language_files_voice: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a presigned URL for uploading a grammar voice mode file,"```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.ArchitectApi(); grammar_id = 'grammar_id_example' # str | Grammar ID language_code = 'language_code_example' # str | Language body = PureCloudPlatformClientV2.GrammarFileUploadRequest() # GrammarFileUploadRequest | query try: # Creates a presigned URL for uploading a grammar voice mode file api_response = api_instance.post_architect_grammar_language_files_voice(grammar_id, language_code, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_grammar_language_files_voice: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/ivrs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get IVR configs.,"```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') name = 'name_example' # str | Name of the IVR to filter by. (optional) dnis = 'dnis_example' # str | The phone number of the IVR to filter by. (optional) schedule_group = 'schedule_group_example' # str | The Schedule Group of the IVR to filter by. (optional) try: # Get IVR configs. api_response = api_instance.get_architect_ivrs(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, name=name, dnis=dnis, schedule_group=schedule_group) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_ivrs: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/ivrs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create IVR config.,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.IVR() # IVR | try: # Create IVR config. api_response = api_instance.post_architect_ivrs(body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_ivrs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/ivrs/divisionviews Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a pageable list of basic ivr configuration information objects filterable by query 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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') id = ['id_example'] # list[str] | ID of the IVR to filter by. (optional) name = 'name_example' # str | Name of the IVR to filter by. (optional) division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional) try: # Get a pageable list of basic ivr configuration information objects filterable by query parameters. api_response = api_instance.get_architect_ivrs_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_ivrs_divisionviews: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/ivrs/{ivrId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an IVR Config.,"```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.ArchitectApi(); ivr_id = 'ivr_id_example' # str | IVR id try: # Delete an IVR Config. api_instance.delete_architect_ivr(ivr_id) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_ivr: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/ivrs/{ivrId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an IVR config.,"```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.ArchitectApi(); ivr_id = 'ivr_id_example' # str | IVR id try: # Get an IVR config. api_response = api_instance.get_architect_ivr(ivr_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_ivr: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/architect/ivrs/{ivrId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an IVR Config.,"```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.ArchitectApi(); ivr_id = 'ivr_id_example' # str | IVR id body = PureCloudPlatformClientV2.IVR() # IVR | try: # Update an IVR Config. api_response = api_instance.put_architect_ivr(ivr_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_architect_ivr: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/prompts Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Batch-delete a list of prompts. Multiple IDs can be specified, in which case all specified prompts will be deleted. Asynchronous. Notification topic: v2.architect.prompts.{promptId}","```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.ArchitectApi(); id = ['id_example'] # list[str] | List of Prompt IDs try: # Batch-delete a list of prompts api_response = api_instance.delete_architect_prompts(id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_prompts: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/prompts Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of user prompts. The returned list is pageable, and query parameters can be used for filtering. Multiple names can be specified, in which case all matching prompts will be returned, and no other filters will be evaluated.","```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) name = ['name_example'] # list[str] | Name (optional) description = 'description_example' # str | Description (optional) name_or_description = 'name_or_description_example' # str | Name or description (optional) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') include_media_uris = True # bool | Include the media URIs for each resource (optional) (default to True) include_resources = True # bool | Include the resources for each system prompt (optional) (default to True) language = ['language_example'] # list[str] | Filter the resources down to the provided languages (optional) try: # Get a pageable list of user prompts api_response = api_instance.get_architect_prompts(page_number=page_number, page_size=page_size, name=name, description=description, name_or_description=name_or_description, sort_by=sort_by, sort_order=sort_order, include_media_uris=include_media_uris, include_resources=include_resources, language=language) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_prompts: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/prompts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new user prompt,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.Prompt() # Prompt | try: # Create a new user prompt api_response = api_instance.post_architect_prompts(body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_prompts: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/prompts/{promptId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete specified user prompt,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID all_resources = True # bool | Whether or not to delete all the prompt resources (optional) try: # Delete specified user prompt api_instance.delete_architect_prompt(prompt_id, all_resources=all_resources) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_prompt: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/prompts/{promptId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get specified user prompt,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID include_media_uris = True # bool | Include the media URIs for each resource (optional) (default to True) include_resources = True # bool | Include the resources for each system prompt (optional) (default to True) language = ['language_example'] # list[str] | Filter the resources down to the provided languages (optional) try: # Get specified user prompt api_response = api_instance.get_architect_prompt(prompt_id, include_media_uris=include_media_uris, include_resources=include_resources, language=language) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_prompt: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/architect/prompts/{promptId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update specified user prompt,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID body = PureCloudPlatformClientV2.Prompt() # Prompt | try: # Update specified user prompt api_response = api_instance.put_architect_prompt(prompt_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_architect_prompt: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/prompts/{promptId}/history Genesys Cloud Python SDK.,Genesys describes this as an API used to: Generate prompt history. Asynchronous. Notification topic: v2.architect.prompts.{promptId},"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID try: # Generate prompt history api_response = api_instance.post_architect_prompt_history(prompt_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_prompt_history: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/prompts/{promptId}/history/{historyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get generated prompt history,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID history_id = 'history_id_example' # str | History request ID page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_order = ''desc'' # str | Sort order (optional) (default to 'desc') sort_by = ''timestamp'' # str | Sort by (optional) (default to 'timestamp') action = ['action_example'] # list[str] | Flow actions to include (omit to include all) (optional) try: # Get generated prompt history api_response = api_instance.get_architect_prompt_history_history_id(prompt_id, history_id, page_number=page_number, page_size=page_size, sort_order=sort_order, sort_by=sort_by, action=action) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_prompt_history_history_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/prompts/{promptId}/resources Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of user prompt resources. The returned list is pageable, and query parameters can be used for filtering.","```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get a pageable list of user prompt resources api_response = api_instance.get_architect_prompt_resources(prompt_id, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_prompt_resources: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/prompts/{promptId}/resources Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new user prompt resource,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID body = PureCloudPlatformClientV2.PromptAssetCreate() # PromptAssetCreate | try: # Create a new user prompt resource api_response = api_instance.post_architect_prompt_resources(prompt_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_prompt_resources: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete specified user prompt resource,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID language_code = 'language_code_example' # str | Language try: # Delete specified user prompt resource api_instance.delete_architect_prompt_resource(prompt_id, language_code) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_prompt_resource: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/prompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get specified user prompt resource,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID language_code = 'language_code_example' # str | Language try: # Get specified user prompt resource api_response = api_instance.get_architect_prompt_resource(prompt_id, language_code) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_prompt_resource: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/architect/prompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update specified user prompt resource,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID language_code = 'language_code_example' # str | Language body = PureCloudPlatformClientV2.PromptAsset() # PromptAsset | try: # Update specified user prompt resource api_response = api_instance.put_architect_prompt_resource(prompt_id, language_code, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_architect_prompt_resource: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/prompts/{promptId}/resources/{languageCode}/audio Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete specified user prompt resource audio,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID language_code = 'language_code_example' # str | Language try: # Delete specified user prompt resource audio api_instance.delete_architect_prompt_resource_audio(prompt_id, language_code) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_prompt_resource_audio: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/schedulegroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of schedule groups.,"```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') name = 'name_example' # str | Name of the Schedule Group to filter by. (optional) schedule_ids = 'schedule_ids_example' # str | A comma-delimited list of Schedule IDs to filter by. (optional) division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional) try: # Get a list of schedule groups. api_response = api_instance.get_architect_schedulegroups(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, name=name, schedule_ids=schedule_ids, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_schedulegroups: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/schedulegroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a new schedule group,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.ScheduleGroup() # ScheduleGroup | try: # Creates a new schedule group api_response = api_instance.post_architect_schedulegroups(body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_schedulegroups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/schedulegroups/divisionviews Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a pageable list of basic schedule group configuration information objects filterable by query 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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') id = ['id_example'] # list[str] | ID of the schedule group to filter by. (optional) name = 'name_example' # str | Name of the schedule group to filter by. (optional) division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional) try: # Get a pageable list of basic schedule group configuration information objects filterable by query parameters. api_response = api_instance.get_architect_schedulegroups_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_schedulegroups_divisionviews: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/schedulegroups/{scheduleGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a schedule group by 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.ArchitectApi(); schedule_group_id = 'schedule_group_id_example' # str | Schedule group ID try: # Deletes a schedule group by ID api_instance.delete_architect_schedulegroup(schedule_group_id) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_schedulegroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/schedulegroups/{scheduleGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a schedule group by 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.ArchitectApi(); schedule_group_id = 'schedule_group_id_example' # str | Schedule group ID try: # Gets a schedule group by ID api_response = api_instance.get_architect_schedulegroup(schedule_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_schedulegroup: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/architect/schedulegroups/{scheduleGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a schedule group by 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.ArchitectApi(); schedule_group_id = 'schedule_group_id_example' # str | Schedule group ID body = PureCloudPlatformClientV2.ScheduleGroup() # ScheduleGroup | try: # Updates a schedule group by ID api_response = api_instance.put_architect_schedulegroup(schedule_group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_architect_schedulegroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/schedules Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of schedules.,"```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') name = 'name_example' # str | Name of the Schedule to filter by. (optional) division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional) try: # Get a list of schedules. api_response = api_instance.get_architect_schedules(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, name=name, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_schedules: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/schedules Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new schedule.,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.Schedule() # Schedule | try: # Create a new schedule. api_response = api_instance.post_architect_schedules(body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_schedules: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/schedules/divisionviews Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a pageable list of basic schedule configuration information objects filterable by query 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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') id = ['id_example'] # list[str] | ID of the schedule group to filter by. (optional) name = 'name_example' # str | Name of the schedule group to filter by. (optional) division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional) try: # Get a pageable list of basic schedule configuration information objects filterable by query parameters. api_response = api_instance.get_architect_schedules_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_schedules_divisionviews: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/schedules/{scheduleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a schedule by 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.ArchitectApi(); schedule_id = 'schedule_id_example' # str | Schedule ID try: # Delete a schedule by id api_instance.delete_architect_schedule(schedule_id) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_schedule: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/schedules/{scheduleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a schedule by 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.ArchitectApi(); schedule_id = 'schedule_id_example' # str | Schedule ID try: # Get a schedule by ID api_response = api_instance.get_architect_schedule(schedule_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_schedule: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/architect/schedules/{scheduleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update schedule by 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.ArchitectApi(); schedule_id = 'schedule_id_example' # str | Schedule ID body = PureCloudPlatformClientV2.Schedule() # Schedule | try: # Update schedule by ID api_response = api_instance.put_architect_schedule(schedule_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_architect_schedule: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/systemprompts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get System Prompts,"```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') name = 'name_example' # str | Name (optional) description = 'description_example' # str | Description (optional) name_or_description = 'name_or_description_example' # str | Name or description (optional) include_media_uris = True # bool | Include the media URIs for each resource (optional) (default to True) include_resources = True # bool | Include the resources for each system prompt (optional) (default to True) language = ['language_example'] # list[str] | Filter the resources down to the provided languages (optional) try: # Get System Prompts api_response = api_instance.get_architect_systemprompts(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, name=name, description=description, name_or_description=name_or_description, include_media_uris=include_media_uris, include_resources=include_resources, language=language) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_systemprompts: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/systemprompts/{promptId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a system prompt,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | promptId include_media_uris = True # bool | Include the media URIs for each resource (optional) (default to True) include_resources = True # bool | Include the resources for each system prompt (optional) (default to True) language = ['language_example'] # list[str] | Filter the resources down to the provided languages (optional) try: # Get a system prompt api_response = api_instance.get_architect_systemprompt(prompt_id, include_media_uris=include_media_uris, include_resources=include_resources, language=language) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_systemprompt: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/systemprompts/{promptId}/history Genesys Cloud Python SDK.,Genesys describes this as an API used to: Generate system prompt history. Asynchronous. Notification topic: v2.architect.systemprompts.{systemPromptId},"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | promptId try: # Generate system prompt history api_response = api_instance.post_architect_systemprompt_history(prompt_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_systemprompt_history: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/systemprompts/{promptId}/history/{historyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get generated prompt history,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | promptId history_id = 'history_id_example' # str | History request ID page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_order = ''desc'' # str | Sort order (optional) (default to 'desc') sort_by = ''timestamp'' # str | Sort by (optional) (default to 'timestamp') action = ['action_example'] # list[str] | Flow actions to include (omit to include all) (optional) try: # Get generated prompt history api_response = api_instance.get_architect_systemprompt_history_history_id(prompt_id, history_id, page_number=page_number, page_size=page_size, sort_order=sort_order, sort_by=sort_by, action=action) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_systemprompt_history_history_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/systemprompts/{promptId}/resources Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get system prompt resources.,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') try: # Get system prompt resources. api_response = api_instance.get_architect_systemprompt_resources(prompt_id, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_systemprompt_resources: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/architect/systemprompts/{promptId}/resources Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create system prompt resource override.,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID body = PureCloudPlatformClientV2.SystemPromptAsset() # SystemPromptAsset | try: # Create system prompt resource override. api_response = api_instance.post_architect_systemprompt_resources(prompt_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_architect_systemprompt_resources: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a system prompt resource override.,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID language_code = 'language_code_example' # str | Language try: # Delete a system prompt resource override. api_instance.delete_architect_systemprompt_resource(prompt_id, language_code) except ApiException as e: print(""Exception when calling ArchitectApi->delete_architect_systemprompt_resource: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a system prompt resource.,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID language_code = 'language_code_example' # str | Language try: # Get a system prompt resource. api_response = api_instance.get_architect_systemprompt_resource(prompt_id, language_code) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_architect_systemprompt_resource: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/architect/systemprompts/{promptId}/resources/{languageCode} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a system prompt resource override.,"```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.ArchitectApi(); prompt_id = 'prompt_id_example' # str | Prompt ID language_code = 'language_code_example' # str | Language body = PureCloudPlatformClientV2.SystemPromptAsset() # SystemPromptAsset | try: # Updates a system prompt resource override. api_response = api_instance.put_architect_systemprompt_resource(prompt_id, language_code, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_architect_systemprompt_resource: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/flows Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Batch-delete a list of flows. Multiple IDs can be specified, in which case all specified flows will be deleted. Asynchronous. Notification topic: v2.flows.{flowId}","```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.ArchitectApi(); id = ['id_example'] # list[str] | List of Flow IDs try: # Batch-delete a list of flows api_response = api_instance.delete_flows(id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->delete_flows: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of flows, filtered by query parameters. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.","```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.ArchitectApi(); type = ['type_example'] # list[str] | Type (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') id = ['id_example'] # list[str] | ID (optional) name = 'name_example' # str | Name (optional) description = 'description_example' # str | Description (optional) name_or_description = 'name_or_description_example' # str | Name or description (optional) publish_version_id = 'publish_version_id_example' # str | Publish version ID (optional) editable_by = 'editable_by_example' # str | Editable by (optional) locked_by = 'locked_by_example' # str | Locked by (optional) locked_by_client_id = 'locked_by_client_id_example' # str | Locked by client ID (optional) secure = 'secure_example' # str | Secure (optional) deleted = False # bool | Include deleted (optional) (default to False) include_schemas = False # bool | Include variable schemas (optional) (default to False) published_after = '2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01' # str | Published after (optional) published_before = '2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01' # str | Published before (optional) division_id = ['division_id_example'] # list[str] | division ID(s) (optional) try: # Get a pageable list of flows, filtered by query parameters api_response = api_instance.get_flows(type=type, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, description=description, name_or_description=name_or_description, publish_version_id=publish_version_id, editable_by=editable_by, locked_by=locked_by, locked_by_client_id=locked_by_client_id, secure=secure, deleted=deleted, include_schemas=include_schemas, published_after=published_after, published_before=published_before, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create flow,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.Flow() # Flow | language = 'language_example' # str | Language (optional) try: # Create flow api_response = api_instance.post_flows(body, language=language) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/actions/checkin Genesys Cloud Python SDK.,Genesys describes this as an API used to: Check-in flow. Asynchronous. Notification topic: v2.flows.{flowId},"```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.ArchitectApi(); flow = 'flow_example' # str | Flow ID try: # Check-in flow api_response = api_instance.post_flows_actions_checkin(flow) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_actions_checkin: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/actions/checkout Genesys Cloud Python SDK.,Genesys describes this as an API used to: Check-out flow,"```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.ArchitectApi(); flow = 'flow_example' # str | Flow ID try: # Check-out flow api_response = api_instance.post_flows_actions_checkout(flow) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_actions_checkout: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/actions/deactivate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deactivate flow,"```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.ArchitectApi(); flow = 'flow_example' # str | Flow ID try: # Deactivate flow api_response = api_instance.post_flows_actions_deactivate(flow) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_actions_deactivate: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/actions/publish Genesys Cloud Python SDK.,Genesys describes this as an API used to: Publish flow. Asynchronous. Notification topic: v2.flows.{flowId},"```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.ArchitectApi(); flow = 'flow_example' # str | Flow ID version = 'version_example' # str | version (optional) try: # Publish flow api_response = api_instance.post_flows_actions_publish(flow, version=version) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_actions_publish: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/actions/revert Genesys Cloud Python SDK.,Genesys describes this as an API used to: Revert flow,"```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.ArchitectApi(); flow = 'flow_example' # str | Flow ID try: # Revert flow api_response = api_instance.post_flows_actions_revert(flow) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_actions_revert: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/actions/unlock Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Unlock flow. Allows for unlocking a flow in the case where there is no flow configuration available, and thus a check-in will not unlock the flow. The user must have Architect Admin permissions to perform this 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.ArchitectApi(); flow = 'flow_example' # str | Flow ID try: # Unlock flow api_response = api_instance.post_flows_actions_unlock(flow) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_actions_unlock: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/datatables Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Retrieve a list of datatables for the org. Returns a metadata list of the datatables associated with this org, including datatableId, name and description.","```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.ArchitectApi(); expand = 'expand_example' # str | Expand instructions for the result (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending') division_id = ['division_id_example'] # list[str] | division ID(s) (optional) name = 'exactMatch, beginsWith*, *endsWith, *contains*' # str | Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive. (optional) try: # Retrieve a list of datatables for the org api_response = api_instance.get_flows_datatables(expand=expand, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, division_id=division_id, name=name) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_datatables: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/datatables Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new datatable with the specified json-schema definition. This will create a new datatable with fields that match the property definitions in the JSON schema. The schema's title field will be overridden by the name field in the DataTable object. See also http://json-schema.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.ArchitectApi(); body = PureCloudPlatformClientV2.DataTable() # DataTable | datatable json-schema try: # Create a new datatable with the specified json-schema definition api_response = api_instance.post_flows_datatables(body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_datatables: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/datatables/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Retrieve a list of datatables for the org. Returns a metadata list of the datatables associated with this org, including datatableId, name and description.","```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.ArchitectApi(); expand = 'expand_example' # str | Expand instructions for the result (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending') division_id = ['division_id_example'] # list[str] | division ID(s) (optional) name = 'exactMatch, beginsWith*, *endsWith, *contains*' # str | Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive. (optional) try: # Retrieve a list of datatables for the org api_response = api_instance.get_flows_datatables_divisionviews(expand=expand, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, division_id=division_id, name=name) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_datatables_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/datatables/divisionviews/{datatableId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns a specific datatable by id. Given a datatableId returns the datatable object and schema associated with it.,"```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable expand = 'expand_example' # str | Expand instructions for the result (optional) try: # Returns a specific datatable by id api_response = api_instance.get_flows_datatables_divisionview(datatable_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_datatables_divisionview: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/flows/datatables/{datatableId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: deletes a specific datatable by id. Deletes an entire datatable (including the schema and data) with a given datatableId,"```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable force = False # bool | force delete, even if in use (optional) (default to False) try: # deletes a specific datatable by id api_instance.delete_flows_datatable(datatable_id, force=force) except ApiException as e: print(""Exception when calling ArchitectApi->delete_flows_datatable: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns a specific datatable by id. Given a datatableId returns the datatable object and schema associated with it.,"```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable expand = 'expand_example' # str | Expand instructions for the result (optional) try: # Returns a specific datatable by id api_response = api_instance.get_flows_datatable(datatable_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_datatable: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/flows/datatables/{datatableId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Updates a specific datatable by id. Updates a schema for a datatable with the given datatableId -updates allow only new fields to be added in the schema, no changes or removals of existing fields.","```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable body = PureCloudPlatformClientV2.DataTable() # DataTable | datatable json-schema expand = 'expand_example' # str | Expand instructions for the result (optional) try: # Updates a specific datatable by id api_response = api_instance.put_flows_datatable(datatable_id, body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_flows_datatable: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/datatables/{datatableId}/export/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Begin an export process for exporting all rows from a datatable. Create an export job for exporting rows. The caller can then poll for status of the export using the token returned in the response,"```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable try: # Begin an export process for exporting all rows from a datatable api_response = api_instance.post_flows_datatable_export_jobs(datatable_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_datatable_export_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId}/export/jobs/{exportJobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns the state information about an export job. Returns the state information about an export 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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable export_job_id = 'export_job_id_example' # str | id of export job try: # Returns the state information about an export job api_response = api_instance.get_flows_datatable_export_job(datatable_id, export_job_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_datatable_export_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId}/import/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all recent import jobs. Get all recent import jobs,"```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get all recent import jobs api_response = api_instance.get_flows_datatable_import_jobs(datatable_id, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_datatable_import_jobs: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/datatables/{datatableId}/import/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Begin an import process for importing rows into a datatable. Create an import job for importing rows. The caller can then poll for status of the import using the token returned in the response,"```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable body = PureCloudPlatformClientV2.DataTableImportJob() # DataTableImportJob | import job information try: # Begin an import process for importing rows into a datatable api_response = api_instance.post_flows_datatable_import_jobs(datatable_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_datatable_import_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId}/import/jobs/{importJobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns the state information about an import job. Returns the state information about an import 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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable import_job_id = 'import_job_id_example' # str | id of import job try: # Returns the state information about an import job api_response = api_instance.get_flows_datatable_import_job(datatable_id, import_job_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_datatable_import_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId}/rows Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns the rows for the datatable with the given id. Returns all of the rows for the datatable with the given datatableId. By default this will just be a truncated list returning the key for each row. Set showBrief to false to return all of the row contents.,"```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) showbrief = True # bool | If true returns just the key value of the row (optional) (default to True) sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending') try: # Returns the rows for the datatable with the given id api_response = api_instance.get_flows_datatable_rows(datatable_id, page_number=page_number, page_size=page_size, showbrief=showbrief, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_datatable_rows: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/datatables/{datatableId}/rows Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Create a new row entry for the datatable. Will add the passed in row entry to the datatable with the given datatableId after verifying it against the schema. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { ""Field1"": ""XYZZY"", ""Field2"": false, ""KEY"": ""27272"" }","```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable data_table_row = NULL # object | try: # Create a new row entry for the datatable. api_response = api_instance.post_flows_datatable_rows(datatable_id, data_table_row) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_datatable_rows: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/flows/datatables/{datatableId}/rows/{rowId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a row entry. Deletes a row with a given rowId (the value of the key field).,"```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable row_id = 'row_id_example' # str | the key for the row try: # Delete a row entry api_instance.delete_flows_datatable_row(datatable_id, row_id) except ApiException as e: print(""Exception when calling ArchitectApi->delete_flows_datatable_row: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/datatables/{datatableId}/rows/{rowId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns a specific row for the datatable. Given a datatableId and a rowId (the value of the key field) this will return the full row contents for that rowId.,"```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable row_id = 'row_id_example' # str | The key for the row showbrief = True # bool | if true returns just the key field for the row (optional) (default to True) try: # Returns a specific row for the datatable api_response = api_instance.get_flows_datatable_row(datatable_id, row_id, showbrief=showbrief) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_datatable_row: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/flows/datatables/{datatableId}/rows/{rowId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Update a row entry. Updates a row with the given rowId (the value of the key field) to the new values. When building the request body within API Explorer, Pro mode should be used. The DataTableRow should be a json-ized' stream of key -> value pairs { ""Field1"": ""XYZZY"", ""Field2"": false, ""KEY"": ""27272"" }","```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.ArchitectApi(); datatable_id = 'datatable_id_example' # str | id of datatable row_id = 'row_id_example' # str | the key for the row body = NULL # object | datatable row (optional) try: # Update a row entry api_response = api_instance.put_flows_datatable_row(datatable_id, row_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_flows_datatable_row: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of basic flow information objects filterable by query parameters. This returns a simplified version of /flow consisting of name and type. If one or more IDs are specified, the search will fetch flows that match the given ID(s) and not use any additional supplied query parameters in the search.","```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.ArchitectApi(); type = ['type_example'] # list[str] | Type (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') id = ['id_example'] # list[str] | ID (optional) name = 'name_example' # str | Name (optional) publish_version_id = 'publish_version_id_example' # str | Publish version ID (optional) published_after = '2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01' # str | Published after (optional) published_before = '2015-01-01T12:00:00-0600, 2015-01-01T18:00:00Z, 2015-01-01T12:00:00.000-0600, 2015-01-01T18:00:00.000Z, 2015-01-01' # str | Published before (optional) division_id = ['division_id_example'] # list[str] | division ID(s) (optional) include_schemas = False # bool | Include variable schemas (optional) (default to False) try: # Get a pageable list of basic flow information objects filterable by query parameters. api_response = api_instance.get_flows_divisionviews(type=type, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, publish_version_id=publish_version_id, published_after=published_after, published_before=published_before, division_id=division_id, include_schemas=include_schemas) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_divisionviews: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/executions Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type. The launch is asynchronous, it returns as soon as the flow starts. You can use the returned ID to query its status if you need.","```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.ArchitectApi(); flow_launch_request = PureCloudPlatformClientV2.FlowExecutionLaunchRequest() # FlowExecutionLaunchRequest | try: # Launch an instance of a flow definition, for flow types that support it such as the 'workflow' type. api_response = api_instance.post_flows_executions(flow_launch_request) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_executions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/executions/{flowExecutionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a flow execution's details. Flow execution details are available for several days after the flow is started.,"```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.ArchitectApi(); flow_execution_id = 'flow_execution_id_example' # str | flow execution ID try: # Get a flow execution's details. Flow execution details are available for several days after the flow is started. api_response = api_instance.get_flows_execution(flow_execution_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_execution: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/instances/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Start a process (job) that will prepare a list of execution data IDs for download. Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.ExecutionDataRequest() # ExecutionDataRequest | Requested Flow Ids expand = 'expand_example' # str | Expand various query types. (optional) try: # Start a process (job) that will prepare a list of execution data IDs for download. api_response = api_instance.post_flows_instances_jobs(body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_instances_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/instances/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the status and/or results of an asynchronous flow execution data retrieval 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.ArchitectApi(); job_id = 'job_id_example' # str | The asynchronous job ID try: # Get the status and/or results of an asynchronous flow execution data retrieval job api_response = api_instance.get_flows_instances_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_instances_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/instances/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the database of existing flow histories to look for particular flow criteria. Returns a list of matching flow histories up to 200 max.,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.CriteriaQuery() # CriteriaQuery | query index_only = True # bool | indexes only (optional) page_size = 50 # int | number of results to return (optional) (default to 50) try: # Query the database of existing flow histories to look for particular flow criteria api_response = api_instance.post_flows_instances_query(body, index_only=index_only, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_instances_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/instances/querycapabilities Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a list of capabilities that the org can use to query for execution data. Returns the queryable parameters that can be used to build a query for execution data.,"```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.ArchitectApi(); expand = 'expand_example' # str | Expand various query types. (optional) try: # Retrieve a list of capabilities that the org can use to query for execution data api_response = api_instance.get_flows_instances_querycapabilities(expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_instances_querycapabilities: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/instances/settings/executiondata Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the execution history enabled setting. Get the execution history enabled setting.,"```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.ArchitectApi(); try: # Get the execution history enabled setting. api_response = api_instance.get_flows_instances_settings_executiondata() pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_instances_settings_executiondata: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/flows/instances/settings/executiondata Genesys Cloud Python SDK.,Genesys describes this as an API used to: Edit the execution history enabled setting. Edit the execution history enabled setting.,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.ExecutionDataSettingsRequest() # ExecutionDataSettingsRequest | New Execution Data Setting try: # Edit the execution history enabled setting. api_response = api_instance.patch_flows_instances_settings_executiondata(body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->patch_flows_instances_settings_executiondata: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/instances/settings/loglevels Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a list of LogLevels for the organization. Returns a paged set of LogLevels per flow 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.ArchitectApi(); expand = ['expand_example'] # list[str] | Expand instructions for the result (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Number of entities to return. Maximum of 200. (optional) (default to 25) try: # Retrieve a list of LogLevels for the organization. api_response = api_instance.get_flows_instances_settings_loglevels(expand=expand, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_instances_settings_loglevels: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/instances/settings/loglevels/characteristics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets the available flow log level characteristics for this organization. Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.,"```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.ArchitectApi(); try: # Gets the available flow log level characteristics for this organization. api_response = api_instance.get_flows_instances_settings_loglevels_characteristics() pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_instances_settings_loglevels_characteristics: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/flows/instances/settings/loglevels/default Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Resets the org log level to default, base. Resets the org log level to default, base","```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.ArchitectApi(); try: # Resets the org log level to default, base api_instance.delete_flows_instances_settings_loglevels_default() except ApiException as e: print(""Exception when calling ArchitectApi->delete_flows_instances_settings_loglevels_default: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/instances/settings/loglevels/default Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns the flow default log level. Returns the flow default log level which will be used if no specific flow id log level is found.,"```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.ArchitectApi(); expand = ['expand_example'] # list[str] | Expand instructions for the result (optional) try: # Returns the flow default log level. api_response = api_instance.get_flows_instances_settings_loglevels_default(expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_instances_settings_loglevels_default: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/flows/instances/settings/loglevels/default Genesys Cloud Python SDK.,Genesys describes this as an API used to: Edit the flow default log level. Edit the flow default log level.,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.FlowLogLevelRequest() # FlowLogLevelRequest | New LogLevel settings expand = ['expand_example'] # list[str] | Expand instructions for the result (optional) try: # Edit the flow default log level. api_response = api_instance.put_flows_instances_settings_loglevels_default(body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_flows_instances_settings_loglevels_default: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/instances/{instanceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Start a process (job) to prepare a download of a singular flow execution data instance by Id. Returns a JobResult object that contains an ID that can be used to check status and/or download links when the process (job) is complete.,"```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.ArchitectApi(); instance_id = 'instance_id_example' # str | Instance ID expand = 'expand_example' # str | Expand various details. (optional) try: # Start a process (job) to prepare a download of a singular flow execution data instance by Id api_response = api_instance.get_flows_instance(instance_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_instance: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/jobs Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the 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.ArchitectApi(); try: # Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job. api_response = api_instance.post_flows_jobs() pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch Architect Job Status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ArchitectApi(); job_id = 'job_id_example' # str | Job ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Fetch Architect Job Status api_response = api_instance.get_flows_job(job_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/milestones Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of flow milestones, filtered by query parameters. Multiple IDs can be specified, in which case all matching flow milestones will be returned, and no other parameters will be evaluated.","```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') id = ['id_example'] # list[str] | ID (optional) name = 'name_example' # str | Name (optional) description = 'description_example' # str | Description (optional) name_or_description = 'name_or_description_example' # str | Name or description (optional) division_id = ['division_id_example'] # list[str] | division ID(s) (optional) try: # Get a pageable list of flow milestones, filtered by query parameters api_response = api_instance.get_flows_milestones(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, description=description, name_or_description=name_or_description, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_milestones: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/milestones Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a flow milestone,"```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.ArchitectApi(); body = PureCloudPlatformClientV2.FlowMilestone() # FlowMilestone | (optional) try: # Create a flow milestone api_response = api_instance.post_flows_milestones(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_milestones: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/milestones/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of basic flow milestone information objects filterable by query parameters. This returns flow milestones consisting of name and division. If one or more IDs are specified, the search will fetch flow milestones that match the given ID(s) and not use any additional supplied query parameters in the search.","```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') id = ['id_example'] # list[str] | ID (optional) name = 'name_example' # str | Name (optional) division_id = ['division_id_example'] # list[str] | division ID(s) (optional) try: # Get a pageable list of basic flow milestone information objects filterable by query parameters. api_response = api_instance.get_flows_milestones_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_milestones_divisionviews: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/flows/milestones/{milestoneId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a flow milestone.,"```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.ArchitectApi(); milestone_id = 'milestone_id_example' # str | flow milestone ID try: # Delete a flow milestone. api_response = api_instance.delete_flows_milestone(milestone_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->delete_flows_milestone: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/milestones/{milestoneId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a flow milestone. Returns a specified flow milestone,"```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.ArchitectApi(); milestone_id = 'milestone_id_example' # str | flow milestone ID try: # Get a flow milestone api_response = api_instance.get_flows_milestone(milestone_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_milestone: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/flows/milestones/{milestoneId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a flow milestone,"```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.ArchitectApi(); milestone_id = 'milestone_id_example' # str | flow milestone ID body = PureCloudPlatformClientV2.FlowMilestone() # FlowMilestone | (optional) try: # Updates a flow milestone api_response = api_instance.put_flows_milestone(milestone_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_flows_milestone: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/outcomes Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of flow outcomes, filtered by query parameters. Multiple IDs can be specified, in which case all matching flow outcomes will be returned, and no other parameters will be evaluated.","```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') id = ['id_example'] # list[str] | ID (optional) name = 'name_example' # str | Name (optional) description = 'description_example' # str | Description (optional) name_or_description = 'name_or_description_example' # str | Name or description (optional) division_id = ['division_id_example'] # list[str] | division ID(s) (optional) try: # Get a pageable list of flow outcomes, filtered by query parameters api_response = api_instance.get_flows_outcomes(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, description=description, name_or_description=name_or_description, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_outcomes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/outcomes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a flow outcome. Asynchronous. Notification topic: v2.flows.outcomes.{flowOutcomeId},"```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.ArchitectApi(); body = PureCloudPlatformClientV2.FlowOutcome() # FlowOutcome | (optional) try: # Create a flow outcome api_response = api_instance.post_flows_outcomes(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flows_outcomes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/outcomes/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of basic flow outcome information objects filterable by query parameters. This returns flow outcomes consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.","```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.ArchitectApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''id'' # str | Sort by (optional) (default to 'id') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') id = ['id_example'] # list[str] | ID (optional) name = 'name_example' # str | Name (optional) division_id = ['division_id_example'] # list[str] | division ID(s) (optional) try: # Get a pageable list of basic flow outcome information objects filterable by query parameters. api_response = api_instance.get_flows_outcomes_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_outcomes_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/outcomes/{flowOutcomeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a flow outcome. Returns a specified flow outcome,"```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.ArchitectApi(); flow_outcome_id = 'flow_outcome_id_example' # str | flow outcome ID try: # Get a flow outcome api_response = api_instance.get_flows_outcome(flow_outcome_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flows_outcome: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/flows/outcomes/{flowOutcomeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a flow outcome. Updates a flow outcome. Asynchronous. Notification topic: v2.flowoutcomes.{flowoutcomeId},"```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.ArchitectApi(); flow_outcome_id = 'flow_outcome_id_example' # str | flow outcome ID body = PureCloudPlatformClientV2.FlowOutcome() # FlowOutcome | (optional) try: # Updates a flow outcome api_response = api_instance.put_flows_outcome(flow_outcome_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_flows_outcome: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/flows/{flowId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete flow,"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID try: # Delete flow api_instance.delete_flow(flow_id) except ApiException as e: print(""Exception when calling ArchitectApi->delete_flow: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/{flowId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get flow,"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID deleted = False # bool | Deleted flows (optional) (default to False) try: # Get flow api_response = api_instance.get_flow(flow_id, deleted=deleted) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flow: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/flows/{flowId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update flow,"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID body = PureCloudPlatformClientV2.Flow() # Flow | try: # Update flow api_response = api_instance.put_flow(flow_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_flow: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/{flowId}/history Genesys Cloud Python SDK.,Genesys describes this as an API used to: Generate flow history. Asynchronous. Notification topic: v2.flows.{flowId},"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID try: # Generate flow history api_response = api_instance.post_flow_history(flow_id) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flow_history: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/{flowId}/history/{historyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get generated flow history,"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID history_id = 'history_id_example' # str | History request ID page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_order = ''desc'' # str | Sort order (optional) (default to 'desc') sort_by = ''timestamp'' # str | Sort by (optional) (default to 'timestamp') action = ['action_example'] # list[str] | Flow actions to include (omit to include all) (optional) try: # Get generated flow history api_response = api_instance.get_flow_history_history_id(flow_id, history_id, page_number=page_number, page_size=page_size, sort_order=sort_order, sort_by=sort_by, action=action) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flow_history_history_id: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/flows/{flowId}/instances/settings/loglevels Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a log level for a flow by flow id. Deletes the associated log level for a flow by flow 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.ArchitectApi(); flow_id = 'flow_id_example' # str | The flow id to delete the loglevel for try: # Deletes a log level for a flow by flow id. api_instance.delete_flow_instances_settings_loglevels(flow_id) except ApiException as e: print(""Exception when calling ArchitectApi->delete_flow_instances_settings_loglevels: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/{flowId}/instances/settings/loglevels Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves the log level for a flow by flow id. Retrieves the log level for a flow by flow 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.ArchitectApi(); flow_id = 'flow_id_example' # str | The flow id to get the loglevel for expand = ['expand_example'] # list[str] | Expand instructions for the result (optional) try: # Retrieves the log level for a flow by flow id. api_response = api_instance.get_flow_instances_settings_loglevels(flow_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flow_instances_settings_loglevels: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/{flowId}/instances/settings/loglevels Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set the logLevel for a particular flow id. Assigns a new loglevel to a flow 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.ArchitectApi(); flow_id = 'flow_id_example' # str | The flow id to set the loglevel for body = PureCloudPlatformClientV2.FlowLogLevelRequest() # FlowLogLevelRequest | New LogLevel settings expand = ['expand_example'] # list[str] | Expand instructions for the result (optional) try: # Set the logLevel for a particular flow id api_response = api_instance.post_flow_instances_settings_loglevels(flow_id, body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flow_instances_settings_loglevels: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/flows/{flowId}/instances/settings/loglevels Genesys Cloud Python SDK.,Genesys describes this as an API used to: Edit the logLevel for a particular flow id. Updates the loglevel for a flow 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.ArchitectApi(); flow_id = 'flow_id_example' # str | The flow id to edit the loglevel for body = PureCloudPlatformClientV2.FlowLogLevelRequest() # FlowLogLevelRequest | New LogLevel settings expand = ['expand_example'] # list[str] | Expand instructions for the result (optional) try: # Edit the logLevel for a particular flow id api_response = api_instance.put_flow_instances_settings_loglevels(flow_id, body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->put_flow_instances_settings_loglevels: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/{flowId}/latestconfiguration Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the latest configuration for flow,"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID deleted = False # bool | Deleted flows (optional) (default to False) try: # Get the latest configuration for flow api_response = api_instance.get_flow_latestconfiguration(flow_id, deleted=deleted) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flow_latestconfiguration: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/{flowId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get flow version list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) deleted = True # bool | Include Deleted flows (optional) try: # Get flow version list api_response = api_instance.get_flow_versions(flow_id, page_number=page_number, page_size=page_size, deleted=deleted) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flow_versions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/flows/{flowId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create flow version,"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID body = NULL # object | try: # Create flow version api_response = api_instance.post_flow_versions(flow_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->post_flow_versions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/{flowId}/versions/{versionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get flow version,"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID version_id = 'version_id_example' # str | Version ID deleted = 'deleted_example' # str | Deleted flows (optional) try: # Get flow version api_response = api_instance.get_flow_version(flow_id, version_id, deleted=deleted) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flow_version: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/{flowId}/versions/{versionId}/configuration Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create flow version 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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID version_id = 'version_id_example' # str | Version ID deleted = 'deleted_example' # str | Deleted flows (optional) try: # Create flow version configuration api_response = api_instance.get_flow_version_configuration(flow_id, version_id, deleted=deleted) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flow_version_configuration: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/{flowId}/versions/{versionId}/health Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.,"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID. version_id = 'version_id_example' # str | Version ID. language = 'language_example' # str | Language to filter for (optional) try: # Get overall health scores for all intents present in the NLU domain version associated with the bot flow version. api_response = api_instance.get_flow_version_health(flow_id, version_id, language=language) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flow_version_health: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.,"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID. version_id = 'version_id_example' # str | Version ID. intent_id = 'intent_id_example' # str | Intent ID. language = 'language_example' # str | Language to filter for try: # Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent. api_response = api_instance.get_flow_version_intent_health(flow_id, version_id, intent_id, language) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flow_version_intent_health: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get health metrics associated with a specific utterance of an intent.,"```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.ArchitectApi(); flow_id = 'flow_id_example' # str | Flow ID. version_id = 'version_id_example' # str | Version ID. intent_id = 'intent_id_example' # str | Intent ID. utterance_id = 'utterance_id_example' # str | Utterance ID. language = 'language_example' # str | Language to filter for try: # Get health metrics associated with a specific utterance of an intent. api_response = api_instance.get_flow_version_intent_utterance_health(flow_id, version_id, intent_id, utterance_id, language) pprint(api_response) except ApiException as e: print(""Exception when calling ArchitectApi->get_flow_version_intent_utterance_health: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/audits/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create audit query execution. Use /api/v2/audits/query/servicemapping endpoint for a list of valid values,"```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.AuditApi(); body = PureCloudPlatformClientV2.AuditQueryRequest() # AuditQueryRequest | query try: # Create audit query execution api_response = api_instance.post_audits_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling AuditApi->post_audits_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/audits/query/realtime Genesys Cloud Python SDK.,Genesys describes this as an API used to: This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits. Use /api/v2/audits/query/realtime/servicemapping endpoint for a list of valid values,"```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.AuditApi(); body = PureCloudPlatformClientV2.AuditRealtimeQueryRequest() # AuditRealtimeQueryRequest | query expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) try: # This endpoint will only retrieve 14 days worth of audits for certain services. Please use /query to get a full list and older audits. api_response = api_instance.post_audits_query_realtime(body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling AuditApi->post_audits_query_realtime: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/audits/query/realtime/related Genesys Cloud Python SDK.,Genesys describes this as an API used to: Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit 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.AuditApi(); body = PureCloudPlatformClientV2.AuditRealtimeRelatedRequest() # AuditRealtimeRelatedRequest | query expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) try: # Often a single action results in multiple audits. The endpoint retrieves all audits created by the same action as the given audit id. api_response = api_instance.post_audits_query_realtime_related(body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling AuditApi->post_audits_query_realtime_related: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/audits/query/realtime/servicemapping Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get service mapping information used in realtime audits.,"```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.AuditApi(); try: # Get service mapping information used in realtime audits. api_response = api_instance.get_audits_query_realtime_servicemapping() pprint(api_response) except ApiException as e: print(""Exception when calling AuditApi->get_audits_query_realtime_servicemapping: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/audits/query/servicemapping Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get service mapping information used in audits.,"```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.AuditApi(); try: # Get service mapping information used in audits. api_response = api_instance.get_audits_query_servicemapping() pprint(api_response) except ApiException as e: print(""Exception when calling AuditApi->get_audits_query_servicemapping: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/audits/query/{transactionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get status of audit query execution,"```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.AuditApi(); transaction_id = 'transaction_id_example' # str | Transaction ID try: # Get status of audit query execution api_response = api_instance.get_audits_query_transaction_id(transaction_id) pprint(api_response) except ApiException as e: print(""Exception when calling AuditApi->get_audits_query_transaction_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/audits/query/{transactionId}/results Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get results of audit query,"```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.AuditApi(); transaction_id = 'transaction_id_example' # str | Transaction ID cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional) page_size = 25 # int | Indicates maximum number of results in response. Default page size is 25 results. The maximum page size is 500. (optional) (default to 25) expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) allow_redirect = True # bool | Result sets with large amounts of data will respond with a download url (optional) try: # Get results of audit query api_response = api_instance.get_audits_query_transaction_id_results(transaction_id, cursor=cursor, page_size=page_size, expand=expand, allow_redirect=allow_redirect) pprint(api_response) except ApiException as e: print(""Exception when calling AuditApi->get_audits_query_transaction_id_results: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisions Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Retrieve a list of all divisions defined for the organization. Request specific divisions by id using a query param ""id"", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3","```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.ObjectsApi(); 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) object_count = False # bool | Include the count of objects contained in the division (optional) (default to False) id = ['id_example'] # list[str] | Optionally request specific divisions by their IDs (optional) name = 'name_example' # str | Search term to filter by division name (optional) try: # Retrieve a list of all divisions defined for the organization api_response = api_instance.get_authorization_divisions(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, object_count=object_count, id=id, name=name) pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->get_authorization_divisions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/divisions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a division.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ObjectsApi(); body = PureCloudPlatformClientV2.AuthzDivision() # AuthzDivision | Division try: # Create a division. api_response = api_instance.post_authorization_divisions(body) pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->post_authorization_divisions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisions/home Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve the home division for the organization. Will not include object counts.,"```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.ObjectsApi(); try: # Retrieve the home division for the organization. api_response = api_instance.get_authorization_divisions_home() pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->get_authorization_divisions_home: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisions/limit Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns the maximum allowed number of divisions.,"```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.ObjectsApi(); try: # Returns the maximum allowed number of divisions. api_response = api_instance.get_authorization_divisions_limit() pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->get_authorization_divisions_limit: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/authorization/divisions/{divisionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a division.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ObjectsApi(); division_id = 'division_id_example' # str | Division ID force = False # bool | Force delete this division as well as the grants and objects associated with it (optional) (default to False) try: # Delete a division. api_instance.delete_authorization_division(division_id, force=force) except ApiException as e: print(""Exception when calling ObjectsApi->delete_authorization_division: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisions/{divisionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns an authorization division.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ObjectsApi(); division_id = 'division_id_example' # str | Division ID object_count = False # bool | Get count of objects in this division, grouped by type (optional) (default to False) try: # Returns an authorization division. api_response = api_instance.get_authorization_division(division_id, object_count=object_count) pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->get_authorization_division: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/authorization/divisions/{divisionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a division.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ObjectsApi(); division_id = 'division_id_example' # str | Division ID body = PureCloudPlatformClientV2.AuthzDivision() # AuthzDivision | Updated division data try: # Update a division. api_response = api_instance.put_authorization_division(division_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->put_authorization_division: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisions/{divisionId}/grants Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets all grants for a given division. Returns all grants assigned to a given division. Maximum page size is 500.,"```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.AuthorizationApi(); division_id = 'division_id_example' # str | Division ID page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Gets all grants for a given division. api_response = api_instance.get_authorization_division_grants(division_id, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->get_authorization_division_grants: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Assign a list of objects to a division. Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [""206ce31f-61ec-40ed-a8b1-be6f06303998"",""250a754e-f5e4-4f51-800f-a92f09d3bf8c""]","```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.ObjectsApi(); division_id = 'division_id_example' # str | Division ID object_type = 'object_type_example' # str | The type of the objects. Must be one of the valid object types body = ['body_example'] # list[str] | Object Id List try: # Assign a list of objects to a division api_instance.post_authorization_division_object(division_id, object_type, body) except ApiException as e: print(""Exception when calling ObjectsApi->post_authorization_division_object: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/divisions/{divisionId}/restore Genesys Cloud Python SDK.,Genesys describes this as an API used to: Recreate a previously deleted division.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ObjectsApi(); division_id = 'division_id_example' # str | Division ID body = PureCloudPlatformClientV2.AuthzDivision() # AuthzDivision | Recreated division data (optional) try: # Recreate a previously deleted division. api_response = api_instance.post_authorization_division_restore(division_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->post_authorization_division_restore: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisionspermitted/paged/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns which divisions the current user has the given permission in.,"```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.UsersApi(); permission = 'permission_example' # str | The permission string, including the object to access, e.g. routing:queue:view page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Returns which divisions the current user has the given permission in. api_response = api_instance.get_authorization_divisionspermitted_paged_me(permission, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_authorization_divisionspermitted_paged_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/permissions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all permissions. Retrieve a list of all permission defined in the system.,"```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.AuthorizationApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) query_type = 'query_type_example' # str | Query filter type (optional) query = 'query_example' # str | Comma-separated list of permissions or domains to query (optional) try: # Get all permissions. api_response = api_instance.get_authorization_permissions(page_size=page_size, page_number=page_number, query_type=query_type, query=query) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->get_authorization_permissions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/products Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the list of enabled products. Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.","```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.AuthorizationApi(); try: # Get the list of enabled products api_response = api_instance.get_authorization_products() pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->get_authorization_products: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a list of all roles defined for the organization,"```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.AuthorizationApi(); 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) name = 'name_example' # str | (optional) permission = ['permission_example'] # list[str] | (optional) default_role_id = ['default_role_id_example'] # list[str] | (optional) user_count = True # bool | (optional) (default to True) id = ['id_example'] # list[str] | id (optional) try: # Retrieve a list of all roles defined for the organization api_response = api_instance.get_authorization_roles(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, name=name, permission=permission, default_role_id=default_role_id, user_count=user_count, id=id) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->get_authorization_roles: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an organization role.,"```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.AuthorizationApi(); body = PureCloudPlatformClientV2.DomainOrganizationRoleCreate() # DomainOrganizationRoleCreate | Organization role try: # Create an organization role. api_response = api_instance.post_authorization_roles(body) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->post_authorization_roles: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/roles/default Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Restores all default roles. This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.","```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.AuthorizationApi(); force = False # bool | Restore default roles (optional) (default to False) try: # Restores all default roles api_response = api_instance.post_authorization_roles_default(force=force) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->post_authorization_roles_default: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/authorization/roles/default Genesys Cloud Python SDK.,Genesys describes this as an API used to: Restore specified default roles,"```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.AuthorizationApi(); body = [PureCloudPlatformClientV2.DomainOrganizationRole()] # list[DomainOrganizationRole] | Organization roles list try: # Restore specified default roles api_response = api_instance.put_authorization_roles_default(body) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->put_authorization_roles_default: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/roles/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get authorization role settings,"```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.AuthorizationApi(); try: # Get authorization role settings api_response = api_instance.get_authorization_roles_settings() pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->get_authorization_roles_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/authorization/roles/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Change authorization role settings. Change role settings,"```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.AuthorizationApi(); body = PureCloudPlatformClientV2.RoleSettings() # RoleSettings | Authorization Role Settings try: # Change authorization role settings api_response = api_instance.put_authorization_roles_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->put_authorization_roles_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an org role to default role comparison. Compares any organization role to a default role id and show differences,"```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.AuthorizationApi(); left_role_id = 'left_role_id_example' # str | Left Role ID right_role_id = 'right_role_id_example' # str | Right Role id try: # Get an org role to default role comparison api_response = api_instance.get_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->get_authorization_role_comparedefault_right_role_id: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/roles/{leftRoleId}/comparedefault/{rightRoleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an unsaved org role to default role comparison. Allows users to compare their existing roles in an unsaved state to its default role,"```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.AuthorizationApi(); left_role_id = 'left_role_id_example' # str | Left Role ID right_role_id = 'right_role_id_example' # str | Right Role id body = PureCloudPlatformClientV2.DomainOrganizationRole() # DomainOrganizationRole | Organization role try: # Get an unsaved org role to default role comparison api_response = api_instance.post_authorization_role_comparedefault_right_role_id(left_role_id, right_role_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->post_authorization_role_comparedefault_right_role_id: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/authorization/roles/{roleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an organization role.,"```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.AuthorizationApi(); role_id = 'role_id_example' # str | Role ID try: # Delete an organization role. api_instance.delete_authorization_role(role_id) except ApiException as e: print(""Exception when calling AuthorizationApi->delete_authorization_role: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/roles/{roleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a single organization role. Get the organization role specified by its 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.AuthorizationApi(); role_id = 'role_id_example' # str | Role ID user_count = True # bool | Fetch the count of users who have this role granted in at least one division. Setting this value or defaulting to 'true' can lead to slower load times or timeouts for role queries with large member counts. (optional) (default to True) expand = ['expand_example'] # list[str] | Which fields, if any, to expand. \""unusedPermissions\"" returns the permissions not used for the role (optional) try: # Get a single organization role. api_response = api_instance.get_authorization_role(role_id, user_count=user_count, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->get_authorization_role: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/authorization/roles/{roleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch Organization Role for needsUpdate Field. Patch Organization Role for needsUpdate Field,"```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.AuthorizationApi(); role_id = 'role_id_example' # str | Role ID body = PureCloudPlatformClientV2.DomainOrganizationRole() # DomainOrganizationRole | Organization role try: # Patch Organization Role for needsUpdate Field api_response = api_instance.patch_authorization_role(role_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->patch_authorization_role: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/roles/{roleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk-grant subjects and divisions with an organization role.,"```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.AuthorizationApi(); role_id = 'role_id_example' # str | Role ID body = PureCloudPlatformClientV2.SubjectDivisions() # SubjectDivisions | Subjects and Divisions subject_type = ''PC_USER'' # str | what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional) (default to 'PC_USER') try: # Bulk-grant subjects and divisions with an organization role. api_instance.post_authorization_role(role_id, body, subject_type=subject_type) except ApiException as e: print(""Exception when calling AuthorizationApi->post_authorization_role: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/authorization/roles/{roleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an organization role. Update,"```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.AuthorizationApi(); role_id = 'role_id_example' # str | Role ID body = PureCloudPlatformClientV2.DomainOrganizationRoleUpdate() # DomainOrganizationRoleUpdate | Organization role try: # Update an organization role. api_response = api_instance.put_authorization_role(role_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->put_authorization_role: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/roles/{roleId}/subjectgrants Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the subjects' granted divisions in the specified role. Includes the divisions for which the subject has a grant.,"```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.AuthorizationApi(); role_id = 'role_id_example' # str | Role 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 the subjects' granted divisions in the specified role. api_response = api_instance.get_authorization_role_subjectgrants(role_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 AuthorizationApi->get_authorization_role_subjectgrants: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/roles/{roleId}/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of the users in a specified role. Get an array of the UUIDs of the users in the specified role.,"```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.AuthorizationApi(); role_id = 'role_id_example' # str | Role ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of the users in a specified role. api_response = api_instance.get_authorization_role_users(role_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->get_authorization_role_users: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/authorization/roles/{roleId}/users/add Genesys Cloud Python SDK.,Genesys describes this as an API used to: Sets the users for the role,"```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.AuthorizationApi(); role_id = 'role_id_example' # str | Role ID body = ['body_example'] # list[str] | List of user IDs try: # Sets the users for the role api_response = api_instance.put_authorization_role_users_add(role_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->put_authorization_role_users_add: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/authorization/roles/{roleId}/users/remove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Removes the users from the role,"```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.AuthorizationApi(); role_id = 'role_id_example' # str | Role ID body = ['body_example'] # list[str] | List of user IDs try: # Removes the users from the role api_response = api_instance.put_authorization_role_users_remove(role_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->put_authorization_role_users_remove: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get authorization settings,"```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.AuthorizationApi(); try: # Get authorization settings api_response = api_instance.get_authorization_settings() pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->get_authorization_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/authorization/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Change authorization settings. Change authorization settings,"```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.AuthorizationApi(); body = PureCloudPlatformClientV2.AuthorizationSettings() # AuthorizationSettings | Authorization Settings try: # Change authorization settings api_response = api_instance.patch_authorization_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->patch_authorization_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/subjects/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns a listing of roles and permissions for the currently authenticated 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.UsersApi(); include_duplicates = False # bool | Include multiple entries with the same role and division but different subjects (optional) (default to False) try: # Returns a listing of roles and permissions for the currently authenticated user. api_response = api_instance.get_authorization_subjects_me(include_duplicates=include_duplicates) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_authorization_subjects_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/subjects/rolecounts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the count of roles granted to a list of subjects,"```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.AuthorizationApi(); id = ['id_example'] # list[str] | id (optional) try: # Get the count of roles granted to a list of subjects api_response = api_instance.get_authorization_subjects_rolecounts(id=id) pprint(api_response) except ApiException as e: print(""Exception when calling AuthorizationApi->get_authorization_subjects_rolecounts: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/subjects/{subjectId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns a listing of roles and permissions for a 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.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) include_duplicates = False # bool | Include multiple entries with the same role and division but different subjects (optional) (default to False) try: # Returns a listing of roles and permissions for a user. api_response = api_instance.get_authorization_subject(subject_id, include_duplicates=include_duplicates) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_authorization_subject: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/subjects/{subjectId}/bulkadd Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk-grant roles and divisions to a subject.,"```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.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) body = PureCloudPlatformClientV2.RoleDivisionGrants() # RoleDivisionGrants | Pairs of role and division IDs subject_type = ''PC_USER'' # str | what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional) (default to 'PC_USER') try: # Bulk-grant roles and divisions to a subject. api_instance.post_authorization_subject_bulkadd(subject_id, body, subject_type=subject_type) except ApiException as e: print(""Exception when calling UsersApi->post_authorization_subject_bulkadd: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/subjects/{subjectId}/bulkremove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk-remove grants from a subject.,"```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.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) body = PureCloudPlatformClientV2.RoleDivisionGrants() # RoleDivisionGrants | Pairs of role and division IDs try: # Bulk-remove grants from a subject. api_instance.post_authorization_subject_bulkremove(subject_id, body) except ApiException as e: print(""Exception when calling UsersApi->post_authorization_subject_bulkremove: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/subjects/{subjectId}/bulkreplace Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace subject's roles and divisions with the exact list supplied in the request. This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.,"```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.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) body = PureCloudPlatformClientV2.RoleDivisionGrants() # RoleDivisionGrants | Pairs of role and division IDs subject_type = ''PC_USER'' # str | what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional) (default to 'PC_USER') try: # Replace subject's roles and divisions with the exact list supplied in the request. api_instance.post_authorization_subject_bulkreplace(subject_id, body, subject_type=subject_type) except ApiException as e: print(""Exception when calling UsersApi->post_authorization_subject_bulkreplace: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a grant of a role in a division,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) division_id = 'division_id_example' # str | the id of the division of the grant role_id = 'role_id_example' # str | the id of the role of the grant try: # Delete a grant of a role in a division api_instance.delete_authorization_subject_division_role(subject_id, division_id, role_id) except ApiException as e: print(""Exception when calling UsersApi->delete_authorization_subject_division_role: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Make a grant of a role in a division,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) division_id = 'division_id_example' # str | the id of the division to which to make the grant role_id = 'role_id_example' # str | the id of the role to grant subject_type = ''PC_USER'' # str | what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) (optional) (default to 'PC_USER') try: # Make a grant of a role in a division api_instance.post_authorization_subject_division_role(subject_id, division_id, role_id, subject_type=subject_type) except ApiException as e: print(""Exception when calling UsersApi->post_authorization_subject_division_role: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{subjectId}/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns a listing of roles and permissions for a 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.UsersApi(); subject_id = 'subject_id_example' # str | User ID try: # Returns a listing of roles and permissions for a user. api_response = api_instance.get_user_roles(subject_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_roles: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{subjectId}/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Sets the user's roles,"```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.UsersApi(); subject_id = 'subject_id_example' # str | User ID body = ['body_example'] # list[str] | List of roles try: # Sets the user's roles api_response = api_instance.put_user_roles(subject_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_roles: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/billing/reports/billableusage Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a report of the billable license usages. Report is of the billable usages (e.g. licenses and devices utilized) for a given period. If response's status is InProgress, wait a few seconds, then try the same request again.","```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.BillingApi(); start_date = '2013-10-20T19:20:30+01:00' # datetime | The period start date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z end_date = '2013-10-20T19:20:30+01:00' # datetime | The period end date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z try: # Get a report of the billable license usages api_response = api_instance.get_billing_reports_billableusage(start_date, end_date) pprint(api_response) except ApiException as e: print(""Exception when calling BillingApi->get_billing_reports_billableusage: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/billing/trusteebillingoverview/{trustorOrgId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the billing overview for an organization that is managed by a partner. Tax Disclaimer: Prices returned by this API do not include applicable taxes. It is the responsibility of the customer to pay all taxes that are appropriate in their jurisdiction. See the PureCloud API Documentation in the Developer Center for more information about this API: https://developer.mypurecloud.com/api/rest/v2/,"```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.BillingApi(); trustor_org_id = 'trustor_org_id_example' # str | The organization ID of the trustor (customer) organization. billing_period_index = 0 # int | 0 for active period (overview data may change until period closes). 1 for prior completed billing period. 2 for two billing cycles prior, and so on. (optional) (default to 0) try: # Get the billing overview for an organization that is managed by a partner. api_response = api_instance.get_billing_trusteebillingoverview_trustor_org_id(trustor_org_id, billing_period_index=billing_period_index) pprint(api_response) except ApiException as e: print(""Exception when calling BillingApi->get_billing_trusteebillingoverview_trustor_org_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/carrierservices/integrations/emergencylocations/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get location 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.CarrierServicesApi(); phone_number = 'phone_number_example' # str | Phone number in E164 format try: # Get location for the logged in user api_response = api_instance.get_carrierservices_integrations_emergencylocations_me(phone_number) pprint(api_response) except ApiException as e: print(""Exception when calling CarrierServicesApi->get_carrierservices_integrations_emergencylocations_me: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/carrierservices/integrations/emergencylocations/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set current location 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.CarrierServicesApi(); body = PureCloudPlatformClientV2.EmergencyLocation() # EmergencyLocation | (optional) try: # Set current location for the logged in user api_response = api_instance.post_carrierservices_integrations_emergencylocations_me(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling CarrierServicesApi->post_carrierservices_integrations_emergencylocations_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/chats/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a message,"```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.ChatApi(); message_id = 'message_id_example' # str | messageId try: # Get a message api_response = api_instance.get_chats_message(message_id) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->get_chats_message: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/chats/messages/{messageId}/reactions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update reactions to a message,"```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.ChatApi(); message_id = 'message_id_example' # str | messageId body = PureCloudPlatformClientV2.ChatReactionUpdate() # ChatReactionUpdate | reactionUpdate try: # Update reactions to a message api_instance.put_chats_message_reactions(message_id, body) except ApiException as e: print(""Exception when calling ChatApi->put_chats_message_reactions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/chats/rooms Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an adhoc room,"```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.ChatApi(); body = PureCloudPlatformClientV2.CreateRoomRequest() # CreateRoomRequest | Room properties try: # Create an adhoc room api_response = api_instance.post_chats_rooms(body) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->post_chats_rooms: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/chats/rooms/{roomJid} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a room,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomJid try: # Get a room api_response = api_instance.get_chats_room(room_jid) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->get_chats_room: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/chats/rooms/{roomJid} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set properties for a room,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomJid body = PureCloudPlatformClientV2.RoomUpdateRequest() # RoomUpdateRequest | Room properties try: # Set properties for a room api_instance.patch_chats_room(room_jid, body) except ApiException as e: print(""Exception when calling ChatApi->patch_chats_room: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/chats/rooms/{roomJid}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a room's message history,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomJid limit = 'limit_example' # str | The maximum number of messages to retrieve (optional) before = 'before_example' # str | The cutoff date for messages to retrieve (optional) after = 'after_example' # str | The beginning date for messages to retrieve (optional) try: # Get a room's message history api_response = api_instance.get_chats_room_messages(room_jid, limit=limit, before=before, after=after) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->get_chats_room_messages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/chats/rooms/{roomJid}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send a message to a room,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomId body = PureCloudPlatformClientV2.SendMessageBody() # SendMessageBody | messageBody try: # Send a message to a room api_response = api_instance.post_chats_room_messages(room_jid, body) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->post_chats_room_messages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/chats/rooms/{roomJid}/messages/pins Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Add pinned messages for a room, up to a maximum of 5 pinned 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.ChatApi(); room_jid = 'room_jid_example' # str | roomJid body = PureCloudPlatformClientV2.PinnedMessageRequest() # PinnedMessageRequest | Pinned Message Ids try: # Add pinned messages for a room, up to a maximum of 5 pinned messages api_instance.post_chats_room_messages_pins(room_jid, body) except ApiException as e: print(""Exception when calling ChatApi->post_chats_room_messages_pins: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/chats/rooms/{roomJid}/messages/pins/{pinnedMessageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove a pinned message from a room,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomJid pinned_message_id = 'pinned_message_id_example' # str | pinnedMessageId try: # Remove a pinned message from a room api_instance.delete_chats_room_messages_pin(room_jid, pinned_message_id) except ApiException as e: print(""Exception when calling ChatApi->delete_chats_room_messages_pin: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/chats/rooms/{roomJid}/messages/{messageIds} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get messages by id(s) from a room,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomJid message_ids = 'message_ids_example' # str | messageIds, comma separated try: # Get messages by id(s) from a room api_response = api_instance.get_chats_room_message(room_jid, message_ids) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->get_chats_room_message: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/chats/rooms/{roomJid}/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a message in a room,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomId message_id = 'message_id_example' # str | messageId try: # Delete a message in a room api_instance.delete_chats_room_message(room_jid, message_id) except ApiException as e: print(""Exception when calling ChatApi->delete_chats_room_message: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/chats/rooms/{roomJid}/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Edit a message in a room,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomId message_id = 'message_id_example' # str | messageId body = PureCloudPlatformClientV2.SendMessageBody() # SendMessageBody | messageBody try: # Edit a message in a room api_response = api_instance.patch_chats_room_message(room_jid, message_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->patch_chats_room_message: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/chats/rooms/{roomJid}/participants Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get room participants in a room,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomJid try: # Get room participants in a room api_response = api_instance.get_chats_room_participants(room_jid) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->get_chats_room_participants: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/chats/rooms/{roomJid}/participants/{participantJid} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a room participant,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomJid participant_jid = 'participant_jid_example' # str | participantJid try: # Get a room participant api_response = api_instance.get_chats_room_participant(room_jid, participant_jid) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->get_chats_room_participant: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/chats/rooms/{roomJid}/participants/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove a user from a room.,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomJid user_id = 'user_id_example' # str | userId try: # Remove a user from a room. api_instance.delete_chats_room_participant(room_jid, user_id) except ApiException as e: print(""Exception when calling ChatApi->delete_chats_room_participant: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/chats/rooms/{roomJid}/participants/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Join a room,"```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.ChatApi(); room_jid = 'room_jid_example' # str | roomJid user_id = 'user_id_example' # str | userId try: # Join a room api_instance.post_chats_room_participant(room_jid, user_id) except ApiException as e: print(""Exception when calling ChatApi->post_chats_room_participant: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/chats/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Chat Settings.,"```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.ChatApi(); try: # Get Chat Settings. api_response = api_instance.get_chats_settings() pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->get_chats_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/chats/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch Chat Settings.,"```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.ChatApi(); body = PureCloudPlatformClientV2.ChatSettings() # ChatSettings | Chat try: # Patch Chat Settings. api_response = api_instance.patch_chats_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->patch_chats_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/chats/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Chat Settings.,"```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.ChatApi(); body = PureCloudPlatformClientV2.ChatSettings() # ChatSettings | Chat try: # Update Chat Settings. api_response = api_instance.put_chats_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->put_chats_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/chats/threads/{threadId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get history by thread,"```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.ChatApi(); thread_id = 'thread_id_example' # str | threadId limit = 'limit_example' # str | The maximum number of messages to retrieve (optional) before = 'before_example' # str | The cutoff date for messages to retrieve (optional) after = 'after_example' # str | The beginning date for messages to retrieve (optional) try: # Get history by thread api_response = api_instance.get_chats_thread_messages(thread_id, limit=limit, before=before, after=after) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->get_chats_thread_messages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/chats/users/{userId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get 1on1 History between a 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.ChatApi(); user_id = 'user_id_example' # str | userId limit = 'limit_example' # str | The maximum number of messages to retrieve (optional) before = 'before_example' # str | The cutoff date for messages to retrieve (optional) after = 'after_example' # str | The beginning date for messages to retrieve (optional) try: # Get 1on1 History between a user api_response = api_instance.get_chats_user_messages(user_id, limit=limit, before=before, after=after) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->get_chats_user_messages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/chats/users/{userId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send a message to a 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.ChatApi(); user_id = 'user_id_example' # str | userId body = PureCloudPlatformClientV2.SendMessageBody() # SendMessageBody | message body try: # Send a message to a user api_response = api_instance.post_chats_user_messages(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->post_chats_user_messages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/chats/users/{userId}/messages/{messageIds} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get messages by id(s) from a 1on1,"```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.ChatApi(); user_id = 'user_id_example' # str | userId message_ids = 'message_ids_example' # str | messageIds, comma separated try: # Get messages by id(s) from a 1on1 api_response = api_instance.get_chats_user_message(user_id, message_ids) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->get_chats_user_message: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/chats/users/{userId}/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a message to a 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.ChatApi(); user_id = 'user_id_example' # str | userId message_id = 'message_id_example' # str | messageId try: # Delete a message to a user api_instance.delete_chats_user_message(user_id, message_id) except ApiException as e: print(""Exception when calling ChatApi->delete_chats_user_message: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/chats/users/{userId}/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Edit a message to a 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.ChatApi(); user_id = 'user_id_example' # str | userId message_id = 'message_id_example' # str | messageId body = PureCloudPlatformClientV2.SendMessageBody() # SendMessageBody | message body try: # Edit a message to a user api_response = api_instance.patch_chats_user_message(user_id, message_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ChatApi->patch_chats_user_message: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/coaching/appointments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get appointments for users and optional date range,"```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.CoachingApi(); user_ids = ['user_ids_example'] # list[str] | The user IDs for which to retrieve appointments interval = 'interval_example' # str | Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) statuses = ['statuses_example'] # list[str] | Appointment Statuses to filter by (optional) facilitator_ids = ['facilitator_ids_example'] # list[str] | The facilitator IDs for which to retrieve appointments (optional) sort_order = 'sort_order_example' # str | Sort (by due date) either Asc or Desc (optional) relationships = ['relationships_example'] # list[str] | Relationships to filter by (optional) completion_interval = 'completion_interval_example' # str | Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) overdue = 'overdue_example' # str | Overdue status to filter by (optional) interval_condition = 'interval_condition_example' # str | Filter condition for interval (optional) try: # Get appointments for users and optional date range api_response = api_instance.get_coaching_appointments(user_ids, interval=interval, page_number=page_number, page_size=page_size, statuses=statuses, facilitator_ids=facilitator_ids, sort_order=sort_order, relationships=relationships, completion_interval=completion_interval, overdue=overdue, interval_condition=interval_condition) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->get_coaching_appointments: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/coaching/appointments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new appointment,"```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.CoachingApi(); body = PureCloudPlatformClientV2.CreateCoachingAppointmentRequest() # CreateCoachingAppointmentRequest | The appointment to add try: # Create a new appointment api_response = api_instance.post_coaching_appointments(body) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->post_coaching_appointments: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/coaching/appointments/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve aggregated appointment data,"```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.CoachingApi(); body = PureCloudPlatformClientV2.CoachingAppointmentAggregateRequest() # CoachingAppointmentAggregateRequest | Aggregate Request try: # Retrieve aggregated appointment data api_response = api_instance.post_coaching_appointments_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->post_coaching_appointments_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/coaching/appointments/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get my appointments for a given date range,"```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.CoachingApi(); interval = 'interval_example' # str | Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) statuses = ['statuses_example'] # list[str] | Appointment Statuses to filter by (optional) facilitator_ids = ['facilitator_ids_example'] # list[str] | The facilitator IDs for which to retrieve appointments (optional) sort_order = 'sort_order_example' # str | Sort (by due date) either Asc or Desc (optional) relationships = ['relationships_example'] # list[str] | Relationships to filter by (optional) completion_interval = 'completion_interval_example' # str | Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) overdue = 'overdue_example' # str | Overdue status to filter by (optional) interval_condition = 'interval_condition_example' # str | Filter condition for interval (optional) try: # Get my appointments for a given date range api_response = api_instance.get_coaching_appointments_me(interval=interval, page_number=page_number, page_size=page_size, statuses=statuses, facilitator_ids=facilitator_ids, sort_order=sort_order, relationships=relationships, completion_interval=completion_interval, overdue=overdue, interval_condition=interval_condition) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->get_coaching_appointments_me: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/coaching/appointments/{appointmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an existing appointment. Permission not required if you are the creator of the appointment,"```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. try: # Delete an existing appointment api_response = api_instance.delete_coaching_appointment(appointment_id) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->delete_coaching_appointment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/coaching/appointments/{appointmentId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Retrieve an appointment. Permission not required if you are the attendee, creator or facilitator of the appointment","```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. try: # Retrieve an appointment api_response = api_instance.get_coaching_appointment(appointment_id) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->get_coaching_appointment: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/coaching/appointments/{appointmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an existing appointment. Permission not required if you are the creator or facilitator of the appointment,"```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. body = PureCloudPlatformClientV2.UpdateCoachingAppointmentRequest() # UpdateCoachingAppointmentRequest | The new version of the appointment try: # Update an existing appointment api_response = api_instance.patch_coaching_appointment(appointment_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->patch_coaching_appointment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/coaching/appointments/{appointmentId}/annotations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of annotations. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).,"```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. 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 annotations. api_response = api_instance.get_coaching_appointment_annotations(appointment_id, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->get_coaching_appointment_annotations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/coaching/appointments/{appointmentId}/annotations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations).,"```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. body = PureCloudPlatformClientV2.CoachingAnnotationCreateRequest() # CoachingAnnotationCreateRequest | The annotation to add try: # Create a new annotation. api_response = api_instance.post_coaching_appointment_annotations(appointment_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->post_coaching_appointment_annotations: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an existing annotation. You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment,"```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. annotation_id = 'annotation_id_example' # str | The ID of the annotation. try: # Delete an existing annotation api_instance.delete_coaching_appointment_annotation(appointment_id, annotation_id) except ApiException as e: print(""Exception when calling CoachingApi->delete_coaching_appointment_annotation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve an annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).,"```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. annotation_id = 'annotation_id_example' # str | The ID of the annotation. try: # Retrieve an annotation. api_response = api_instance.get_coaching_appointment_annotation(appointment_id, annotation_id) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->get_coaching_appointment_annotation: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an existing annotation. You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment,"```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. annotation_id = 'annotation_id_example' # str | The ID of the annotation. body = PureCloudPlatformClientV2.CoachingAnnotation() # CoachingAnnotation | The new version of the annotation try: # Update an existing annotation. api_response = api_instance.patch_coaching_appointment_annotation(appointment_id, annotation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->patch_coaching_appointment_annotation: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/coaching/appointments/{appointmentId}/conversations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a conversation to an appointment. Permission not required if you are the creator or facilitator of the appointment,"```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. body = PureCloudPlatformClientV2.AddConversationRequest() # AddConversationRequest | body try: # Add a conversation to an appointment api_response = api_instance.post_coaching_appointment_conversations(appointment_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->post_coaching_appointment_conversations: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/coaching/appointments/{appointmentId}/status Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Update the status of a coaching appointment. Permission not required if you are an attendee, creator or facilitator of the appointment","```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. body = PureCloudPlatformClientV2.CoachingAppointmentStatusRequest() # CoachingAppointmentStatusRequest | Updated status of the coaching appointment try: # Update the status of a coaching appointment api_response = api_instance.patch_coaching_appointment_status(appointment_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->patch_coaching_appointment_status: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/coaching/appointments/{appointmentId}/statuses Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the list of status changes for a coaching appointment. Permission not required if you are an attendee, creator or facilitator of the appointment","```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.CoachingApi(); appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment. page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get the list of status changes for a coaching appointment. api_response = api_instance.get_coaching_appointment_statuses(appointment_id, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->get_coaching_appointment_statuses: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/coaching/notifications Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve the list of your notifications.,"```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.CoachingApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) expand = ['expand_example'] # list[str] | Indicates a field in the response which should be expanded. (optional) try: # Retrieve the list of your notifications. api_response = api_instance.get_coaching_notifications(page_number=page_number, page_size=page_size, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->get_coaching_notifications: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/coaching/notifications/{notificationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an existing notification. Permission not required if you are the owner of the notification.,"```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.CoachingApi(); notification_id = 'notification_id_example' # str | The ID of the notification. expand = ['expand_example'] # list[str] | Indicates a field in the response which should be expanded. (optional) try: # Get an existing notification api_response = api_instance.get_coaching_notification(notification_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->get_coaching_notification: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/coaching/notifications/{notificationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an existing notification. Can only update your own notifications.,"```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.CoachingApi(); notification_id = 'notification_id_example' # str | The ID of the notification. body = PureCloudPlatformClientV2.CoachingNotification() # CoachingNotification | Change the read state of a notification try: # Update an existing notification. api_response = api_instance.patch_coaching_notification(notification_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->patch_coaching_notification: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/coaching/scheduleslots/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of possible slots where a coaching appointment can be scheduled.,"```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.CoachingApi(); body = PureCloudPlatformClientV2.CoachingSlotsRequest() # CoachingSlotsRequest | The slot search request try: # Get list of possible slots where a coaching appointment can be scheduled. api_response = api_instance.post_coaching_scheduleslots_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling CoachingApi->post_coaching_scheduleslots_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/contentmanagement/documents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a document.,"```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.ContentManagementApi(); body = PureCloudPlatformClientV2.DocumentUpload() # DocumentUpload | Document copy_source = 'copy_source_example' # str | Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source. (optional) move_source = 'move_source_example' # str | Move a document to a new workspace. Provide a document ID as the move source. (optional) override = True # bool | Override any lock on the source document (optional) try: # Add a document. api_response = api_instance.post_contentmanagement_documents(body, copy_source=copy_source, move_source=move_source, override=override) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->post_contentmanagement_documents: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/contentmanagement/documents/{documentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a document.,"```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.ContentManagementApi(); document_id = 'document_id_example' # str | Document ID override = True # bool | Override any lock on the document (optional) try: # Delete a document. api_instance.delete_contentmanagement_document(document_id, override=override) except ApiException as e: print(""Exception when calling ContentManagementApi->delete_contentmanagement_document: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/documents/{documentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a document.,"```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.ContentManagementApi(); document_id = 'document_id_example' # str | Document ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get a document. api_response = api_instance.get_contentmanagement_document(document_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_document: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/contentmanagement/documents/{documentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a document.,"```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.ContentManagementApi(); document_id = 'document_id_example' # str | Document ID body = PureCloudPlatformClientV2.DocumentUpdate() # DocumentUpdate | Document expand = 'expand_example' # str | Expand some document fields (optional) override = True # bool | Override any lock on the document (optional) try: # Update a document. api_response = api_instance.post_contentmanagement_document(document_id, body, expand=expand, override=override) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->post_contentmanagement_document: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/documents/{documentId}/content Genesys Cloud Python SDK.,Genesys describes this as an API used to: Download a document.,"```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.ContentManagementApi(); document_id = 'document_id_example' # str | Document ID disposition = 'disposition_example' # str | Request how the content will be downloaded: a file attachment or inline. Default is attachment. (optional) content_type = 'content_type_example' # str | The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav (optional) try: # Download a document. api_response = api_instance.get_contentmanagement_document_content(document_id, disposition=disposition, content_type=content_type) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_document_content: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/contentmanagement/documents/{documentId}/content Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace the contents of a document.,"```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.ContentManagementApi(); document_id = 'document_id_example' # str | Document ID body = PureCloudPlatformClientV2.ReplaceRequest() # ReplaceRequest | Replace Request override = True # bool | Override any lock on the document (optional) try: # Replace the contents of a document. api_response = api_instance.post_contentmanagement_document_content(document_id, body, override=override) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->post_contentmanagement_document_content: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query content,"```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.ContentManagementApi(); query_phrase = 'query_phrase_example' # str | Phrase tokens are ANDed together over all searchable fields page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''name'' # str | name or dateCreated (optional) (default to 'name') sort_order = ''ascending'' # str | ascending or descending (optional) (default to 'ascending') expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Query content api_response = api_instance.get_contentmanagement_query(query_phrase, page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/contentmanagement/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query content,"```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.ContentManagementApi(); body = PureCloudPlatformClientV2.QueryRequest() # QueryRequest | Allows for a filtered query returning facet information expand = 'expand_example' # str | Expand some document fields (optional) try: # Query content api_response = api_instance.post_contentmanagement_query(body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->post_contentmanagement_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/securityprofiles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a List of Security Profiles,"```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.ContentManagementApi(); try: # Get a List of Security Profiles api_response = api_instance.get_contentmanagement_securityprofiles() pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_securityprofiles: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/securityprofiles/{securityProfileId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Security Profile,"```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.ContentManagementApi(); security_profile_id = 'security_profile_id_example' # str | Security Profile Id try: # Get a Security Profile api_response = api_instance.get_contentmanagement_securityprofile(security_profile_id) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_securityprofile: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/shared/{sharedId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get shared documents. Securely download a shared document. This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.,"```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.ContentManagementApi(); shared_id = 'shared_id_example' # str | Shared ID redirect = True # bool | Turn on or off redirect (optional) (default to True) disposition = ''attachment'' # str | Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (optional) (default to 'attachment') content_type = 'content_type_example' # str | The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav (optional) expand = 'expand_example' # str | Expand some document fields (optional) try: # Get shared documents. Securely download a shared document. api_response = api_instance.get_contentmanagement_shared_shared_id(shared_id, redirect=redirect, disposition=disposition, content_type=content_type, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_shared_shared_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/shares Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a list of shares. You must specify at least one filter (e.g. entityId). Failing to specify a filter will return 400.,"```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.ContentManagementApi(); entity_id = 'entity_id_example' # str | Filters the shares returned to only the entity specified by the value of this parameter. (optional) expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Gets a list of shares. You must specify at least one filter (e.g. entityId). api_response = api_instance.get_contentmanagement_shares(entity_id=entity_id, expand=expand, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_shares: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/contentmanagement/shares Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a new share or updates an existing share if the entity has already been shared,"```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.ContentManagementApi(); body = PureCloudPlatformClientV2.CreateShareRequest() # CreateShareRequest | CreateShareRequest - entity id and type and a single member or list of members are required try: # Creates a new share or updates an existing share if the entity has already been shared api_response = api_instance.post_contentmanagement_shares(body) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->post_contentmanagement_shares: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/contentmanagement/shares/{shareId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes an existing share. This revokes sharing rights specified in the share record,"```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.ContentManagementApi(); share_id = 'share_id_example' # str | Share ID try: # Deletes an existing share. api_instance.delete_contentmanagement_share(share_id) except ApiException as e: print(""Exception when calling ContentManagementApi->delete_contentmanagement_share: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/shares/{shareId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve details about an existing share.,"```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.ContentManagementApi(); share_id = 'share_id_example' # str | Share ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Retrieve details about an existing share. api_response = api_instance.get_contentmanagement_share(share_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_share: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/status Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of statuses for pending operations,"```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.ContentManagementApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of statuses for pending operations api_response = api_instance.get_contentmanagement_status(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_status: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/contentmanagement/status/{statusId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Cancel the command for this status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ContentManagementApi(); status_id = 'status_id_example' # str | Status ID try: # Cancel the command for this status api_instance.delete_contentmanagement_status_status_id(status_id) except ApiException as e: print(""Exception when calling ContentManagementApi->delete_contentmanagement_status_status_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/status/{statusId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a status.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ContentManagementApi(); status_id = 'status_id_example' # str | Status ID try: # Get a status. api_response = api_instance.get_contentmanagement_status_status_id(status_id) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_status_status_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/usage Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get usage 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.ContentManagementApi(); try: # Get usage details. api_response = api_instance.get_contentmanagement_usage() pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_usage: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a list of workspaces. Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ContentManagementApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) access = ['access_example'] # list[str] | Requested access level. (optional) expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get a list of workspaces. api_response = api_instance.get_contentmanagement_workspaces(page_size=page_size, page_number=page_number, access=access, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_workspaces: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/contentmanagement/workspaces Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a group workspace,"```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.ContentManagementApi(); body = PureCloudPlatformClientV2.WorkspaceCreate() # WorkspaceCreate | Workspace try: # Create a group workspace api_response = api_instance.post_contentmanagement_workspaces(body) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->post_contentmanagement_workspaces: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/contentmanagement/workspaces/{workspaceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a workspace,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID move_children_to_workspace_id = 'move_children_to_workspace_id_example' # str | New location for objects in deleted workspace. (optional) try: # Delete a workspace api_instance.delete_contentmanagement_workspace(workspace_id, move_children_to_workspace_id=move_children_to_workspace_id) except ApiException as e: print(""Exception when calling ContentManagementApi->delete_contentmanagement_workspace: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a workspace.,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get a workspace. api_response = api_instance.get_contentmanagement_workspace(workspace_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_workspace: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/contentmanagement/workspaces/{workspaceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a workspace,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID body = PureCloudPlatformClientV2.Workspace() # Workspace | Workspace try: # Update a workspace api_response = api_instance.put_contentmanagement_workspace(workspace_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->put_contentmanagement_workspace: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId}/documents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of documents.,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = 'sort_by_example' # str | name or dateCreated (optional) sort_order = ''ascending'' # str | ascending or descending (optional) (default to 'ascending') try: # Get a list of documents. api_response = api_instance.get_contentmanagement_workspace_documents(workspace_id, expand=expand, page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_workspace_documents: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list workspace members,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get a list workspace members api_response = api_instance.get_contentmanagement_workspace_members(workspace_id, page_size=page_size, page_number=page_number, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_workspace_members: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a member from a workspace,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID member_id = 'member_id_example' # str | Member ID try: # Delete a member from a workspace api_instance.delete_contentmanagement_workspace_member(workspace_id, member_id) except ApiException as e: print(""Exception when calling ContentManagementApi->delete_contentmanagement_workspace_member: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a workspace member,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID member_id = 'member_id_example' # str | Member ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get a workspace member api_response = api_instance.get_contentmanagement_workspace_member(workspace_id, member_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_workspace_member: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a member to a workspace,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID member_id = 'member_id_example' # str | Member ID body = PureCloudPlatformClientV2.WorkspaceMember() # WorkspaceMember | Workspace Member try: # Add a member to a workspace api_response = api_instance.put_contentmanagement_workspace_member(workspace_id, member_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->put_contentmanagement_workspace_member: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of workspace tags,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID value = 'value_example' # str | filter the list of tags returned (optional) page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get a list of workspace tags api_response = api_instance.get_contentmanagement_workspace_tagvalues(workspace_id, value=value, page_size=page_size, page_number=page_number, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_workspace_tagvalues: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a workspace tag,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID body = PureCloudPlatformClientV2.TagValue() # TagValue | tag try: # Create a workspace tag api_response = api_instance.post_contentmanagement_workspace_tagvalues(workspace_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->post_contentmanagement_workspace_tagvalues: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Perform a prefix query on tags in the workspace,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID body = PureCloudPlatformClientV2.TagQueryRequest() # TagQueryRequest | query expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Perform a prefix query on tags in the workspace api_response = api_instance.post_contentmanagement_workspace_tagvalues_query(workspace_id, body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->post_contentmanagement_workspace_tagvalues_query: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete workspace tag. Delete a tag from a workspace. Will remove this tag from all documents.,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID tag_id = 'tag_id_example' # str | Tag ID try: # Delete workspace tag api_instance.delete_contentmanagement_workspace_tagvalue(workspace_id, tag_id) except ApiException as e: print(""Exception when calling ContentManagementApi->delete_contentmanagement_workspace_tagvalue: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a workspace tag,"```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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID tag_id = 'tag_id_example' # str | Tag ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get a workspace tag api_response = api_instance.get_contentmanagement_workspace_tagvalue(workspace_id, tag_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->get_contentmanagement_workspace_tagvalue: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a workspace tag. Will update all documents with the new tag 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.ContentManagementApi(); workspace_id = 'workspace_id_example' # str | Workspace ID tag_id = 'tag_id_example' # str | Tag ID body = PureCloudPlatformClientV2.TagValue() # TagValue | Workspace try: # Update a workspace tag. Will update all documents with the new tag value. api_response = api_instance.put_contentmanagement_workspace_tagvalue(workspace_id, tag_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ContentManagementApi->put_contentmanagement_workspace_tagvalue: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/activity/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for conversation activity observations,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.ConversationActivityQuery() # ConversationActivityQuery | query page_size = 56 # int | The desired page size (optional) page_number = 56 # int | The desired page number (optional) try: # Query for conversation activity observations api_response = api_instance.post_analytics_conversations_activity_query(body, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_analytics_conversations_activity_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for conversation 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.ConversationsApi(); body = PureCloudPlatformClientV2.ConversationAggregationQuery() # ConversationAggregationQuery | query try: # Query for conversation aggregates api_response = api_instance.post_analytics_conversations_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_analytics_conversations_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/conversations/details Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets multiple conversations by 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.ConversationsApi(); id = ['id_example'] # list[str] | Comma-separated conversation ids (optional) try: # Gets multiple conversations by id api_response = api_instance.get_analytics_conversations_details(id=id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_analytics_conversations_details: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/details/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for conversation details 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.ConversationsApi(); body = PureCloudPlatformClientV2.AsyncConversationQuery() # AsyncConversationQuery | query try: # Query for conversation details asynchronously api_response = api_instance.post_analytics_conversations_details_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_analytics_conversations_details_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/availability Genesys Cloud Python SDK.,Genesys describes this as an API used to: Lookup the datalake availability date and time,"```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.ConversationsApi(); try: # Lookup the datalake availability date and time api_response = api_instance.get_analytics_conversations_details_jobs_availability() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_analytics_conversations_details_jobs_availability: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/analytics/conversations/details/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete/cancel an async details 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.ConversationsApi(); job_id = 'job_id_example' # str | jobId try: # Delete/cancel an async details job api_instance.delete_analytics_conversations_details_job(job_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_analytics_conversations_details_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get status for async query for conversation 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.ConversationsApi(); job_id = 'job_id_example' # str | jobId try: # Get status for async query for conversation details api_response = api_instance.get_analytics_conversations_details_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_analytics_conversations_details_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/{jobId}/results Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch a page of results for an async details 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.ConversationsApi(); job_id = 'job_id_example' # str | jobId cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional) page_size = 56 # int | The desired maximum number of results (optional) try: # Fetch a page of results for an async details job api_response = api_instance.get_analytics_conversations_details_job_results(job_id, cursor=cursor, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_analytics_conversations_details_job_results: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/details/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for conversation 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.ConversationsApi(); body = PureCloudPlatformClientV2.ConversationQuery() # ConversationQuery | query try: # Query for conversation details api_response = api_instance.post_analytics_conversations_details_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_analytics_conversations_details_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/conversations/{conversationId}/details Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a conversation by 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get a conversation by id api_response = api_instance.get_analytics_conversation_details(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_analytics_conversation_details: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/{conversationId}/details/properties Genesys Cloud Python SDK.,Genesys describes this as an API used to: Index conversation properties,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.PropertyIndexRequest() # PropertyIndexRequest | request try: # Index conversation properties api_response = api_instance.post_analytics_conversation_details_properties(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_analytics_conversation_details_properties: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get active conversations 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.ConversationsApi(); communication_type = 'communication_type_example' # str | Call or Chat communication filtering (optional) try: # Get active conversations for the logged in user api_response = api_instance.get_conversations(communication_type=communication_type) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update after-call work for this conversation communication.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.AfterCallWorkUpdate() # AfterCallWorkUpdate | AfterCallWorkUpdate try: # Update after-call work for this conversation communication. api_response = api_instance.patch_conversations_aftercallwork_conversation_id_participant_communication(conversation_id, participant_id, communication_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_aftercallwork_conversation_id_participant_communication: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/callbacks Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get active callback conversations 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.ConversationsApi(); try: # Get active callback conversations for the logged in user api_response = api_instance.get_conversations_callbacks() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_callbacks: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/callbacks Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a scheduled callback,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.PatchCallbackRequest() # PatchCallbackRequest | PatchCallbackRequest try: # Update a scheduled callback api_response = api_instance.patch_conversations_callbacks(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_callbacks: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/callbacks Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Callback,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.CreateCallbackCommand() # CreateCallbackCommand | Callback try: # Create a Callback api_response = api_instance.post_conversations_callbacks(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_callbacks: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/callbacks/bulk/disconnect Genesys Cloud Python SDK.,Genesys describes this as an API used to: Disconnect multiple scheduled callbacks,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.BulkCallbackDisconnectRequest() # BulkCallbackDisconnectRequest | BulkCallbackDisconnectRequest try: # Disconnect multiple scheduled callbacks api_instance.post_conversations_callbacks_bulk_disconnect(body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_callbacks_bulk_disconnect: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/callbacks/bulk/update Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update multiple scheduled callbacks,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.BulkCallbackPatchRequest() # BulkCallbackPatchRequest | BulkCallbackPatchRequest try: # Update multiple scheduled callbacks api_response = api_instance.post_conversations_callbacks_bulk_update(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_callbacks_bulk_update: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/callbacks/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get callback conversation,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get callback conversation api_response = api_instance.get_conversations_callback(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_callback: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/callbacks/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by disconnecting all of the participants,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.Conversation() # Conversation | Conversation try: # Update a conversation by disconnecting all of the participants api_response = api_instance.patch_conversations_callback(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_callback: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant try: # Update conversation participant api_instance.patch_conversations_callback_participant(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_callback_participant: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the attributes on a conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.ParticipantAttributes() # ParticipantAttributes | Attributes try: # Update the attributes on a conversation participant. api_response = api_instance.patch_conversations_callback_participant_attributes(conversation_id, participant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_callback_participant_attributes: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation participant's communication by disconnecting it.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant try: # Update conversation participant's communication by disconnecting it. api_response = api_instance.patch_conversations_callback_participant_communication(conversation_id, participant_id, communication_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_callback_participant_communication: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation communication.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation communication. api_response = api_instance.get_conversations_callback_participant_communication_wrapup(conversation_id, participant_id, communication_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_callback_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Apply wrap-up for this conversation communication,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.WrapupInput() # WrapupInput | Wrap-up (optional) try: # Apply wrap-up for this conversation communication api_instance.post_conversations_callback_participant_communication_wrapup(conversation_id, participant_id, communication_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_callback_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace this participant with the specified user and/or address,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.TransferRequest() # TransferRequest | Transfer request try: # Replace this participant with the specified user and/or address api_instance.post_conversations_callback_participant_replace(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_callback_participant_replace: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation participant. api_response = api_instance.get_conversations_callback_participant_wrapup(conversation_id, participant_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_callback_participant_wrapup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of wrapup codes for this conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId try: # Get list of wrapup codes for this conversation participant api_response = api_instance.get_conversations_callback_participant_wrapupcodes(conversation_id, participant_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_callback_participant_wrapupcodes: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/callbacks/{conversationId}/recordingstate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by setting its recording state,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState try: # Update a conversation by setting its recording state api_response = api_instance.put_conversations_callback_recordingstate(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_callback_recordingstate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/calls Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get active call conversations 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.ConversationsApi(); try: # Get active call conversations for the logged in user api_response = api_instance.get_conversations_calls() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_calls: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a call conversation,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.CreateCallRequest() # CreateCallRequest | Call request try: # Create a call conversation api_response = api_instance.post_conversations_calls(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_calls: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/calls/history Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get call history,"```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.ConversationsApi(); page_size = 25 # int | Page size, maximum 50 (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) interval = 'interval_example' # str | Interval string; format is ISO-8601. Separate start and end times with forward slash '/' (optional) expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get call history api_response = api_instance.get_conversations_calls_history(page_size=page_size, page_number=page_number, interval=interval, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_calls_history: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/calls/maximumconferenceparties Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the maximum number of participants that this user can have on a conference,"```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.ConversationsApi(); try: # Get the maximum number of participants that this user can have on a conference api_response = api_instance.get_conversations_calls_maximumconferenceparties() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_calls_maximumconferenceparties: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/calls/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get call conversation,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get call conversation api_response = api_instance.get_conversations_call(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_call: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/calls/{conversationId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants","```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.Conversation() # Conversation | Conversation try: # Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants api_response = api_instance.patch_conversations_call(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_call: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Place a new call as part of a callback conversation.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.CallCommand() # CallCommand | Conversation try: # Place a new call as part of a callback conversation. api_response = api_instance.post_conversations_call(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add participants to a conversation,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.Conversation() # Conversation | Conversation try: # Add participants to a conversation api_response = api_instance.post_conversations_call_participants(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call_participants: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant request try: # Update conversation participant api_instance.patch_conversations_call_participant(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_call_participant: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the attributes on a conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.ParticipantAttributes() # ParticipantAttributes | Participant attributes try: # Update the attributes on a conversation participant. api_response = api_instance.patch_conversations_call_participant_attributes(conversation_id, participant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_call_participant_attributes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge Genesys Cloud Python SDK.,Genesys describes this as an API used to: Barge a given participant's call creating a barged in conference of connected participants.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId try: # Barge a given participant's call creating a barged in conference of connected participants. api_instance.post_conversations_call_participant_barge(conversation_id, participant_id) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call_participant_barge: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach Genesys Cloud Python SDK.,Genesys describes this as an API used to: Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId try: # Listen in on the conversation from the point of view of a given participant while speaking to just the given participant. api_instance.post_conversations_call_participant_coach(conversation_id, participant_id) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call_participant_coach: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation participant's communication by disconnecting it.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant try: # Update conversation participant's communication by disconnecting it. api_response = api_instance.patch_conversations_call_participant_communication(conversation_id, participant_id, communication_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_call_participant_communication: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set uuiData to be sent on future commands.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.SetUuiDataRequest() # SetUuiDataRequest | UUIData Request try: # Set uuiData to be sent on future commands. api_response = api_instance.put_conversations_call_participant_communication_uuidata(conversation_id, participant_id, communication_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_call_participant_communication_uuidata: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation communication.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation communication. api_response = api_instance.get_conversations_call_participant_communication_wrapup(conversation_id, participant_id, communication_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_call_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Apply wrap-up for this conversation communication,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.WrapupInput() # WrapupInput | Wrap-up (optional) try: # Apply wrap-up for this conversation communication api_instance.post_conversations_call_participant_communication_wrapup(conversation_id, participant_id, communication_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult Genesys Cloud Python SDK.,Genesys describes this as an API used to: Cancel the transfer,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId try: # Cancel the transfer api_instance.delete_conversations_call_participant_consult(conversation_id, participant_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversations_call_participant_consult: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult Genesys Cloud Python SDK.,Genesys describes this as an API used to: Change who can speak,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.ConsultTransferUpdate() # ConsultTransferUpdate | new speak to try: # Change who can speak api_response = api_instance.patch_conversations_call_participant_consult(conversation_id, participant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_call_participant_consult: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult Genesys Cloud Python SDK.,Genesys describes this as an API used to: Initiate and update consult transfer,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.ConsultTransfer() # ConsultTransfer | Destination address & initial speak to try: # Initiate and update consult transfer api_response = api_instance.post_conversations_call_participant_consult(conversation_id, participant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call_participant_consult: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent Genesys Cloud Python SDK.,Genesys describes this as an API used to: Initiate a consult transfer to an 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.ConsultTransferToAgent() # ConsultTransferToAgent | Destination agent & initial speak to try: # Initiate a consult transfer to an agent api_response = api_instance.post_conversations_call_participant_consult_agent(conversation_id, participant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call_participant_consult_agent: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external Genesys Cloud Python SDK.,Genesys describes this as an API used to: Initiate a consult transfer to an 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.ConsultTransferToExternal() # ConsultTransferToExternal | Destination address & initial speak to try: # Initiate a consult transfer to an external contact api_response = api_instance.post_conversations_call_participant_consult_external(conversation_id, participant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call_participant_consult_external: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue Genesys Cloud Python SDK.,Genesys describes this as an API used to: Initiate a consult transfer to a queue,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.ConsultTransferToQueue() # ConsultTransferToQueue | Destination queue & initial speak to try: # Initiate a consult transfer to a queue api_response = api_instance.post_conversations_call_participant_consult_queue(conversation_id, participant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call_participant_consult_queue: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/monitor Genesys Cloud Python SDK.,Genesys describes this as an API used to: Listen in on the conversation from the point of view of a given participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId try: # Listen in on the conversation from the point of view of a given participant. api_instance.post_conversations_call_participant_monitor(conversation_id, participant_id) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call_participant_monitor: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/replace Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace this participant with the specified user and/or address,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.TransferRequest() # TransferRequest | Transfer request try: # Replace this participant with the specified user and/or address api_instance.post_conversations_call_participant_replace(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_call_participant_replace: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation participant. api_response = api_instance.get_conversations_call_participant_wrapup(conversation_id, participant_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_call_participant_wrapup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/calls/{conversationId}/participants/{participantId}/wrapupcodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of wrapup codes for this conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId try: # Get list of wrapup codes for this conversation participant api_response = api_instance.get_conversations_call_participant_wrapupcodes(conversation_id, participant_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_call_participant_wrapupcodes: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/calls/{conversationId}/recordingstate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by setting its recording state,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState try: # Update a conversation by setting its recording state api_response = api_instance.put_conversations_call_recordingstate(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_call_recordingstate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/chats Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get active chat conversations 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.ConversationsApi(); try: # Get active chat conversations for the logged in user api_response = api_instance.get_conversations_chats() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_chats: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/chats Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a web chat conversation,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.CreateWebChatRequest() # CreateWebChatRequest | Create web chat request try: # Create a web chat conversation api_response = api_instance.post_conversations_chats(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_chats: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/chats/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get chat conversation,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get chat conversation api_response = api_instance.get_conversations_chat(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_chat: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/chats/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by disconnecting all of the participants,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.Conversation() # Conversation | Conversation try: # Update a conversation by disconnecting all of the participants api_response = api_instance.patch_conversations_chat(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_chat: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send a message on behalf of a communication in a chat conversation.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.CreateWebChatMessageRequest() # CreateWebChatMessageRequest | Message try: # Send a message on behalf of a communication in a chat conversation. api_response = api_instance.post_conversations_chat_communication_messages(conversation_id, communication_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_chat_communication_messages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/chats/{conversationId}/communications/{communicationId}/typing Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send a typing-indicator on behalf of a communication in a chat conversation.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId communication_id = 'communication_id_example' # str | communicationId try: # Send a typing-indicator on behalf of a communication in a chat conversation. api_response = api_instance.post_conversations_chat_communication_typing(conversation_id, communication_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_chat_communication_typing: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/chats/{conversationId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the messages of a chat conversation. The current user must be involved with the conversation to get its 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId after = 'after_example' # str | If specified, get the messages chronologically after the id of this message (optional) before = 'before_example' # str | If specified, get the messages chronologically before the id of this message (optional) sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending') max_results = 100 # int | Limit the returned number of messages, up to a maximum of 100 (optional) (default to 100) try: # Get the messages of a chat conversation. api_response = api_instance.get_conversations_chat_messages(conversation_id, after=after, before=before, sort_order=sort_order, max_results=max_results) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_chat_messages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/chats/{conversationId}/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a web chat conversation message. The current user must be involved with the conversation to get its 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId message_id = 'message_id_example' # str | messageId try: # Get a web chat conversation message api_response = api_instance.get_conversations_chat_message(conversation_id, message_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_chat_message: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Update request try: # Update conversation participant api_instance.patch_conversations_chat_participant(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_chat_participant: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the attributes on a conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.ParticipantAttributes() # ParticipantAttributes | Participant attributes try: # Update the attributes on a conversation participant. api_response = api_instance.patch_conversations_chat_participant_attributes(conversation_id, participant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_chat_participant_attributes: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation participant's communication by disconnecting it.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant try: # Update conversation participant's communication by disconnecting it. api_response = api_instance.patch_conversations_chat_participant_communication(conversation_id, participant_id, communication_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_chat_participant_communication: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation communication.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation communication. api_response = api_instance.get_conversations_chat_participant_communication_wrapup(conversation_id, participant_id, communication_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_chat_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Apply wrap-up for this conversation communication,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.WrapupInput() # WrapupInput | Wrap-up (optional) try: # Apply wrap-up for this conversation communication api_instance.post_conversations_chat_participant_communication_wrapup(conversation_id, participant_id, communication_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_chat_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/chats/{conversationId}/participants/{participantId}/replace Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace this participant with the specified user and/or address,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.TransferRequest() # TransferRequest | Transfer request try: # Replace this participant with the specified user and/or address api_instance.post_conversations_chat_participant_replace(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_chat_participant_replace: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation participant. api_response = api_instance.get_conversations_chat_participant_wrapup(conversation_id, participant_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_chat_participant_wrapup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/chats/{conversationId}/participants/{participantId}/wrapupcodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of wrapup codes for this conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId try: # Get list of wrapup codes for this conversation participant api_response = api_instance.get_conversations_chat_participant_wrapupcodes(conversation_id, participant_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_chat_participant_wrapupcodes: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/chats/{conversationId}/recordingstate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by setting its recording state,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState try: # Update a conversation by setting its recording state api_response = api_instance.put_conversations_chat_recordingstate(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_chat_recordingstate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/cobrowsesessions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get active cobrowse conversations 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.ConversationsApi(); try: # Get active cobrowse conversations for the logged in user api_response = api_instance.get_conversations_cobrowsesessions() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_cobrowsesessions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/cobrowsesessions/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get cobrowse conversation,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get cobrowse conversation api_response = api_instance.get_conversations_cobrowsesession(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_cobrowsesession: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by setting its recording state,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState try: # Update a conversation by setting its recording state api_response = api_instance.put_conversations_cobrowsesession_recordingstate(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_cobrowsesession_recordingstate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/emails Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get active email conversations 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.ConversationsApi(); try: # Get active email conversations for the logged in user api_response = api_instance.get_conversations_emails() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_emails: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/emails Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Create an email conversation. If the direction of the request is INBOUND, this will create an external conversation with a third party provider. If the direction of the the request is OUTBOUND, this will create a conversation to send outbound emails on behalf of a queue.","```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.ConversationsApi(); body = PureCloudPlatformClientV2.CreateEmailRequest() # CreateEmailRequest | Create email request try: # Create an email conversation api_response = api_instance.post_conversations_emails(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_emails: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/emails/agentless Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Create an email conversation, per API","```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.ConversationsApi(); body = PureCloudPlatformClientV2.AgentlessEmailSendRequestDto() # AgentlessEmailSendRequestDto | Create agentless email request try: # Create an email conversation, per API api_response = api_instance.post_conversations_emails_agentless(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_emails_agentless: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/emails/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get email conversation,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get email conversation api_response = api_instance.get_conversations_email(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_email: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/emails/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by disconnecting all of the participants,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.Conversation() # Conversation | Conversation try: # Update a conversation by disconnecting all of the participants api_response = api_instance.patch_conversations_email(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_email: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/emails/{conversationId}/inboundmessages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.InboundMessageRequest() # InboundMessageRequest | Send external email reply try: # Send an email to an external conversation. An external conversation is one where the provider is not PureCloud based. This endpoint allows the sender of the external email to reply or send a new message to the existing conversation. The new message will be treated as part of the existing conversation and chained to it. api_response = api_instance.post_conversations_email_inboundmessages(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_email_inboundmessages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/emails/{conversationId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get conversation 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get conversation messages api_response = api_instance.get_conversations_email_messages(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_email_messages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/emails/{conversationId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send an email reply,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.EmailMessage() # EmailMessage | Reply try: # Send an email reply api_response = api_instance.post_conversations_email_messages(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_email_messages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/emails/{conversationId}/messages/draft Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get conversation draft reply,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get conversation draft reply api_response = api_instance.get_conversations_email_messages_draft(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_email_messages_draft: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/emails/{conversationId}/messages/draft Genesys Cloud Python SDK.,Genesys describes this as an API used to: Reset conversation draft to its initial state and/or auto-fill draft content,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId auto_fill = True # bool | autoFill (optional) discard = True # bool | discard (optional) body = PureCloudPlatformClientV2.DraftManipulationRequest() # DraftManipulationRequest | Draft Manipulation Request (optional) try: # Reset conversation draft to its initial state and/or auto-fill draft content api_response = api_instance.patch_conversations_email_messages_draft(conversation_id, auto_fill=auto_fill, discard=discard, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_email_messages_draft: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/emails/{conversationId}/messages/draft Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation draft reply,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.EmailMessage() # EmailMessage | Draft try: # Update conversation draft reply api_response = api_instance.put_conversations_email_messages_draft(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_email_messages_draft: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/copy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Copy attachments from an email message to the current 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.CopyAttachmentsRequest() # CopyAttachmentsRequest | Copy Attachment Request try: # Copy attachments from an email message to the current draft. api_response = api_instance.post_conversations_email_messages_draft_attachments_copy(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_email_messages_draft_attachments_copy: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/emails/{conversationId}/messages/draft/attachments/{attachmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete attachment from 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId attachment_id = 'attachment_id_example' # str | attachmentId try: # Delete attachment from draft api_instance.delete_conversations_email_messages_draft_attachment(conversation_id, attachment_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversations_email_messages_draft_attachment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/emails/{conversationId}/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get conversation message,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId message_id = 'message_id_example' # str | messageId try: # Get conversation message api_response = api_instance.get_conversations_email_message(conversation_id, message_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_email_message: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Update request try: # Update conversation participant api_instance.patch_conversations_email_participant(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_email_participant: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the attributes on a conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.ParticipantAttributes() # ParticipantAttributes | Participant attributes try: # Update the attributes on a conversation participant. api_response = api_instance.patch_conversations_email_participant_attributes(conversation_id, participant_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_email_participant_attributes: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation participant's communication by disconnecting it.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant try: # Update conversation participant's communication by disconnecting it. api_response = api_instance.patch_conversations_email_participant_communication(conversation_id, participant_id, communication_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_email_participant_communication: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation communication.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation communication. api_response = api_instance.get_conversations_email_participant_communication_wrapup(conversation_id, participant_id, communication_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_email_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Apply wrap-up for this conversation communication,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.WrapupInput() # WrapupInput | Wrap-up (optional) try: # Apply wrap-up for this conversation communication api_instance.post_conversations_email_participant_communication_wrapup(conversation_id, participant_id, communication_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_email_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/emails/{conversationId}/participants/{participantId}/replace Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace this participant with the specified user and/or address,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.TransferRequest() # TransferRequest | Transfer request try: # Replace this participant with the specified user and/or address api_instance.post_conversations_email_participant_replace(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_email_participant_replace: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation participant. api_response = api_instance.get_conversations_email_participant_wrapup(conversation_id, participant_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_email_participant_wrapup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/emails/{conversationId}/participants/{participantId}/wrapupcodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of wrapup codes for this conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId try: # Get list of wrapup codes for this conversation participant api_response = api_instance.get_conversations_email_participant_wrapupcodes(conversation_id, participant_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_email_participant_wrapupcodes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/emails/{conversationId}/reconnect Genesys Cloud Python SDK.,Genesys describes this as an API used to: Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Reconnect the user to the most recently disconnected customer on a fully disconnected email conversation api_instance.post_conversations_email_reconnect(conversation_id) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_email_reconnect: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/emails/{conversationId}/recordingstate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by setting its recording state,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState try: # Update a conversation by setting its recording state api_response = api_instance.put_conversations_email_recordingstate(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_email_recordingstate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/emails/{conversationId}/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get emails settings for a given conversation,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get emails settings for a given conversation api_response = api_instance.get_conversations_email_settings(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_email_settings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/faxes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create Fax Conversation,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.FaxSendRequest() # FaxSendRequest | Fax try: # Create Fax Conversation api_response = api_instance.post_conversations_faxes(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_faxes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/keyconfigurations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of key configurations data,"```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.ConversationsApi(); try: # Get a list of key configurations data api_response = api_instance.get_conversations_keyconfigurations() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_keyconfigurations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/keyconfigurations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Setup configurations for encryption key creation,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.ConversationEncryptionConfiguration() # ConversationEncryptionConfiguration | Encryption Configuration try: # Setup configurations for encryption key creation api_response = api_instance.post_conversations_keyconfigurations(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_keyconfigurations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/keyconfigurations/validate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Validate encryption key configurations without saving it,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.ConversationEncryptionConfiguration() # ConversationEncryptionConfiguration | Encryption Configuration try: # Validate encryption key configurations without saving it api_response = api_instance.post_conversations_keyconfigurations_validate(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_keyconfigurations_validate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/keyconfigurations/{keyconfigurationsId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the encryption key configurations,"```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.ConversationsApi(); keyconfigurations_id = 'keyconfigurations_id_example' # str | Key Configurations Id try: # Get the encryption key configurations api_response = api_instance.get_conversations_keyconfiguration(keyconfigurations_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_keyconfiguration: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/keyconfigurations/{keyconfigurationsId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the encryption key configurations,"```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.ConversationsApi(); keyconfigurations_id = 'keyconfigurations_id_example' # str | Key Configurations Id body = PureCloudPlatformClientV2.ConversationEncryptionConfiguration() # ConversationEncryptionConfiguration | Encryption key configuration metadata try: # Update the encryption key configurations api_response = api_instance.put_conversations_keyconfiguration(keyconfigurations_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_keyconfiguration: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get active message conversations 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.ConversationsApi(); try: # Get active message conversations for the logged in user api_response = api_instance.get_conversations_messages() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Create an outbound messaging conversation. If there is an existing conversation between the remote address and the address associated with the queue specified in createOutboundRequest then the result of this request depends on the state of that conversation and the useExistingConversation field of createOutboundRequest. If the existing conversation is in alerting or connected state, then the request will fail. If the existing conversation is disconnected but still within the conversation window then the request will fail unless useExistingConversation is set to true.","```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.ConversationsApi(); body = PureCloudPlatformClientV2.CreateOutboundMessagingConversationRequest() # CreateOutboundMessagingConversationRequest | Create outbound messaging conversation try: # Create an outbound messaging conversation. api_response = api_instance.post_conversations_messages(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_messages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/agentless Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Send an agentless outbound message. Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the 'fromAddress' and 'toAddress' specified, the 'useExistingActiveConversation' param can be used to barge in to the ongoing conversation.","```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.ConversationsApi(); body = PureCloudPlatformClientV2.SendAgentlessOutboundMessageRequest() # SendAgentlessOutboundMessageRequest | Create agentless outbound messaging request try: # Send an agentless outbound message api_response = api_instance.post_conversations_messages_agentless(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_messages_agentless: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messages/cachedmedia Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of cached media items,"```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.ConversationsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) url = 'url_example' # str | URL to search for (optional) try: # Get a list of cached media items api_response = api_instance.get_conversations_messages_cachedmedia(page_size=page_size, page_number=page_number, url=url) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messages_cachedmedia: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/messages/cachedmedia/{cachedMediaItemId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove a cached media item asychronously,"```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.ConversationsApi(); cached_media_item_id = 'cached_media_item_id_example' # str | cachedMediaItemId try: # Remove a cached media item asychronously api_instance.delete_conversations_messages_cachedmedia_cached_media_item_id(cached_media_item_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversations_messages_cachedmedia_cached_media_item_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messages/cachedmedia/{cachedMediaItemId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a cached media item,"```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.ConversationsApi(); cached_media_item_id = 'cached_media_item_id_example' # str | cachedMediaItemId try: # Get a cached media item api_response = api_instance.get_conversations_messages_cachedmedia_cached_media_item_id(cached_media_item_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messages_cachedmedia_cached_media_item_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messages/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get message conversation,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get message conversation api_response = api_instance.get_conversations_message(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_message: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messages/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by disconnecting all of the participants,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.Conversation() # Conversation | Conversation try: # Update a conversation by disconnecting all of the participants api_response = api_instance.patch_conversations_message(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_message: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Send message. Send message on existing conversation/communication. Only one message body field can be accepted, per request. Example: 1 textBody, 1 mediaId, 1 stickerId, or 1 messageTemplate.","```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.AdditionalMessage() # AdditionalMessage | Message use_normalized_message = False # bool | If true, response removes deprecated fields (textBody, media, stickers) (optional) (default to False) try: # Send message api_response = api_instance.post_conversations_message_communication_messages(conversation_id, communication_id, body, use_normalized_message=use_normalized_message) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_message_communication_messages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create media. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId communication_id = 'communication_id_example' # str | communicationId try: # Create media api_response = api_instance.post_conversations_message_communication_messages_media(conversation_id, communication_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_message_communication_messages_media: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages/media/{mediaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get media. See https://developer.genesys.cloud/api/rest/v2/conversations/messaging-media-upload for example usage.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId communication_id = 'communication_id_example' # str | communicationId media_id = 'media_id_example' # str | mediaId try: # Get media api_response = api_instance.get_conversations_message_communication_messages_media_media_id(conversation_id, communication_id, media_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_message_communication_messages_media_media_id: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/typing Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send message typing event. Send message typing event for existing conversation/communication.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.MessageTypingEventRequest() # MessageTypingEventRequest | MessageTypingEvent try: # Send message typing event api_instance.post_conversations_message_communication_typing(conversation_id, communication_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_message_communication_typing: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/{conversationId}/messages/bulk Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get messages in batch. The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: [""a3069a33b-bbb1-4703-9d68-061d9e9db96e"", ""55bc6be3-078c-4a49-a4e6-1e05776ed7e8""]","```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | use_normalized_message = False # bool | If true, response removes deprecated fields (textBody, media, stickers) (optional) (default to False) body = ['body_example'] # list[str] | messageIds (optional) try: # Get messages in batch api_response = api_instance.post_conversations_message_messages_bulk(conversation_id, use_normalized_message=use_normalized_message, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_message_messages_bulk: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messages/{conversationId}/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get conversation message,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId message_id = 'message_id_example' # str | messageId use_normalized_message = False # bool | If true, response removes deprecated fields (textBody, media, stickers) (optional) (default to False) try: # Get conversation message api_response = api_instance.get_conversations_message_message(conversation_id, message_id, use_normalized_message=use_normalized_message) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_message_message: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | (optional) try: # Update conversation participant api_instance.patch_conversations_message_participant(conversation_id, participant_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_message_participant: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the attributes on a conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.ParticipantAttributes() # ParticipantAttributes | (optional) try: # Update the attributes on a conversation participant. api_response = api_instance.patch_conversations_message_participant_attributes(conversation_id, participant_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_message_participant_attributes: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation participant's communication by disconnecting it.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant try: # Update conversation participant's communication by disconnecting it. api_response = api_instance.patch_conversations_message_participant_communication(conversation_id, participant_id, communication_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_message_participant_communication: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation communication.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation communication. api_response = api_instance.get_conversations_message_participant_communication_wrapup(conversation_id, participant_id, communication_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_message_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Apply wrap-up for this conversation communication,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.WrapupInput() # WrapupInput | Wrap-up (optional) try: # Apply wrap-up for this conversation communication api_instance.post_conversations_message_participant_communication_wrapup(conversation_id, participant_id, communication_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_message_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/monitor Genesys Cloud Python SDK.,Genesys describes this as an API used to: Listen in on the conversation from the point of view of a given participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId try: # Listen in on the conversation from the point of view of a given participant. api_instance.post_conversations_message_participant_monitor(conversation_id, participant_id) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_message_participant_monitor: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace this participant with the specified user and/or address,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId body = PureCloudPlatformClientV2.TransferRequest() # TransferRequest | Transfer request try: # Replace this participant with the specified user and/or address api_instance.post_conversations_message_participant_replace(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_message_participant_replace: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation participant. api_response = api_instance.get_conversations_message_participant_wrapup(conversation_id, participant_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_message_participant_wrapup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of wrapup codes for this conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId try: # Get list of wrapup codes for this conversation participant api_response = api_instance.get_conversations_message_participant_wrapupcodes(conversation_id, participant_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_message_participant_wrapupcodes: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/messages/{conversationId}/recordingstate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by setting its recording state,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState try: # Update a conversation by setting its recording state api_response = api_instance.put_conversations_message_recordingstate(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_message_recordingstate: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/{integrationId}/inbound/open/event Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Send an inbound Open Event Message. Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","```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.ConversationsApi(); integration_id = 'integration_id_example' # str | integrationId body = PureCloudPlatformClientV2.OpenInboundNormalizedEvent() # OpenInboundNormalizedEvent | NormalizedMessage try: # Send an inbound Open Event Message api_response = api_instance.post_conversations_message_inbound_open_event(integration_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_message_inbound_open_event: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/{integrationId}/inbound/open/message Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Send inbound Open Message. Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","```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.ConversationsApi(); integration_id = 'integration_id_example' # str | integrationId body = PureCloudPlatformClientV2.OpenInboundNormalizedMessage() # OpenInboundNormalizedMessage | NormalizedMessage try: # Send inbound Open Message api_response = api_instance.post_conversations_message_inbound_open_message(integration_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_message_inbound_open_message: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messages/{integrationId}/inbound/open/receipt Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Send an inbound Open Receipt Message. Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.","```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.ConversationsApi(); integration_id = 'integration_id_example' # str | integrationId body = PureCloudPlatformClientV2.OpenInboundNormalizedReceipt() # OpenInboundNormalizedReceipt | NormalizedMessage try: # Send an inbound Open Receipt Message api_response = api_instance.post_conversations_message_inbound_open_receipt(integration_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_message_inbound_open_receipt: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messages/{messageId}/details Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get message,"```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.ConversationsApi(); message_id = 'message_id_example' # str | messageId use_normalized_message = False # bool | If true, response removes deprecated fields (textBody, media, stickers) (optional) (default to False) try: # Get message api_response = api_instance.get_conversations_message_details(message_id, use_normalized_message=use_normalized_message) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_message_details: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/facebook/app Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Genesys Facebook App 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.ConversationsApi(); try: # Get Genesys Facebook App Id api_response = api_instance.get_conversations_messaging_facebook_app() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_facebook_app: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/facebook/permissions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Facebook Permissions,"```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.ConversationsApi(); try: # Get a list of Facebook Permissions api_response = api_instance.get_conversations_messaging_facebook_permissions() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_facebook_permissions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of 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.ConversationsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = ['expand_example'] # list[str] | Expand instructions for the return value. (optional) supported_content_id = 'supported_content_id_example' # str | Filter integrations returned based on the supported content ID (optional) messaging_setting_id = 'messaging_setting_id_example' # str | Filter integrations returned based on the setting ID (optional) try: # Get a list of Integrations api_response = api_instance.get_conversations_messaging_integrations(page_size=page_size, page_number=page_number, expand=expand, supported_content_id=supported_content_id, messaging_setting_id=messaging_setting_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_integrations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/facebook Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Facebook 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.ConversationsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = 'expand_example' # str | Expand instructions for the return value. (optional) supported_content_id = 'supported_content_id_example' # str | Filter integrations returned based on the supported content ID (optional) messaging_setting_id = 'messaging_setting_id_example' # str | Filter integrations returned based on the setting ID (optional) try: # Get a list of Facebook Integrations api_response = api_instance.get_conversations_messaging_integrations_facebook(page_size=page_size, page_number=page_number, expand=expand, supported_content_id=supported_content_id, messaging_setting_id=messaging_setting_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_integrations_facebook: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messaging/integrations/facebook Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Facebook 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.ConversationsApi(); body = PureCloudPlatformClientV2.FacebookIntegrationRequest() # FacebookIntegrationRequest | FacebookIntegrationRequest try: # Create a Facebook Integration api_response = api_instance.post_conversations_messaging_integrations_facebook(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_messaging_integrations_facebook: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/messaging/integrations/facebook/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Facebook messaging 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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID try: # Delete a Facebook messaging integration api_instance.delete_conversations_messaging_integrations_facebook_integration_id(integration_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversations_messaging_integrations_facebook_integration_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/facebook/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Facebook messaging 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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID expand = 'expand_example' # str | Expand instructions for the return value. (optional) try: # Get a Facebook messaging integration api_response = api_instance.get_conversations_messaging_integrations_facebook_integration_id(integration_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_integrations_facebook_integration_id: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messaging/integrations/facebook/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Facebook messaging 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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID body = PureCloudPlatformClientV2.FacebookIntegrationUpdateRequest() # FacebookIntegrationUpdateRequest | FacebookIntegrationUpdateRequest try: # Update Facebook messaging integration api_response = api_instance.patch_conversations_messaging_integrations_facebook_integration_id(integration_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_messaging_integrations_facebook_integration_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/instagram Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Instagram 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.ConversationsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = 'expand_example' # str | Expand instructions for the return value. (optional) supported_content_id = 'supported_content_id_example' # str | Filter integrations returned based on the supported content ID (optional) messaging_setting_id = 'messaging_setting_id_example' # str | Filter integrations returned based on the setting ID (optional) try: # Get a list of Instagram Integrations api_response = api_instance.get_conversations_messaging_integrations_instagram(page_size=page_size, page_number=page_number, expand=expand, supported_content_id=supported_content_id, messaging_setting_id=messaging_setting_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_integrations_instagram: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messaging/integrations/instagram Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create Instagram 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.ConversationsApi(); body = PureCloudPlatformClientV2.InstagramIntegrationRequest() # InstagramIntegrationRequest | InstagramIntegrationRequest try: # Create Instagram Integration api_response = api_instance.post_conversations_messaging_integrations_instagram(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_messaging_integrations_instagram: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/messaging/integrations/instagram/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Instagram messaging 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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID try: # Delete Instagram messaging integration api_instance.delete_conversations_messaging_integrations_instagram_integration_id(integration_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversations_messaging_integrations_instagram_integration_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/instagram/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Instagram messaging 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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID expand = 'expand_example' # str | Expand instructions for the return value. (optional) try: # Get Instagram messaging integration api_response = api_instance.get_conversations_messaging_integrations_instagram_integration_id(integration_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_integrations_instagram_integration_id: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messaging/integrations/instagram/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Instagram messaging 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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID body = PureCloudPlatformClientV2.InstagramIntegrationUpdateRequest() # InstagramIntegrationUpdateRequest | InstagramIntegrationUpdateRequest try: # Update Instagram messaging integration api_response = api_instance.patch_conversations_messaging_integrations_instagram_integration_id(integration_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_messaging_integrations_instagram_integration_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/open Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Open messaging integrations. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.,"```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.ConversationsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = 'expand_example' # str | Expand instructions for the return value. (optional) supported_content_id = 'supported_content_id_example' # str | Filter integrations returned based on the supported content ID (optional) messaging_setting_id = 'messaging_setting_id_example' # str | Filter integrations returned based on the setting ID (optional) try: # Get a list of Open messaging integrations api_response = api_instance.get_conversations_messaging_integrations_open(page_size=page_size, page_number=page_number, expand=expand, supported_content_id=supported_content_id, messaging_setting_id=messaging_setting_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_integrations_open: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messaging/integrations/open Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.OpenIntegrationRequest() # OpenIntegrationRequest | OpenIntegrationRequest try: # Create an Open messaging integration api_response = api_instance.post_conversations_messaging_integrations_open(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_messaging_integrations_open: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/messaging/integrations/open/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.,"```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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID try: # Delete an Open messaging integration api_instance.delete_conversations_messaging_integrations_open_integration_id(integration_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversations_messaging_integrations_open_integration_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/open/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.,"```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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID expand = 'expand_example' # str | Expand instructions for the return value. (optional) try: # Get an Open messaging integration api_response = api_instance.get_conversations_messaging_integrations_open_integration_id(integration_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_integrations_open_integration_id: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messaging/integrations/open/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.,"```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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID body = PureCloudPlatformClientV2.OpenIntegrationUpdateRequest() # OpenIntegrationUpdateRequest | OpenIntegrationUpdateRequest try: # Update an Open messaging integration api_response = api_instance.patch_conversations_messaging_integrations_open_integration_id(integration_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_messaging_integrations_open_integration_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/whatsapp Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of WhatsApp 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.ConversationsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = 'expand_example' # str | Expand instructions for the return value. (optional) supported_content_id = 'supported_content_id_example' # str | Filter integrations returned based on the supported content ID (optional) messaging_setting_id = 'messaging_setting_id_example' # str | Filter integrations returned based on the setting ID (optional) try: # Get a list of WhatsApp Integrations api_response = api_instance.get_conversations_messaging_integrations_whatsapp(page_size=page_size, page_number=page_number, expand=expand, supported_content_id=supported_content_id, messaging_setting_id=messaging_setting_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_integrations_whatsapp: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Create a WhatsApp Integration using the WhatsApp embedded signup flow. Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.","```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.ConversationsApi(); body = PureCloudPlatformClientV2.WhatsAppEmbeddedSignupIntegrationRequest() # WhatsAppEmbeddedSignupIntegrationRequest | WhatsAppEmbeddedSignupIntegrationRequest try: # Create a WhatsApp Integration using the WhatsApp embedded signup flow api_response = api_instance.post_conversations_messaging_integrations_whatsapp_embeddedsignup(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_messaging_integrations_whatsapp_embeddedsignup: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow. Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active,"```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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID body = PureCloudPlatformClientV2.WhatsAppEmbeddedSignupIntegrationActivationRequest() # WhatsAppEmbeddedSignupIntegrationActivationRequest | WhatsAppEmbeddedSignupIntegrationActivationRequest try: # Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow api_response = api_instance.patch_conversations_messaging_integrations_whatsapp_embeddedsignup_integration_id(integration_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_messaging_integrations_whatsapp_embeddedsignup_integration_id: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/messaging/integrations/whatsapp/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a WhatsApp messaging 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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID try: # Delete a WhatsApp messaging integration api_response = api_instance.delete_conversations_messaging_integrations_whatsapp_integration_id(integration_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversations_messaging_integrations_whatsapp_integration_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/whatsapp/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a WhatsApp messaging 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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID expand = 'expand_example' # str | Expand instructions for the return value. (optional) try: # Get a WhatsApp messaging integration api_response = api_instance.get_conversations_messaging_integrations_whatsapp_integration_id(integration_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_integrations_whatsapp_integration_id: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messaging/integrations/whatsapp/{integrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a WhatsApp messaging 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.ConversationsApi(); integration_id = 'integration_id_example' # str | Integration ID body = PureCloudPlatformClientV2.WhatsAppIntegrationUpdateRequest() # WhatsAppIntegrationUpdateRequest | WhatsAppIntegrationUpdateRequest try: # Update a WhatsApp messaging integration api_response = api_instance.patch_conversations_messaging_integrations_whatsapp_integration_id(integration_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_messaging_integrations_whatsapp_integration_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of messaging settings,"```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.ConversationsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of messaging settings api_response = api_instance.get_conversations_messaging_settings(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_settings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messaging/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a messaging setting,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.MessagingSettingRequest() # MessagingSettingRequest | MessagingSetting try: # Create a messaging setting api_response = api_instance.post_conversations_messaging_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_messaging_settings: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/messaging/settings/default Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Delete the organization's default setting, a global default will be applied to integrations without settings. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","```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.ConversationsApi(); try: # Delete the organization's default setting, a global default will be applied to integrations without settings api_instance.delete_conversations_messaging_settings_default() except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversations_messaging_settings_default: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/settings/default Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","```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.ConversationsApi(); try: # Get the organization's default settings that will be used as the default when creating an integration. api_response = api_instance.get_conversations_messaging_settings_default() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_settings_default: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/messaging/settings/default Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Set the organization's default setting that may be applied to to integrations without settings. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.","```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.ConversationsApi(); body = PureCloudPlatformClientV2.MessagingSettingDefaultRequest() # MessagingSettingDefaultRequest | MessagingSetting try: # Set the organization's default setting that may be applied to to integrations without settings api_response = api_instance.put_conversations_messaging_settings_default(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_messaging_settings_default: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/messaging/settings/{messageSettingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a messaging setting,"```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.ConversationsApi(); message_setting_id = 'message_setting_id_example' # str | Message Setting ID try: # Delete a messaging setting api_instance.delete_conversations_messaging_setting(message_setting_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversations_messaging_setting: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/settings/{messageSettingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a messaging setting,"```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.ConversationsApi(); message_setting_id = 'message_setting_id_example' # str | Message Setting ID try: # Get a messaging setting api_response = api_instance.get_conversations_messaging_setting(message_setting_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_setting: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messaging/settings/{messageSettingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a messaging setting,"```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.ConversationsApi(); message_setting_id = 'message_setting_id_example' # str | Message Setting ID body = PureCloudPlatformClientV2.MessagingSettingPatchRequest() # MessagingSettingPatchRequest | MessagingSetting try: # Update a messaging setting api_response = api_instance.patch_conversations_messaging_setting(message_setting_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_messaging_setting: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/supportedcontent Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Supported Content profiles,"```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.ConversationsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of Supported Content profiles api_response = api_instance.get_conversations_messaging_supportedcontent(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_supportedcontent: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/messaging/supportedcontent Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Supported Content profile,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.SupportedContent() # SupportedContent | SupportedContent try: # Create a Supported Content profile api_response = api_instance.post_conversations_messaging_supportedcontent(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_messaging_supportedcontent: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/supportedcontent/default Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the organization's default supported content profile that will be used as the default when creating an integration. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.","```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.ConversationsApi(); try: # Get the organization's default supported content profile that will be used as the default when creating an integration. api_response = api_instance.get_conversations_messaging_supportedcontent_default() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_supportedcontent_default: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/messaging/supportedcontent/default Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Set the organization's default supported content profile that may be assigned to an integration when it is created. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.","```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.ConversationsApi(); body = PureCloudPlatformClientV2.SupportedContentReference() # SupportedContentReference | SupportedContent try: # Set the organization's default supported content profile that may be assigned to an integration when it is created. api_response = api_instance.put_conversations_messaging_supportedcontent_default(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_messaging_supportedcontent_default: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a supported content profile,"```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.ConversationsApi(); supported_content_id = 'supported_content_id_example' # str | Supported Content ID try: # Delete a supported content profile api_instance.delete_conversations_messaging_supportedcontent_supported_content_id(supported_content_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversations_messaging_supportedcontent_supported_content_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a supported content profile,"```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.ConversationsApi(); supported_content_id = 'supported_content_id_example' # str | Supported Content ID try: # Get a supported content profile api_response = api_instance.get_conversations_messaging_supportedcontent_supported_content_id(supported_content_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_supportedcontent_supported_content_id: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a supported content profile,"```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.ConversationsApi(); supported_content_id = 'supported_content_id_example' # str | Supported Content ID body = PureCloudPlatformClientV2.SupportedContent() # SupportedContent | SupportedContent try: # Update a supported content profile api_response = api_instance.patch_conversations_messaging_supportedcontent_supported_content_id(supported_content_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_messaging_supportedcontent_supported_content_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/messaging/threadingtimeline Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get conversation threading window timeline for each messaging type. Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.","```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.ConversationsApi(); try: # Get conversation threading window timeline for each messaging type api_response = api_instance.get_conversations_messaging_threadingtimeline() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_messaging_threadingtimeline: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/messaging/threadingtimeline Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update conversation threading window timeline for each messaging type. PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.ConversationThreadingWindow() # ConversationThreadingWindow | ConversationThreadingWindowRequest try: # Update conversation threading window timeline for each messaging type api_response = api_instance.put_conversations_messaging_threadingtimeline(body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_messaging_threadingtimeline: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/participants/attributes/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search conversations,"```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.SearchApi(); body = PureCloudPlatformClientV2.ConversationParticipantSearchRequest() # ConversationParticipantSearchRequest | Search request options try: # Search conversations api_response = api_instance.post_conversations_participants_attributes_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->post_conversations_participants_attributes_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Settings,"```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.ConversationsApi(); try: # Get Settings api_response = api_instance.get_conversations_settings() pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Settings,"```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.ConversationsApi(); body = PureCloudPlatformClientV2.Settings() # Settings | Settings try: # Update Settings api_instance.patch_conversations_settings(body) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversations_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation communication.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation communication. api_response = api_instance.get_conversations_social_participant_communication_wrapup(conversation_id, participant_id, communication_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_social_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Apply wrap-up for this conversation communication,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.WrapupInput() # WrapupInput | Wrap-up (optional) try: # Apply wrap-up for this conversation communication api_instance.post_conversations_social_participant_communication_wrapup(conversation_id, participant_id, communication_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_social_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/socials/{conversationId}/recordingstate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by setting its recording state,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState try: # Update a conversation by setting its recording state api_response = api_instance.put_conversations_social_recordingstate(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_social_recordingstate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation communication.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation communication. api_response = api_instance.get_conversations_video_participant_communication_wrapup(conversation_id, participant_id, communication_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversations_video_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Apply wrap-up for this conversation communication,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId participant_id = 'participant_id_example' # str | participantId communication_id = 'communication_id_example' # str | communicationId body = PureCloudPlatformClientV2.WrapupInput() # WrapupInput | Wrap-up (optional) try: # Apply wrap-up for this conversation communication api_instance.post_conversations_video_participant_communication_wrapup(conversation_id, participant_id, communication_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversations_video_participant_communication_wrapup: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/videos/{conversationId}/recordingstate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a conversation by setting its recording state,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState try: # Update a conversation by setting its recording state api_response = api_instance.put_conversations_video_recordingstate(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversations_video_recordingstate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get conversation,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID try: # Get conversation api_response = api_instance.get_conversation(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversation: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/assign Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.","```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID body = PureCloudPlatformClientV2.ConversationUser() # ConversationUser | Targeted user try: # Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages. api_response = api_instance.post_conversation_assign(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_assign: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/barge Genesys Cloud Python SDK.,Genesys describes this as an API used to: Barge a conversation creating a barged in conference of connected participants.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID try: # Barge a conversation creating a barged in conference of connected participants. api_instance.post_conversation_barge(conversation_id) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_barge: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/cobrowse Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Creates a cobrowse session. Requires ""conversation:cobrowse:add"" (for web messaging) or ""conversation:cobrowsevoice:add"" permission.","```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | Conversation ID try: # Creates a cobrowse session. Requires \""conversation:cobrowse:add\"" (for web messaging) or \""conversation:cobrowsevoice:add\"" permission. api_response = api_instance.post_conversation_cobrowse(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_cobrowse: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/disconnect Genesys Cloud Python SDK.,Genesys describes this as an API used to: Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID try: # Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation. api_response = api_instance.post_conversation_disconnect(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_disconnect: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/{conversationId}/participants/{participantId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a participant. Update conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Update request try: # Update a participant. api_instance.patch_conversation_participant(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversation_participant: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/attributes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the attributes on a conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID body = PureCloudPlatformClientV2.ParticipantAttributes() # ParticipantAttributes | Participant attributes try: # Update the attributes on a conversation participant. api_instance.patch_conversation_participant_attributes(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversation_participant_attributes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new callback for the specified participant on the conversation.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID body = PureCloudPlatformClientV2.CreateCallbackOnConversationCommand() # CreateCallbackOnConversationCommand | (optional) try: # Create a new callback for the specified participant on the conversation. api_instance.post_conversation_participant_callbacks(conversation_id, participant_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_participant_callbacks: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a code used to add a communication to this participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID add_communication_code = 'add_communication_code_example' # str | addCommunicationCode try: # Delete a code used to add a communication to this participant api_instance.delete_conversation_participant_code(conversation_id, participant_id, add_communication_code) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversation_participant_code: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/digits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Sends DTMF to the participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID body = PureCloudPlatformClientV2.Digits() # Digits | Digits (optional) try: # Sends DTMF to the participant api_instance.post_conversation_participant_digits(conversation_id, participant_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_participant_digits: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove flagged reason from conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID try: # Remove flagged reason from conversation participant. api_instance.delete_conversation_participant_flaggedreason(conversation_id, participant_id) except ApiException as e: print(""Exception when calling ConversationsApi->delete_conversation_participant_flaggedreason: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set flagged reason on conversation participant to indicate bad conversation quality.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID try: # Set flagged reason on conversation participant to indicate bad conversation quality. api_instance.put_conversation_participant_flaggedreason(conversation_id, participant_id) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversation_participant_flaggedreason: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace this participant with the specified user and/or address,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID body = PureCloudPlatformClientV2.TransferRequest() # TransferRequest | Transfer request try: # Replace this participant with the specified user and/or address api_instance.post_conversation_participant_replace(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_participant_replace: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace this participant with the specified 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID body = PureCloudPlatformClientV2.TransferToAgentRequest() # TransferToAgentRequest | Transfer request try: # Replace this participant with the specified agent api_instance.post_conversation_participant_replace_agent(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_participant_replace_agent: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/external Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace this participant with the an 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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID body = PureCloudPlatformClientV2.TransferToExternalRequest() # TransferToExternalRequest | Transfer request try: # Replace this participant with the an external contact api_instance.post_conversation_participant_replace_external(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_participant_replace_external: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace this participant with the specified queue,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID body = PureCloudPlatformClientV2.TransferToQueueRequest() # TransferToQueueRequest | Transfer request try: # Replace this participant with the specified queue api_instance.post_conversation_participant_replace_queue(conversation_id, participant_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_participant_replace_queue: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of secure sessions for this participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID try: # Get a list of secure sessions for this participant. api_response = api_instance.get_conversation_participant_secureivrsessions(conversation_id, participant_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversation_participant_secureivrsessions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID body = PureCloudPlatformClientV2.CreateSecureSession() # CreateSecureSession | (optional) try: # Create secure IVR session. Only a participant in the conversation can invoke a secure IVR. api_response = api_instance.post_conversation_participant_secureivrsessions(conversation_id, participant_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_participant_secureivrsessions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch info on a secure session,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID secure_session_id = 'secure_session_id_example' # str | secure IVR session ID try: # Fetch info on a secure session api_response = api_instance.get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversation_participant_secureivrsession: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up for this conversation participant.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False) try: # Get the wrap-up for this conversation participant. api_response = api_instance.get_conversation_participant_wrapup(conversation_id, participant_id, provisional=provisional) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversation_participant_wrapup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of wrapup codes for this conversation participant,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID participant_id = 'participant_id_example' # str | participant ID try: # Get list of wrapup codes for this conversation participant api_response = api_instance.get_conversation_participant_wrapupcodes(conversation_id, participant_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversation_participant_wrapupcodes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/secureattributes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the secure attributes on a conversation.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID try: # Get the secure attributes on a conversation. api_response = api_instance.get_conversation_secureattributes(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversation_secureattributes: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/{conversationId}/secureattributes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the secure attributes on a conversation.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID body = PureCloudPlatformClientV2.ConversationSecureAttributes() # ConversationSecureAttributes | Conversation Secure Attributes try: # Update the secure attributes on a conversation. api_response = api_instance.patch_conversation_secureattributes(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversation_secureattributes: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/{conversationId}/secureattributes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set the secure attributes on a conversation.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID body = PureCloudPlatformClientV2.ConversationSecureAttributes() # ConversationSecureAttributes | Conversation Secure Attributes try: # Set the secure attributes on a conversation. api_response = api_instance.put_conversation_secureattributes(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversation_secureattributes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/suggestions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all suggestions for a conversation.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | Conversation ID before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) type = 'type_example' # str | Suggestion type to filter by. (optional) state = 'state_example' # str | Suggestion state to filter Copilot suggestions. (optional) try: # Get all suggestions for a conversation. api_response = api_instance.get_conversation_suggestions(conversation_id, before=before, after=after, page_size=page_size, type=type, state=state) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversation_suggestions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/suggestions/feedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Suggestion feedback.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | Conversation ID body = PureCloudPlatformClientV2.Feedback() # Feedback | SuggestionFeedback try: # Suggestion feedback. api_instance.post_conversation_suggestions_feedback(conversation_id, body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_suggestions_feedback: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/suggestions/{suggestionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Suggestion.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | Conversation ID suggestion_id = 'suggestion_id_example' # str | Suggestion ID try: # Get Suggestion. api_response = api_instance.get_conversation_suggestion(conversation_id, suggestion_id) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->get_conversation_suggestion: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement Genesys Cloud Python SDK.,Genesys describes this as an API used to: Save an engagement on the suggestion.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | Conversation ID suggestion_id = 'suggestion_id_example' # str | Suggestion ID body = PureCloudPlatformClientV2.SuggestionEngagement() # SuggestionEngagement | try: # Save an engagement on the suggestion. api_response = api_instance.post_conversation_suggestion_engagement(conversation_id, suggestion_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_suggestion_engagement: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Submit feedback for the summary.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | Conversation ID summary_id = 'summary_id_example' # str | Summary ID body = PureCloudPlatformClientV2.FeedbackAddRequest() # FeedbackAddRequest | (optional) try: # Submit feedback for the summary. api_instance.post_conversation_summary_feedback(conversation_id, summary_id, body=body) except ApiException as e: print(""Exception when calling ConversationsApi->post_conversation_summary_feedback: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/{conversationId}/tags Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the tags on a conversation.,"```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID body = PureCloudPlatformClientV2.ConversationTagsUpdate() # ConversationTagsUpdate | Conversation Tags try: # Update the tags on a conversation. api_response = api_instance.put_conversation_tags(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->put_conversation_tags: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/conversations/{conversationId}/utilizationlabel Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Update the utilization label on a conversation. When there is no value provided, the system default label is applied","```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.ConversationsApi(); conversation_id = 'conversation_id_example' # str | conversation ID body = PureCloudPlatformClientV2.ConversationUtilizationLabelUpdate() # ConversationUtilizationLabelUpdate | Conversation Utilization Label try: # Update the utilization label on a conversation. When there is no value provided, the system default label is applied api_response = api_instance.patch_conversation_utilizationlabel(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ConversationsApi->patch_conversation_utilizationlabel: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/dataextensions/coretypes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the core types from which all schemas are built.,"```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.DataExtensionsApi(); try: # Get the core types from which all schemas are built. api_response = api_instance.get_dataextensions_coretypes() pprint(api_response) except ApiException as e: print(""Exception when calling DataExtensionsApi->get_dataextensions_coretypes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/dataextensions/coretypes/{coretypeName} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a specific named core 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.DataExtensionsApi(); coretype_name = 'coretype_name_example' # str | The core type's name try: # Get a specific named core type. api_response = api_instance.get_dataextensions_coretype(coretype_name) pprint(api_response) except ApiException as e: print(""Exception when calling DataExtensionsApi->get_dataextensions_coretype: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/dataextensions/limits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get quantitative limits on schemas,"```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.DataExtensionsApi(); try: # Get quantitative limits on schemas api_response = api_instance.get_dataextensions_limits() pprint(api_response) except ApiException as e: print(""Exception when calling DataExtensionsApi->get_dataextensions_limits: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/downloads/{downloadId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Issues a redirect to a signed secure download URL for specified download. this method will issue a redirect to the url to the content,"```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.DownloadsApi(); download_id = 'download_id_example' # str | Download ID content_disposition = 'content_disposition_example' # str | (optional) issue_redirect = True # bool | (optional) (default to True) redirect_to_auth = True # bool | (optional) (default to True) try: # Issues a redirect to a signed secure download URL for specified download api_response = api_instance.get_download(download_id, content_disposition=content_disposition, issue_redirect=issue_redirect, redirect_to_auth=redirect_to_auth) pprint(api_response) except ApiException as e: print(""Exception when calling DownloadsApi->get_download: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/emails/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get email Contact Center settings,"```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.SettingsApi(); try: # Get email Contact Center settings api_response = api_instance.get_emails_settings() pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->get_emails_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/emails/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch email Contact Center settings,"```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.SettingsApi(); body = PureCloudPlatformClientV2.EmailSettings() # EmailSettings | (optional) try: # Patch email Contact Center settings api_response = api_instance.patch_emails_settings(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->patch_emails_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/employeeengagement/celebrations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all celebrations,"```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.EmployeeEngagementApi(); page_number = 1 # int | (optional) (default to 1) page_size = 25 # int | (optional) (default to 25) try: # Get all celebrations api_response = api_instance.get_employeeengagement_celebrations(page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling EmployeeEngagementApi->get_employeeengagement_celebrations: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/employeeengagement/celebrations/{celebrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a celebration,"```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.EmployeeEngagementApi(); celebration_id = 'celebration_id_example' # str | The ID of the celebration try: # Deletes a celebration api_instance.delete_employeeengagement_celebration(celebration_id) except ApiException as e: print(""Exception when calling EmployeeEngagementApi->delete_employeeengagement_celebration: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/employeeengagement/celebrations/{celebrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set a state for a celebration,"```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.EmployeeEngagementApi(); celebration_id = 'celebration_id_example' # str | The ID of the celebration body = PureCloudPlatformClientV2.CelebrationStateParam() # CelebrationStateParam | Patch Celebration state try: # Set a state for a celebration api_instance.patch_employeeengagement_celebration(celebration_id, body) except ApiException as e: print(""Exception when calling EmployeeEngagementApi->patch_employeeengagement_celebration: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/employeeengagement/recognitions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a recognition,"```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.EmployeeEngagementApi(); body = PureCloudPlatformClientV2.CreateRecognition() # CreateRecognition | Create Recognition try: # Creates a recognition api_response = api_instance.post_employeeengagement_recognitions(body) pprint(api_response) except ApiException as e: print(""Exception when calling EmployeeEngagementApi->post_employeeengagement_recognitions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/employeeengagement/recognitions/{recognitionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a single recognition,"```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.EmployeeEngagementApi(); recognition_id = 'recognition_id_example' # str | The Recognition ID try: # Gets a single recognition api_response = api_instance.get_employeeengagement_recognition(recognition_id) pprint(api_response) except ApiException as e: print(""Exception when calling EmployeeEngagementApi->get_employeeengagement_recognition: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/events/conversations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Publish Conversation Batch Events,"```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.EventsApi(); body = PureCloudPlatformClientV2.BatchConversationEventRequest() # BatchConversationEventRequest | batchRequest try: # Publish Conversation Batch Events api_response = api_instance.post_events_conversations(body) pprint(api_response) except ApiException as e: print(""Exception when calling EventsApi->post_events_conversations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/events/users/presence Genesys Cloud Python SDK.,Genesys describes this as an API used to: Publish User Presence Status Batch Events,"```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.EventsApi(); body = PureCloudPlatformClientV2.BatchUserPresenceEventRequest() # BatchUserPresenceEventRequest | batchRequest try: # Publish User Presence Status Batch Events api_response = api_instance.post_events_users_presence(body) pprint(api_response) except ApiException as e: print(""Exception when calling EventsApi->post_events_users_presence: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/events/users/routingstatus Genesys Cloud Python SDK.,Genesys describes this as an API used to: Publish Agent Routing Status Batch Events,"```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.EventsApi(); body = PureCloudPlatformClientV2.BatchUserRoutingStatusEventRequest() # BatchUserRoutingStatusEventRequest | batchRequest try: # Publish Agent Routing Status Batch Events api_response = api_instance.post_events_users_routingstatus(body) pprint(api_response) except ApiException as e: print(""Exception when calling EventsApi->post_events_users_routingstatus: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/contacts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk fetch contacts,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Contact ids try: # Bulk fetch contacts api_response = api_instance.post_externalcontacts_bulk_contacts(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_contacts: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/contacts/add Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk add contacts,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkContactsRequest() # BulkContactsRequest | Contacts try: # Bulk add contacts api_response = api_instance.post_externalcontacts_bulk_contacts_add(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_contacts_add: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/contacts/remove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk remove contacts,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Contact ids try: # Bulk remove contacts api_response = api_instance.post_externalcontacts_bulk_contacts_remove(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_contacts_remove: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/contacts/unresolved Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk fetch unresolved ancestor contacts,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Contact ids try: # Bulk fetch unresolved ancestor contacts api_response = api_instance.post_externalcontacts_bulk_contacts_unresolved(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_contacts_unresolved: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/contacts/update Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk update contacts,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkContactsRequest() # BulkContactsRequest | Contacts try: # Bulk update contacts api_response = api_instance.post_externalcontacts_bulk_contacts_update(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_contacts_update: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/notes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk fetch notes,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Note ids try: # Bulk fetch notes api_response = api_instance.post_externalcontacts_bulk_notes(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_notes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/notes/add Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk add notes,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkNotesRequest() # BulkNotesRequest | Notes try: # Bulk add notes api_response = api_instance.post_externalcontacts_bulk_notes_add(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_notes_add: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/notes/remove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk remove notes,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Note ids try: # Bulk remove notes api_response = api_instance.post_externalcontacts_bulk_notes_remove(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_notes_remove: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/notes/update Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk update notes,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkNotesRequest() # BulkNotesRequest | Notes try: # Bulk update notes api_response = api_instance.post_externalcontacts_bulk_notes_update(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_notes_update: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/organizations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk fetch organizations,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Organizations ids try: # Bulk fetch organizations api_response = api_instance.post_externalcontacts_bulk_organizations(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_organizations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/organizations/add Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk add organizations,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkOrganizationsRequest() # BulkOrganizationsRequest | Organizations try: # Bulk add organizations api_response = api_instance.post_externalcontacts_bulk_organizations_add(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_organizations_add: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/organizations/remove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk remove organizations,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Organization ids try: # Bulk remove organizations api_response = api_instance.post_externalcontacts_bulk_organizations_remove(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_organizations_remove: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/organizations/update Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk update organizations,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkOrganizationsRequest() # BulkOrganizationsRequest | Organizations try: # Bulk update organizations api_response = api_instance.post_externalcontacts_bulk_organizations_update(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_organizations_update: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/relationships Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk fetch relationships,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Relationships ids try: # Bulk fetch relationships api_response = api_instance.post_externalcontacts_bulk_relationships(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_relationships: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/relationships/add Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk add relationships,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkRelationshipsRequest() # BulkRelationshipsRequest | Relationships try: # Bulk add relationships api_response = api_instance.post_externalcontacts_bulk_relationships_add(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_relationships_add: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/relationships/remove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk remove relationships,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Relationships ids try: # Bulk remove relationships api_response = api_instance.post_externalcontacts_bulk_relationships_remove(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_relationships_remove: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/relationships/update Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk update relationships,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.BulkRelationshipsRequest() # BulkRelationshipsRequest | Relationships try: # Bulk update relationships api_response = api_instance.post_externalcontacts_bulk_relationships_update(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_bulk_relationships_update: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/contacts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search for external contacts,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ExternalContactsApi(); page_size = 20 # int | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 20) page_number = 1 # int | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 1) q = 'q_example' # str | User supplied search keywords (no special syntax is currently supported) (optional) sort_order = 'sort_order_example' # str | The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \""firstName:asc\"", \""title:desc\"" (optional) expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional) try: # Search for external contacts api_response = api_instance.get_externalcontacts_contacts(page_size=page_size, page_number=page_number, q=q, sort_order=sort_order, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_contacts: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/contacts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an 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.ExternalContactsApi(); body = PureCloudPlatformClientV2.ExternalContact() # ExternalContact | ExternalContact try: # Create an external contact api_response = api_instance.post_externalcontacts_contacts(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_contacts: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/contacts/schemas Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of schemas.,"```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.ExternalContactsApi(); try: # Get a list of schemas. api_response = api_instance.get_externalcontacts_contacts_schemas() pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schemas: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/contacts/schemas Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a schema,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.DataSchema() # DataSchema | Schema try: # Create a schema api_response = api_instance.post_externalcontacts_contacts_schemas(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_contacts_schemas: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/externalcontacts/contacts/schemas/{schemaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a schema,"```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.ExternalContactsApi(); schema_id = 'schema_id_example' # str | Schema ID try: # Delete a schema api_instance.delete_externalcontacts_contacts_schema(schema_id) except ApiException as e: print(""Exception when calling ExternalContactsApi->delete_externalcontacts_contacts_schema: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/contacts/schemas/{schemaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a schema,"```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.ExternalContactsApi(); schema_id = 'schema_id_example' # str | Schema ID try: # Get a schema api_response = api_instance.get_externalcontacts_contacts_schema(schema_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schema: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/externalcontacts/contacts/schemas/{schemaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a schema,"```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.ExternalContactsApi(); schema_id = 'schema_id_example' # str | Schema ID body = PureCloudPlatformClientV2.DataSchema() # DataSchema | Data Schema try: # Update a schema api_response = api_instance.put_externalcontacts_contacts_schema(schema_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->put_externalcontacts_contacts_schema: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all versions of an external contact's schema,"```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.ExternalContactsApi(); schema_id = 'schema_id_example' # str | Schema ID try: # Get all versions of an external contact's schema api_response = api_instance.get_externalcontacts_contacts_schema_versions(schema_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schema_versions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/contacts/schemas/{schemaId}/versions/{versionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a specific version of a schema,"```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.ExternalContactsApi(); schema_id = 'schema_id_example' # str | Schema ID version_id = 'version_id_example' # str | Schema version try: # Get a specific version of a schema api_response = api_instance.get_externalcontacts_contacts_schema_version(schema_id, version_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_contacts_schema_version: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/externalcontacts/contacts/{contactId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an 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.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact ID try: # Delete an external contact api_response = api_instance.delete_externalcontacts_contact(contact_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->delete_externalcontacts_contact: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/contacts/{contactId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch an 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.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact ID expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional) try: # Fetch an external contact api_response = api_instance.get_externalcontacts_contact(contact_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_contact: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/externalcontacts/contacts/{contactId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an 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.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact ID body = PureCloudPlatformClientV2.ExternalContact() # ExternalContact | ExternalContact try: # Update an external contact api_response = api_instance.put_externalcontacts_contact(contact_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->put_externalcontacts_contact: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/contacts/{contactId}/identifiers Genesys Cloud Python SDK.,Genesys describes this as an API used to: List the identifiers for a contact,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact ID try: # List the identifiers for a contact api_response = api_instance.get_externalcontacts_contact_identifiers(contact_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_contact_identifiers: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/externalcontacts/contacts/{contactId}/identifiers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Claim or release identifiers for a contact,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact ID body = PureCloudPlatformClientV2.IdentifierClaimRequest() # IdentifierClaimRequest | ClaimRequest try: # Claim or release identifiers for a contact api_response = api_instance.patch_externalcontacts_contact_identifiers(contact_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->patch_externalcontacts_contact_identifiers: %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/externalcontacts/contacts/{contactId}/notes Genesys Cloud Python SDK.,Genesys describes this as an API used to: List notes for an 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.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact Id page_size = 20 # int | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 20) page_number = 1 # int | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 1) sort_order = 'sort_order_example' # str | The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \""createDate:asc\"", \""createDate:desc\"" (optional) expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional) try: # List notes for an external contact api_response = api_instance.get_externalcontacts_contact_notes(contact_id, page_size=page_size, page_number=page_number, sort_order=sort_order, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_contact_notes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/contacts/{contactId}/notes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a note for an 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.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact Id body = PureCloudPlatformClientV2.Note() # Note | ExternalContact try: # Create a note for an external contact api_response = api_instance.post_externalcontacts_contact_notes(contact_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_contact_notes: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a note for an 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.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact Id note_id = 'note_id_example' # str | Note Id try: # Delete a note for an external contact api_response = api_instance.delete_externalcontacts_contact_note(contact_id, note_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->delete_externalcontacts_contact_note: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch a note for an 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.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact Id note_id = 'note_id_example' # str | Note Id expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional) try: # Fetch a note for an external contact api_response = api_instance.get_externalcontacts_contact_note(contact_id, note_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_contact_note: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/externalcontacts/contacts/{contactId}/notes/{noteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a note for an 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.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact Id note_id = 'note_id_example' # str | Note Id body = PureCloudPlatformClientV2.Note() # Note | Note try: # Update a note for an external contact api_response = api_instance.put_externalcontacts_contact_note(contact_id, note_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->put_externalcontacts_contact_note: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/contacts/{contactId}/promotion Genesys Cloud Python SDK.,Genesys describes this as an API used to: Promote an observed contact (ephemeral or identified) to a curated 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.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact ID try: # Promote an observed contact (ephemeral or identified) to a curated contact api_response = api_instance.post_externalcontacts_contact_promotion(contact_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_contact_promotion: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/contacts/{contactId}/unresolved Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch an unresolved 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.ExternalContactsApi(); contact_id = 'contact_id_example' # str | ExternalContact ID expand = ['expand_example'] # list[str] | which fields, if any, to expand (externalOrganization,externalDataSources,identifiers) (optional) try: # Fetch an unresolved external contact api_response = api_instance.get_externalcontacts_contact_unresolved(contact_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_contact_unresolved: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/externalcontacts/conversations/{conversationId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Associate/disassociate an external contact with a conversation. To associate, supply a value for the externalContactId. To disassociate, do not include the property at all.","```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.ExternalContactsApi(); conversation_id = 'conversation_id_example' # str | Conversation ID body = PureCloudPlatformClientV2.ConversationAssociation() # ConversationAssociation | ConversationAssociation try: # Associate/disassociate an external contact with a conversation api_instance.put_externalcontacts_conversation(conversation_id, body) except ApiException as e: print(""Exception when calling ExternalContactsApi->put_externalcontacts_conversation: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/identifierlookup Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Fetch a contact using an identifier type and value. Phone number identifier values must be provided with the country code and a leading '+' symbol. Example: ""+1 704 298 4733""","```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.ExternalContactsApi(); identifier = PureCloudPlatformClientV2.ContactIdentifier() # ContactIdentifier | expand = ['expand_example'] # list[str] | which field, if any, to expand (optional) try: # Fetch a contact using an identifier type and value. api_response = api_instance.post_externalcontacts_identifierlookup(identifier, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_identifierlookup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/merge/contacts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Merge two contacts into a new contact record. Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for 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.ExternalContactsApi(); body = PureCloudPlatformClientV2.MergeRequest() # MergeRequest | MergeRequest try: # Merge two contacts into a new contact record api_response = api_instance.post_externalcontacts_merge_contacts(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_merge_contacts: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/organizations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search for external organizations,"```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.ExternalContactsApi(); page_size = 20 # int | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 20) page_number = 1 # int | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 1) q = 'q_example' # str | Search query (optional) trustor_id = ['trustor_id_example'] # list[str] | Search for external organizations by trustorIds (limit 25). If supplied, the 'q' parameters is ignored. Items are returned in the order requested (optional) sort_order = 'sort_order_example' # str | The Organization field to sort by. Any of: [companyType, industry, name]. Direction: [asc, desc]. e.g. \""companyType:asc\"", \""industry:desc\"" (optional) expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional) include_trustors = True # bool | (true or false) whether or not to include trustor information embedded in the externalOrganization (optional) try: # Search for external organizations api_response = api_instance.get_externalcontacts_organizations(page_size=page_size, page_number=page_number, q=q, trustor_id=trustor_id, sort_order=sort_order, expand=expand, include_trustors=include_trustors) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_organizations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/organizations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an external organization,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.ExternalOrganization() # ExternalOrganization | ExternalOrganization try: # Create an external organization api_response = api_instance.post_externalcontacts_organizations(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_organizations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/organizations/schemas Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of schemas.,"```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.ExternalContactsApi(); try: # Get a list of schemas. api_response = api_instance.get_externalcontacts_organizations_schemas() pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_organizations_schemas: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/organizations/schemas Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a schema,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.DataSchema() # DataSchema | Schema try: # Create a schema api_response = api_instance.post_externalcontacts_organizations_schemas(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_organizations_schemas: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/organizations/schemas/{schemaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a schema,"```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.ExternalContactsApi(); schema_id = 'schema_id_example' # str | Schema ID try: # Get a schema api_response = api_instance.get_externalcontacts_organizations_schema(schema_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_organizations_schema: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/externalcontacts/organizations/schemas/{schemaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a schema,"```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.ExternalContactsApi(); schema_id = 'schema_id_example' # str | Schema ID body = PureCloudPlatformClientV2.DataSchema() # DataSchema | Data Schema try: # Update a schema api_response = api_instance.put_externalcontacts_organizations_schema(schema_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->put_externalcontacts_organizations_schema: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all versions of an external organization's schema,"```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.ExternalContactsApi(); schema_id = 'schema_id_example' # str | Schema ID try: # Get all versions of an external organization's schema api_response = api_instance.get_externalcontacts_organizations_schema_versions(schema_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_organizations_schema_versions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/organizations/schemas/{schemaId}/versions/{versionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a specific version of a schema,"```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.ExternalContactsApi(); schema_id = 'schema_id_example' # str | Schema ID version_id = 'version_id_example' # str | Schema version try: # Get a specific version of a schema api_response = api_instance.get_externalcontacts_organizations_schema_version(schema_id, version_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_organizations_schema_version: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an external organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization ID try: # Delete an external organization api_response = api_instance.delete_externalcontacts_organization(external_organization_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->delete_externalcontacts_organization: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/organizations/{externalOrganizationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch an external organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization ID expand = ['expand_example'] # list[str] | which fields, if any, to expand (externalDataSources) (optional) include_trustors = True # bool | (true or false) whether or not to include trustor information embedded in the externalOrganization (optional) try: # Fetch an external organization api_response = api_instance.get_externalcontacts_organization(external_organization_id, expand=expand, include_trustors=include_trustors) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_organization: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/externalcontacts/organizations/{externalOrganizationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an external organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization ID body = PureCloudPlatformClientV2.ExternalOrganization() # ExternalOrganization | ExternalOrganization try: # Update an external organization api_response = api_instance.put_externalcontacts_organization(external_organization_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->put_externalcontacts_organization: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/contacts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search for external contacts in an external organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization ID page_size = 20 # int | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 20) page_number = 1 # int | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 1) q = 'q_example' # str | User supplied search keywords (no special syntax is currently supported) (optional) sort_order = 'sort_order_example' # str | The External Contact field to sort by. Any of: [firstName, lastName, middleName, title]. Direction: [asc, desc]. e.g. \""firstName:asc\"", \""title:desc\"" (optional) expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional) try: # Search for external contacts in an external organization api_response = api_instance.get_externalcontacts_organization_contacts(external_organization_id, page_size=page_size, page_number=page_number, q=q, sort_order=sort_order, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_organization_contacts: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes Genesys Cloud Python SDK.,Genesys describes this as an API used to: List notes for an external organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization Id page_size = 20 # int | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 20) page_number = 1 # int | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 1) sort_order = 'sort_order_example' # str | The Note field to sort by. Any of: [createDate]. Direction: [asc, desc]. e.g. \""createDate:asc\"", \""createDate:desc\"" (optional) expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional) try: # List notes for an external organization api_response = api_instance.get_externalcontacts_organization_notes(external_organization_id, page_size=page_size, page_number=page_number, sort_order=sort_order, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_organization_notes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a note for an external organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization Id body = PureCloudPlatformClientV2.Note() # Note | ExternalContact try: # Create a note for an external organization api_response = api_instance.post_externalcontacts_organization_notes(external_organization_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_organization_notes: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a note for an external organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization Id note_id = 'note_id_example' # str | Note Id try: # Delete a note for an external organization api_response = api_instance.delete_externalcontacts_organization_note(external_organization_id, note_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->delete_externalcontacts_organization_note: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch a note for an external organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization Id note_id = 'note_id_example' # str | Note Id expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional) try: # Fetch a note for an external organization api_response = api_instance.get_externalcontacts_organization_note(external_organization_id, note_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_organization_note: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/notes/{noteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a note for an external organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization Id note_id = 'note_id_example' # str | Note Id body = PureCloudPlatformClientV2.Note() # Note | Note try: # Update a note for an external organization api_response = api_instance.put_externalcontacts_organization_note(external_organization_id, note_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->put_externalcontacts_organization_note: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/organizations/{externalOrganizationId}/relationships Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch a relationship for an external organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization ID page_size = 20 # int | Page size (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 20) page_number = 1 # int | Page number (limited to fetching first 1,000 records; pageNumber * pageSize must be <= 1,000) (optional) (default to 1) expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional) sort_order = 'sort_order_example' # str | The Relationship field to sort by. Any of: [createDate, relationship]. Direction: [asc, desc]. e.g. \""createDate:asc\"", \""relationship:desc\"" (optional) try: # Fetch a relationship for an external organization api_response = api_instance.get_externalcontacts_organization_relationships(external_organization_id, page_size=page_size, page_number=page_number, expand=expand, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_organization_relationships: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor Genesys Cloud Python SDK.,Genesys describes this as an API used to: Unlink the Trustor for this External Organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization ID try: # Unlink the Trustor for this External Organization api_instance.delete_externalcontacts_organization_trustor(external_organization_id) except ApiException as e: print(""Exception when calling ExternalContactsApi->delete_externalcontacts_organization_trustor: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/externalcontacts/organizations/{externalOrganizationId}/trustor/{trustorId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Links a Trustor with an External Organization,"```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.ExternalContactsApi(); external_organization_id = 'external_organization_id_example' # str | External Organization ID trustor_id = 'trustor_id_example' # str | Trustor ID try: # Links a Trustor with an External Organization api_response = api_instance.put_externalcontacts_organization_trustor_trustor_id(external_organization_id, trustor_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->put_externalcontacts_organization_trustor_trustor_id: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/externalcontacts/relationships Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a relationship,"```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.ExternalContactsApi(); body = PureCloudPlatformClientV2.Relationship() # Relationship | Relationship try: # Create a relationship api_response = api_instance.post_externalcontacts_relationships(body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->post_externalcontacts_relationships: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/externalcontacts/relationships/{relationshipId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a relationship,"```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.ExternalContactsApi(); relationship_id = 'relationship_id_example' # str | Relationship Id try: # Delete a relationship api_response = api_instance.delete_externalcontacts_relationship(relationship_id) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->delete_externalcontacts_relationship: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/relationships/{relationshipId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch a relationship,"```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.ExternalContactsApi(); relationship_id = 'relationship_id_example' # str | Relationship Id expand = ['expand_example'] # list[str] | which fields, if any, to expand (optional) try: # Fetch a relationship api_response = api_instance.get_externalcontacts_relationship(relationship_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_relationship: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/externalcontacts/relationships/{relationshipId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a relationship,"```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.ExternalContactsApi(); relationship_id = 'relationship_id_example' # str | Relationship Id body = PureCloudPlatformClientV2.Relationship() # Relationship | Relationship try: # Update a relationship api_response = api_instance.put_externalcontacts_relationship(relationship_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->put_externalcontacts_relationship: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/reversewhitepageslookup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values 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.ExternalContactsApi(); lookup_val = 'lookup_val_example' # str | User supplied value to lookup contacts/externalOrganizations (supports email addresses, e164 phone numbers, Twitter screen names) expand = ['expand_example'] # list[str] | which field, if any, to expand (optional) try: # Look up contacts and externalOrganizations based on an attribute. Maximum of 25 values returned. api_response = api_instance.get_externalcontacts_reversewhitepageslookup(lookup_val, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_reversewhitepageslookup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/scan/contacts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Scan for external contacts using paging,"```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.ExternalContactsApi(); limit = 56 # int | The number of contacts per page; must be between 10 and 200, default is 100 (optional) cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional) try: # Scan for external contacts using paging api_response = api_instance.get_externalcontacts_scan_contacts(limit=limit, cursor=cursor) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_scan_contacts: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/scan/notes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Scan for notes using paging,"```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.ExternalContactsApi(); limit = 56 # int | The number of notes per page; must be between 10 and 200, default is 100 (optional) cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional) try: # Scan for notes using paging api_response = api_instance.get_externalcontacts_scan_notes(limit=limit, cursor=cursor) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_scan_notes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/scan/organizations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Scan for external organizations using paging,"```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.ExternalContactsApi(); limit = 56 # int | The number of organizations per page; must be between 10 and 200, default is 100 (optional) cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional) try: # Scan for external organizations using paging api_response = api_instance.get_externalcontacts_scan_organizations(limit=limit, cursor=cursor) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_scan_organizations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/externalcontacts/scan/relationships Genesys Cloud Python SDK.,Genesys describes this as an API used to: Scan for relationships,"```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.ExternalContactsApi(); limit = 56 # int | The number of relationships per page; must be between 10 and 200, default is 100 (optional) cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL (optional) try: # Scan for relationships api_response = api_instance.get_externalcontacts_scan_relationships(limit=limit, cursor=cursor) pprint(api_response) except ApiException as e: print(""Exception when calling ExternalContactsApi->get_externalcontacts_scan_relationships: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/fax/documents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of fax documents.,"```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.FaxApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of fax documents. api_response = api_instance.get_fax_documents(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling FaxApi->get_fax_documents: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/fax/documents/{documentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a fax document.,"```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.FaxApi(); document_id = 'document_id_example' # str | Document ID try: # Delete a fax document. api_instance.delete_fax_document(document_id) except ApiException as e: print(""Exception when calling FaxApi->delete_fax_document: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/fax/documents/{documentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a document.,"```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.FaxApi(); document_id = 'document_id_example' # str | Document ID try: # Get a document. api_response = api_instance.get_fax_document(document_id) pprint(api_response) except ApiException as e: print(""Exception when calling FaxApi->get_fax_document: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/fax/documents/{documentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a fax document.,"```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.FaxApi(); document_id = 'document_id_example' # str | Document ID body = PureCloudPlatformClientV2.FaxDocument() # FaxDocument | Document try: # Update a fax document. api_response = api_instance.put_fax_document(document_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling FaxApi->put_fax_document: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/fax/documents/{documentId}/content Genesys Cloud Python SDK.,Genesys describes this as an API used to: Download a fax document.,"```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.FaxApi(); document_id = 'document_id_example' # str | Document ID try: # Download a fax document. api_response = api_instance.get_fax_document_content(document_id) pprint(api_response) except ApiException as e: print(""Exception when calling FaxApi->get_fax_document_content: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/fax/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get organization config for given organization,"```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.FaxApi(); try: # Get organization config for given organization api_response = api_instance.get_fax_settings() pprint(api_response) except ApiException as e: print(""Exception when calling FaxApi->get_fax_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/fax/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/write organization config for given organization,"```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.FaxApi(); body = PureCloudPlatformClientV2.FaxConfig() # FaxConfig | (optional) try: # Update/write organization config for given organization api_response = api_instance.put_fax_settings(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling FaxApi->put_fax_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/fax/summary Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get fax summary,"```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.FaxApi(); try: # Get fax summary api_response = api_instance.get_fax_summary() pprint(api_response) except ApiException as e: print(""Exception when calling FaxApi->get_fax_summary: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/flows/activity/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for flow activity observations,"```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.FlowsApi(); body = PureCloudPlatformClientV2.FlowActivityQuery() # FlowActivityQuery | query page_size = 56 # int | The desired page size (optional) page_number = 56 # int | The desired page number (optional) try: # Query for flow activity observations api_response = api_instance.post_analytics_flows_activity_query(body, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling FlowsApi->post_analytics_flows_activity_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/flows/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for flow 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.FlowsApi(); body = PureCloudPlatformClientV2.FlowAggregationQuery() # FlowAggregationQuery | query try: # Query for flow aggregates api_response = api_instance.post_analytics_flows_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling FlowsApi->post_analytics_flows_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/flows/observations/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for flow observations,"```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.FlowsApi(); body = PureCloudPlatformClientV2.FlowObservationQuery() # FlowObservationQuery | query try: # Query for flow observations api_response = api_instance.post_analytics_flows_observations_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling FlowsApi->post_analytics_flows_observations_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/employeeperformance/externalmetrics/data Genesys Cloud Python SDK.,Genesys describes this as an API used to: Write External Metric Data,"```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.GamificationApi(); body = PureCloudPlatformClientV2.ExternalMetricDataWriteRequest() # ExternalMetricDataWriteRequest | The External Metric Data to be added (optional) try: # Write External Metric Data api_response = api_instance.post_employeeperformance_externalmetrics_data(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_employeeperformance_externalmetrics_data: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/employeeperformance/externalmetrics/definitions Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a list of External Metric Definitions of an organization, sorted by name in ascending order","```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.GamificationApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of External Metric Definitions of an organization, sorted by name in ascending order api_response = api_instance.get_employeeperformance_externalmetrics_definitions(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_employeeperformance_externalmetrics_definitions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/employeeperformance/externalmetrics/definitions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create External Metric Definition,"```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.GamificationApi(); body = PureCloudPlatformClientV2.ExternalMetricDefinitionCreateRequest() # ExternalMetricDefinitionCreateRequest | The External Metric Definition to be created (optional) try: # Create External Metric Definition api_response = api_instance.post_employeeperformance_externalmetrics_definitions(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_employeeperformance_externalmetrics_definitions: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/employeeperformance/externalmetrics/definitions/{metricId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an External Metric Definition,"```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.GamificationApi(); metric_id = 'metric_id_example' # str | Specifies the External Metric Definition ID try: # Delete an External Metric Definition api_instance.delete_employeeperformance_externalmetrics_definition(metric_id) except ApiException as e: print(""Exception when calling GamificationApi->delete_employeeperformance_externalmetrics_definition: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/employeeperformance/externalmetrics/definitions/{metricId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an External Metric Definition,"```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.GamificationApi(); metric_id = 'metric_id_example' # str | Specifies the External Metric Definition ID try: # Get an External Metric Definition api_response = api_instance.get_employeeperformance_externalmetrics_definition(metric_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_employeeperformance_externalmetrics_definition: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/employeeperformance/externalmetrics/definitions/{metricId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update External Metric Definition,"```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.GamificationApi(); metric_id = 'metric_id_example' # str | Specifies the metric definition ID body = PureCloudPlatformClientV2.ExternalMetricDefinitionUpdateRequest() # ExternalMetricDefinitionUpdateRequest | The External Metric Definition parameters to be updated try: # Update External Metric Definition api_response = api_instance.patch_employeeperformance_externalmetrics_definition(metric_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->patch_employeeperformance_externalmetrics_definition: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/insights Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get insights summary,"```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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. granularity = 'granularity_example' # str | Granularity comparative_period_start_workday = '2013-10-20' # date | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_start_workday = '2013-10-20' # date | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_key = 'sort_key_example' # str | Sort key (optional) sort_metric_id = 'sort_metric_id_example' # str | Sort Metric Id (optional) sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') user_ids = 'user_ids_example' # str | A list of up to 100 comma-separated user Ids (optional) try: # Get insights summary api_response = api_instance.get_gamification_insights(filter_type, filter_id, granularity, comparative_period_start_workday, primary_period_start_workday, page_size=page_size, page_number=page_number, sort_key=sort_key, sort_metric_id=sort_metric_id, sort_order=sort_order, user_ids=user_ids) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_insights: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/insights/details Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get insights details for the current 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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. granularity = 'granularity_example' # str | Granularity comparative_period_start_workday = '2013-10-20' # date | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_start_workday = '2013-10-20' # date | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Get insights details for the current user api_response = api_instance.get_gamification_insights_details(filter_type, filter_id, granularity, comparative_period_start_workday, primary_period_start_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_insights_details: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/insights/groups/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get insights overall trend for the current 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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. granularity = 'granularity_example' # str | Granularity comparative_period_start_workday = '2013-10-20' # date | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd comparative_period_end_workday = '2013-10-20' # date | The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_start_workday = '2013-10-20' # date | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_end_workday = '2013-10-20' # date | The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Get insights overall trend for the current user api_response = api_instance.get_gamification_insights_groups_trends(filter_type, filter_id, granularity, comparative_period_start_workday, comparative_period_end_workday, primary_period_start_workday, primary_period_end_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_insights_groups_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/insights/groups/trends/all Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get insights overall trend,"```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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. granularity = 'granularity_example' # str | Granularity comparative_period_start_workday = '2013-10-20' # date | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd comparative_period_end_workday = '2013-10-20' # date | The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_start_workday = '2013-10-20' # date | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_end_workday = '2013-10-20' # date | The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Get insights overall trend api_response = api_instance.get_gamification_insights_groups_trends_all(filter_type, filter_id, granularity, comparative_period_start_workday, comparative_period_end_workday, primary_period_start_workday, primary_period_end_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_insights_groups_trends_all: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/insights/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query users in a profile during a period of time,"```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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. granularity = 'granularity_example' # str | Granularity start_workday = '2013-10-20' # date | The start work day. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Query users in a profile during a period of time api_response = api_instance.get_gamification_insights_members(filter_type, filter_id, granularity, start_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_insights_members: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/insights/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get insights user trend for the current 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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. granularity = 'granularity_example' # str | Granularity comparative_period_start_workday = '2013-10-20' # date | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd comparative_period_end_workday = '2013-10-20' # date | The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_start_workday = '2013-10-20' # date | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_end_workday = '2013-10-20' # date | The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Get insights user trend for the current user api_response = api_instance.get_gamification_insights_trends(filter_type, filter_id, granularity, comparative_period_start_workday, comparative_period_end_workday, primary_period_start_workday, primary_period_end_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_insights_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/insights/users/{userId}/details Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get insights details for the 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.GamificationApi(); user_id = 'user_id_example' # str | The ID of a user. filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. granularity = 'granularity_example' # str | Granularity comparative_period_start_workday = '2013-10-20' # date | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_start_workday = '2013-10-20' # date | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Get insights details for the user api_response = api_instance.get_gamification_insights_user_details(user_id, filter_type, filter_id, granularity, comparative_period_start_workday, primary_period_start_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_insights_user_details: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/insights/users/{userId}/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get insights user trend for the 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.GamificationApi(); user_id = 'user_id_example' # str | The ID of a user. filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. granularity = 'granularity_example' # str | Granularity comparative_period_start_workday = '2013-10-20' # date | The start work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd comparative_period_end_workday = '2013-10-20' # date | The end work day of comparative period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_start_workday = '2013-10-20' # date | The start work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd primary_period_end_workday = '2013-10-20' # date | The end work day of primary period. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Get insights user trend for the user api_response = api_instance.get_gamification_insights_user_trends(user_id, filter_type, filter_id, granularity, comparative_period_start_workday, comparative_period_end_workday, primary_period_start_workday, primary_period_end_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_insights_user_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/leaderboard Genesys Cloud Python SDK.,Genesys describes this as an API used to: Leaderboard of the requesting user's division or performance profile,"```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.GamificationApi(); start_workday = '2013-10-20' # date | Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd metric_id = 'metric_id_example' # str | Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given. (optional) try: # Leaderboard of the requesting user's division or performance profile api_response = api_instance.get_gamification_leaderboard(start_workday, end_workday, metric_id=metric_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_leaderboard: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/leaderboard/all Genesys Cloud Python SDK.,Genesys describes this as an API used to: Leaderboard by filter 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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. For example, division or performance profile Id start_workday = '2013-10-20' # date | Start workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday to retrieve for the leaderboard. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd metric_id = 'metric_id_example' # str | Metric Id for which the leaderboard is to be generated. The total points is used if nothing is given. (optional) try: # Leaderboard by filter type api_response = api_instance.get_gamification_leaderboard_all(filter_type, filter_id, start_workday, end_workday, metric_id=metric_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_leaderboard_all: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/leaderboard/all/bestpoints Genesys Cloud Python SDK.,Genesys describes this as an API used to: Best Points by division or performance profile,"```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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. For example, division or performance profile Id try: # Best Points by division or performance profile api_response = api_instance.get_gamification_leaderboard_all_bestpoints(filter_type, filter_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_leaderboard_all_bestpoints: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/leaderboard/bestpoints Genesys Cloud Python SDK.,Genesys describes this as an API used to: Best Points of the requesting user's current performance profile or division,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.GamificationApi(); try: # Best Points of the requesting user's current performance profile or division api_response = api_instance.get_gamification_leaderboard_bestpoints() pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_leaderboard_bestpoints: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/metricdefinitions Genesys Cloud Python SDK.,Genesys describes this as an API used to: All metric definitions. Retrieves the metric definitions and their corresponding default objectives used to create a gamified metric,"```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.GamificationApi(); try: # All metric definitions api_response = api_instance.get_gamification_metricdefinitions() pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_metricdefinitions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/metricdefinitions/{metricDefinitionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Metric definition by 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.GamificationApi(); metric_definition_id = 'metric_definition_id_example' # str | metric definition id try: # Metric definition by id api_response = api_instance.get_gamification_metricdefinition(metric_definition_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_metricdefinition: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/profiles Genesys Cloud Python SDK.,Genesys describes this as an API used to: All performance profiles,"```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.GamificationApi(); try: # All performance profiles api_response = api_instance.get_gamification_profiles() pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_profiles: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/gamification/profiles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new custom performance profile,"```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.GamificationApi(); body = PureCloudPlatformClientV2.CreatePerformanceProfile() # CreatePerformanceProfile | performanceProfile copy_metrics = True # bool | Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile. (optional) (default to True) try: # Create a new custom performance profile api_response = api_instance.post_gamification_profiles(body, copy_metrics=copy_metrics) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_gamification_profiles: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/profiles/users/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Performance profile of the requesting 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.GamificationApi(); workday = '2013-10-20' # date | Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) try: # Performance profile of the requesting user api_response = api_instance.get_gamification_profiles_users_me(workday=workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_profiles_users_me: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/gamification/profiles/users/me/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query performance profiles in date range for the current 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.GamificationApi(); body = PureCloudPlatformClientV2.UserProfilesInDateRangeRequest() # UserProfilesInDateRangeRequest | The date range of work day. try: # Query performance profiles in date range for the current user api_response = api_instance.post_gamification_profiles_users_me_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_gamification_profiles_users_me_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/profiles/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Performance profile of a 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.GamificationApi(); user_id = 'user_id_example' # str | workday = '2013-10-20' # date | Target querying workday. If not provided, then queries the current performance profile. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) try: # Performance profile of a user api_response = api_instance.get_gamification_profiles_user(user_id, workday=workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_profiles_user: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/gamification/profiles/users/{userId}/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query performance profiles in date range for a 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.GamificationApi(); user_id = 'user_id_example' # str | The ID of a user. body = PureCloudPlatformClientV2.UserProfilesInDateRangeRequest() # UserProfilesInDateRangeRequest | The date range of work day. try: # Query performance profiles in date range for a user api_response = api_instance.post_gamification_profiles_user_query(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_gamification_profiles_user_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/profiles/{profileId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Performance profile by 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.GamificationApi(); profile_id = 'profile_id_example' # str | performanceProfileId try: # Performance profile by id api_response = api_instance.get_gamification_profile(profile_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_profile: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/gamification/profiles/{profileId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a performance profile,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | performanceProfileId body = PureCloudPlatformClientV2.PerformanceProfile() # PerformanceProfile | performanceProfile (optional) try: # Updates a performance profile api_response = api_instance.put_gamification_profile(profile_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->put_gamification_profile: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/gamification/profiles/{profileId}/activate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Activate a performance profile,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | performanceProfileId try: # Activate a performance profile api_response = api_instance.post_gamification_profile_activate(profile_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_gamification_profile_activate: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/gamification/profiles/{profileId}/deactivate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deactivate a performance profile,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | performanceProfileId try: # Deactivate a performance profile api_response = api_instance.post_gamification_profile_deactivate(profile_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_gamification_profile_deactivate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/profiles/{profileId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Members of a given performance profile,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | Profile Id try: # Members of a given performance profile api_response = api_instance.get_gamification_profile_members(profile_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_profile_members: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/gamification/profiles/{profileId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Assign members to a given performance profile,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | Profile Id body = PureCloudPlatformClientV2.AssignUsers() # AssignUsers | assignUsers try: # Assign members to a given performance profile api_response = api_instance.post_gamification_profile_members(profile_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_gamification_profile_members: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/gamification/profiles/{profileId}/members/validate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Validate member assignment,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | Profile Id body = PureCloudPlatformClientV2.ValidateAssignUsers() # ValidateAssignUsers | memberAssignments try: # Validate member assignment api_response = api_instance.post_gamification_profile_members_validate(profile_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_gamification_profile_members_validate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/profiles/{profileId}/metrics Genesys Cloud Python SDK.,Genesys describes this as an API used to: All gamified metrics for a given performance profile,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | Performance Profile Id expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) workday = '2013-10-20' # date | The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) metric_ids = 'metric_ids_example' # str | List of metric ids to filter the response (Optional, comma-separated). (optional) try: # All gamified metrics for a given performance profile api_response = api_instance.get_gamification_profile_metrics(profile_id, expand=expand, workday=workday, metric_ids=metric_ids) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_profile_metrics: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/gamification/profiles/{profileId}/metrics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a gamified metric with a given metric definition and metric objective under in a performance profile,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | Performance Profile Id body = PureCloudPlatformClientV2.CreateMetric() # CreateMetric | Metric try: # Creates a gamified metric with a given metric definition and metric objective under in a performance profile api_response = api_instance.post_gamification_profile_metrics(profile_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_gamification_profile_metrics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/profiles/{profileId}/metrics/objectivedetails Genesys Cloud Python SDK.,Genesys describes this as an API used to: All metrics for a given performance profile with objective details such as order and maxPoints,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | Performance Profile Id workday = '2013-10-20' # date | The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) try: # All metrics for a given performance profile with objective details such as order and maxPoints api_response = api_instance.get_gamification_profile_metrics_objectivedetails(profile_id, workday=workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_profile_metrics_objectivedetails: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/profiles/{profileId}/metrics/{metricId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Performance profile gamified metric by 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.GamificationApi(); profile_id = 'profile_id_example' # str | Performance Profile Id metric_id = 'metric_id_example' # str | Metric Id workday = '2013-10-20' # date | The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) try: # Performance profile gamified metric by id api_response = api_instance.get_gamification_profile_metric(profile_id, metric_id, workday=workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_profile_metric: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/gamification/profiles/{profileId}/metrics/{metricId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a metric in performance profile,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | Performance Profile Id metric_id = 'metric_id_example' # str | Metric Id body = PureCloudPlatformClientV2.CreateMetric() # CreateMetric | Metric try: # Updates a metric in performance profile api_response = api_instance.put_gamification_profile_metric(profile_id, metric_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->put_gamification_profile_metric: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/gamification/profiles/{sourceProfileId}/metrics/{sourceMetricId}/link Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a linked metric,"```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.GamificationApi(); source_profile_id = 'source_profile_id_example' # str | Source Performance Profile Id source_metric_id = 'source_metric_id_example' # str | Source Metric Id body = PureCloudPlatformClientV2.TargetPerformanceProfile() # TargetPerformanceProfile | linkedMetric try: # Creates a linked metric api_response = api_instance.post_gamification_profile_metric_link(source_profile_id, source_metric_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->post_gamification_profile_metric_link: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards Genesys Cloud Python SDK.,Genesys describes this as an API used to: Workday performance metrics of the requesting 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.GamificationApi(); workday = '2013-10-20' # date | Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Workday performance metrics of the requesting user api_response = api_instance.get_gamification_scorecards(workday, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/attendance Genesys Cloud Python SDK.,Genesys describes this as an API used to: Attendance status metrics of the requesting 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.GamificationApi(); start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Attendance status metrics of the requesting user api_response = api_instance.get_gamification_scorecards_attendance(start_workday, end_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_attendance: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/bestpoints Genesys Cloud Python SDK.,Genesys describes this as an API used to: Best points of the requesting 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.GamificationApi(); try: # Best points of the requesting user api_response = api_instance.get_gamification_scorecards_bestpoints() pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_bestpoints: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/points/alltime Genesys Cloud Python SDK.,Genesys describes this as an API used to: All-time points of the requesting 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.GamificationApi(); end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # All-time points of the requesting user api_response = api_instance.get_gamification_scorecards_points_alltime(end_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_points_alltime: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/points/average Genesys Cloud Python SDK.,Genesys describes this as an API used to: Average points of the requesting user's division or performance profile,"```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.GamificationApi(); workday = '2013-10-20' # date | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Average points of the requesting user's division or performance profile api_response = api_instance.get_gamification_scorecards_points_average(workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_points_average: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/points/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Points trends of the requesting 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.GamificationApi(); start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd day_of_week = 'day_of_week_example' # str | Optional filter to specify which day of weeks to be included in the response (optional) try: # Points trends of the requesting user api_response = api_instance.get_gamification_scorecards_points_trends(start_workday, end_workday, day_of_week=day_of_week) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_points_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Average performance values trends by metric of a division or a performance profile,"```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.GamificationApi(); profile_id = 'profile_id_example' # str | performanceProfileId metric_id = 'metric_id_example' # str | metricId filter_type = 'filter_type_example' # str | Filter type for the query request. start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd filter_id = 'filter_id_example' # str | ID for the filter type. Only required when filterType is Division. (optional) reference_workday = '2013-10-20' # date | Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC') try: # Average performance values trends by metric of a division or a performance profile api_response = api_instance.get_gamification_scorecards_profile_metric_users_values_trends(profile_id, metric_id, filter_type, start_workday, end_workday, filter_id=filter_id, reference_workday=reference_workday, time_zone=time_zone) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_profile_metric_users_values_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Average performance values trends by metric of a 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.GamificationApi(); profile_id = 'profile_id_example' # str | performanceProfileId metric_id = 'metric_id_example' # str | metricId user_id = 'user_id_example' # str | start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd reference_workday = '2013-10-20' # date | Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC') try: # Average performance values trends by metric of a user api_response = api_instance.get_gamification_scorecards_profile_metric_user_values_trends(profile_id, metric_id, user_id, start_workday, end_workday, reference_workday=reference_workday, time_zone=time_zone) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_profile_metric_user_values_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Average performance values trends by metric of the requesting 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.GamificationApi(); profile_id = 'profile_id_example' # str | performanceProfileId metric_id = 'metric_id_example' # str | metricId start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd filter_type = 'filter_type_example' # str | Filter type for the query request. If not set, returns the values trends of the requesting user (optional) reference_workday = '2013-10-20' # date | Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC') try: # Average performance values trends by metric of the requesting user api_response = api_instance.get_gamification_scorecards_profile_metric_values_trends(profile_id, metric_id, start_workday, end_workday, filter_type=filter_type, reference_workday=reference_workday, time_zone=time_zone) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_profile_metric_values_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/points/average Genesys Cloud Python SDK.,Genesys describes this as an API used to: Workday average points by target group,"```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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. workday = '2013-10-20' # date | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Workday average points by target group api_response = api_instance.get_gamification_scorecards_users_points_average(filter_type, filter_id, workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_users_points_average: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/values/average Genesys Cloud Python SDK.,Genesys describes this as an API used to: Workday average values by target group,"```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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. For example, division Id workday = '2013-10-20' # date | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC') try: # Workday average values by target group api_response = api_instance.get_gamification_scorecards_users_values_average(filter_type, filter_id, workday, time_zone=time_zone) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_users_values_average: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/values/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Values trend by target group,"```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.GamificationApi(); filter_type = 'filter_type_example' # str | Filter type for the query request. filter_id = 'filter_id_example' # str | ID for the filter type. start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC') try: # Values trend by target group api_response = api_instance.get_gamification_scorecards_users_values_trends(filter_type, filter_id, start_workday, end_workday, time_zone=time_zone) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_users_values_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Workday performance metrics for a 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.GamificationApi(); user_id = 'user_id_example' # str | workday = '2013-10-20' # date | Target querying workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Workday performance metrics for a user api_response = api_instance.get_gamification_scorecards_user(user_id, workday, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId}/attendance Genesys Cloud Python SDK.,Genesys describes this as an API used to: Attendance status metrics for a 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.GamificationApi(); user_id = 'user_id_example' # str | start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Attendance status metrics for a user api_response = api_instance.get_gamification_scorecards_user_attendance(user_id, start_workday, end_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_user_attendance: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId}/bestpoints Genesys Cloud Python SDK.,Genesys describes this as an API used to: Best points of a 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.GamificationApi(); user_id = 'user_id_example' # str | try: # Best points of a user api_response = api_instance.get_gamification_scorecards_user_bestpoints(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_user_bestpoints: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId}/points/alltime Genesys Cloud Python SDK.,Genesys describes this as an API used to: All-time points for a 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.GamificationApi(); user_id = 'user_id_example' # str | end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # All-time points for a user api_response = api_instance.get_gamification_scorecards_user_points_alltime(user_id, end_workday) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_user_points_alltime: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId}/points/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Points trend for a 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.GamificationApi(); user_id = 'user_id_example' # str | start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd day_of_week = 'day_of_week_example' # str | Optional filter to specify which day of weeks to be included in the response (optional) try: # Points trend for a user api_response = api_instance.get_gamification_scorecards_user_points_trends(user_id, start_workday, end_workday, day_of_week=day_of_week) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_user_points_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/users/{userId}/values/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Values trends of a 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.GamificationApi(); user_id = 'user_id_example' # str | start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC') try: # Values trends of a user api_response = api_instance.get_gamification_scorecards_user_values_trends(user_id, start_workday, end_workday, time_zone=time_zone) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_user_values_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/values/average Genesys Cloud Python SDK.,Genesys describes this as an API used to: Average values of the requesting user's division or performance profile,"```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.GamificationApi(); workday = '2013-10-20' # date | The target workday. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC') try: # Average values of the requesting user's division or performance profile api_response = api_instance.get_gamification_scorecards_values_average(workday, time_zone=time_zone) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_values_average: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/scorecards/values/trends Genesys Cloud Python SDK.,Genesys describes this as an API used to: Values trends of the requesting user or group,"```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.GamificationApi(); start_workday = '2013-10-20' # date | Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd end_workday = '2013-10-20' # date | End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd filter_type = 'filter_type_example' # str | Filter type for the query request. If not set, then the request is for the requesting user. (optional) reference_workday = '2013-10-20' # date | Reference workday for the trend. Used to determine the profile of the user as of this date. If not set, then the user's current profile will be used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) time_zone = ''UTC'' # str | Timezone for the workday. Defaults to UTC (optional) (default to 'UTC') try: # Values trends of the requesting user or group api_response = api_instance.get_gamification_scorecards_values_trends(start_workday, end_workday, filter_type=filter_type, reference_workday=reference_workday, time_zone=time_zone) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_scorecards_values_trends: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/status Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gamification activation status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.GamificationApi(); try: # Gamification activation status api_response = api_instance.get_gamification_status() pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_status: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/gamification/status Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update gamification activation status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.GamificationApi(); status = PureCloudPlatformClientV2.GamificationStatus() # GamificationStatus | Gamification status try: # Update gamification activation status api_response = api_instance.put_gamification_status(status) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->put_gamification_status: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/templates Genesys Cloud Python SDK.,Genesys describes this as an API used to: All objective templates,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.GamificationApi(); try: # All objective templates api_response = api_instance.get_gamification_templates() pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_templates: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gamification/templates/{templateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Objective template by 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.GamificationApi(); template_id = 'template_id_example' # str | template id try: # Objective template by id api_response = api_instance.get_gamification_template(template_id) pprint(api_response) except ApiException as e: print(""Exception when calling GamificationApi->get_gamification_template: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gdpr/requests Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all GDPR requests,"```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.GeneralDataProtectionRegulationApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get all GDPR requests api_response = api_instance.get_gdpr_requests(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling GeneralDataProtectionRegulationApi->get_gdpr_requests: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/gdpr/requests Genesys Cloud Python SDK.,Genesys describes this as an API used to: Submit a new GDPR request,"```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.GeneralDataProtectionRegulationApi(); body = PureCloudPlatformClientV2.GDPRRequest() # GDPRRequest | GDPR request delete_confirmed = False # bool | Confirm delete (optional) (default to False) try: # Submit a new GDPR request api_response = api_instance.post_gdpr_requests(body, delete_confirmed=delete_confirmed) pprint(api_response) except ApiException as e: print(""Exception when calling GeneralDataProtectionRegulationApi->post_gdpr_requests: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gdpr/requests/{requestId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an existing GDPR request,"```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.GeneralDataProtectionRegulationApi(); request_id = 'request_id_example' # str | Request id try: # Get an existing GDPR request api_response = api_instance.get_gdpr_request(request_id) pprint(api_response) except ApiException as e: print(""Exception when calling GeneralDataProtectionRegulationApi->get_gdpr_request: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/gdpr/subjects Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get GDPR subjects,"```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.GeneralDataProtectionRegulationApi(); search_type = 'search_type_example' # str | Search Type search_value = 'search_value_example' # str | Search Value try: # Get GDPR subjects api_response = api_instance.get_gdpr_subjects(search_type, search_value) pprint(api_response) except ApiException as e: print(""Exception when calling GeneralDataProtectionRegulationApi->get_gdpr_subjects: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/geolocations/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a organization's GeolocationSettings,"```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.GeolocationApi(); try: # Get a organization's GeolocationSettings api_response = api_instance.get_geolocations_settings() pprint(api_response) except ApiException as e: print(""Exception when calling GeolocationApi->get_geolocations_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/geolocations/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch a organization's GeolocationSettings,"```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.GeolocationApi(); body = PureCloudPlatformClientV2.GeolocationSettings() # GeolocationSettings | Geolocation settings try: # Patch a organization's GeolocationSettings api_response = api_instance.patch_geolocations_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling GeolocationApi->patch_geolocations_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/geolocations/{clientId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a user's Geolocation,"```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.UsersApi(); user_id = 'user_id_example' # str | user Id client_id = 'client_id_example' # str | client Id try: # Get a user's Geolocation api_response = api_instance.get_user_geolocation(user_id, client_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_geolocation: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/geolocations/{clientId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Patch a user's Geolocation. The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.","```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.UsersApi(); user_id = 'user_id_example' # str | user Id client_id = 'client_id_example' # str | client Id body = PureCloudPlatformClientV2.Geolocation() # Geolocation | Geolocation try: # Patch a user's Geolocation api_response = api_instance.patch_user_geolocation(user_id, client_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_geolocation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/greetings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets an Organization's Greetings,"```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.GreetingsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Gets an Organization's Greetings api_response = api_instance.get_greetings(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->get_greetings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/greetings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Greeting for an Organization,"```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.GreetingsApi(); body = PureCloudPlatformClientV2.Greeting() # Greeting | The Greeting to create try: # Create a Greeting for an Organization api_response = api_instance.post_greetings(body) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->post_greetings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/greetings/defaults Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an Organization's DefaultGreetingList,"```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.GreetingsApi(); try: # Get an Organization's DefaultGreetingList api_response = api_instance.get_greetings_defaults() pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->get_greetings_defaults: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/greetings/defaults Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an Organization's DefaultGreetingList,"```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.GreetingsApi(); body = PureCloudPlatformClientV2.DefaultGreetingList() # DefaultGreetingList | The updated defaultGreetingList try: # Update an Organization's DefaultGreetingList api_response = api_instance.put_greetings_defaults(body) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->put_greetings_defaults: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/greetings/{greetingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a Greeting with the given GreetingId,"```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.GreetingsApi(); greeting_id = 'greeting_id_example' # str | Greeting ID try: # Deletes a Greeting with the given GreetingId api_instance.delete_greeting(greeting_id) except ApiException as e: print(""Exception when calling GreetingsApi->delete_greeting: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/greetings/{greetingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Greeting with the given GreetingId,"```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.GreetingsApi(); greeting_id = 'greeting_id_example' # str | Greeting ID try: # Get a Greeting with the given GreetingId api_response = api_instance.get_greeting(greeting_id) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->get_greeting: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/greetings/{greetingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates the Greeting with the given GreetingId,"```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.GreetingsApi(); greeting_id = 'greeting_id_example' # str | Greeting ID body = PureCloudPlatformClientV2.Greeting() # Greeting | The updated Greeting try: # Updates the Greeting with the given GreetingId api_response = api_instance.put_greeting(greeting_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->put_greeting: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/greetings/{greetingId}/media Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get media playback URI for this greeting,"```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.GreetingsApi(); greeting_id = 'greeting_id_example' # str | Greeting ID format_id = ''WAV'' # str | The desired media format. (optional) (default to 'WAV') try: # Get media playback URI for this greeting api_response = api_instance.get_greeting_media(greeting_id, format_id=format_id) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->get_greeting_media: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/groups/{groupId}/greetings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of the Group's Greetings,"```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.GreetingsApi(); group_id = 'group_id_example' # str | Group ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of the Group's Greetings api_response = api_instance.get_group_greetings(group_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->get_group_greetings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/groups/{groupId}/greetings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a Greeting for a Group,"```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.GreetingsApi(); group_id = 'group_id_example' # str | Group ID body = PureCloudPlatformClientV2.Greeting() # Greeting | The Greeting to create try: # Creates a Greeting for a Group api_response = api_instance.post_group_greetings(group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->post_group_greetings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/groups/{groupId}/greetings/defaults Genesys Cloud Python SDK.,Genesys describes this as an API used to: Grabs the list of Default Greetings given a Group's 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.GreetingsApi(); group_id = 'group_id_example' # str | Group ID try: # Grabs the list of Default Greetings given a Group's ID api_response = api_instance.get_group_greetings_defaults(group_id) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->get_group_greetings_defaults: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/groups/{groupId}/greetings/defaults Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates the DefaultGreetingList of the specified Group,"```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.GreetingsApi(); group_id = 'group_id_example' # str | Group ID body = PureCloudPlatformClientV2.DefaultGreetingList() # DefaultGreetingList | The updated defaultGreetingList try: # Updates the DefaultGreetingList of the specified Group api_response = api_instance.put_group_greetings_defaults(group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->put_group_greetings_defaults: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/greetings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of the User's Greetings,"```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.GreetingsApi(); user_id = 'user_id_example' # str | User ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of the User's Greetings api_response = api_instance.get_user_greetings(user_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->get_user_greetings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/{userId}/greetings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a Greeting for a 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.GreetingsApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.Greeting() # Greeting | The Greeting to create try: # Creates a Greeting for a User api_response = api_instance.post_user_greetings(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->post_user_greetings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/greetings/defaults Genesys Cloud Python SDK.,Genesys describes this as an API used to: Grabs the list of Default Greetings given a User's 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.GreetingsApi(); user_id = 'user_id_example' # str | User ID try: # Grabs the list of Default Greetings given a User's ID api_response = api_instance.get_user_greetings_defaults(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->get_user_greetings_defaults: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/greetings/defaults Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates the DefaultGreetingList of the specified 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.GreetingsApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.DefaultGreetingList() # DefaultGreetingList | The updated defaultGreetingList try: # Updates the DefaultGreetingList of the specified User api_response = api_instance.put_user_greetings_defaults(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GreetingsApi->put_user_greetings_defaults: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/groups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a group list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.GroupsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) id = ['id_example'] # list[str] | id (optional) jabber_id = ['jabber_id_example'] # list[str] | A list of jabberIds to fetch by bulk (cannot be used with the \""id\"" parameter) (optional) sort_order = ''ASC'' # str | Ascending or descending sort order (optional) (default to 'ASC') try: # Get a group list api_response = api_instance.get_groups(page_size=page_size, page_number=page_number, id=id, jabber_id=jabber_id, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling GroupsApi->get_groups: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/groups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a group,"```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.GroupsApi(); body = PureCloudPlatformClientV2.GroupCreate() # GroupCreate | Group try: # Create a group api_response = api_instance.post_groups(body) pprint(api_response) except ApiException as e: print(""Exception when calling GroupsApi->post_groups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/groups/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search groups using the q64 value returned from a previous search,"```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.SearchApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | expand (optional) try: # Search groups using the q64 value returned from a previous search api_response = api_instance.get_groups_search(q64, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->get_groups_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/groups/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search groups,"```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.SearchApi(); body = PureCloudPlatformClientV2.GroupSearchRequest() # GroupSearchRequest | Search request options try: # Search groups api_response = api_instance.post_groups_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->post_groups_search: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/groups/{groupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete group,"```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.GroupsApi(); group_id = 'group_id_example' # str | Group ID try: # Delete group api_instance.delete_group(group_id) except ApiException as e: print(""Exception when calling GroupsApi->delete_group: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/groups/{groupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get group,"```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.GroupsApi(); group_id = 'group_id_example' # str | Group ID try: # Get group api_response = api_instance.get_group(group_id) pprint(api_response) except ApiException as e: print(""Exception when calling GroupsApi->get_group: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/groups/{groupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update group,"```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.GroupsApi(); group_id = 'group_id_example' # str | Group ID body = PureCloudPlatformClientV2.GroupUpdate() # GroupUpdate | Group (optional) try: # Update group api_response = api_instance.put_group(group_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling GroupsApi->put_group: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/groups/{groupId}/individuals Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all individuals associated with the group,"```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.GroupsApi(); group_id = 'group_id_example' # str | Group ID try: # Get all individuals associated with the group api_response = api_instance.get_group_individuals(group_id) pprint(api_response) except ApiException as e: print(""Exception when calling GroupsApi->get_group_individuals: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/groups/{groupId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove members,"```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.GroupsApi(); group_id = 'group_id_example' # str | Group ID ids = 'ids_example' # str | Comma separated list of userIds to remove try: # Remove members api_response = api_instance.delete_group_members(group_id, ids) pprint(api_response) except ApiException as e: print(""Exception when calling GroupsApi->delete_group_members: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/groups/{groupId}/members Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get group members, includes individuals, owners, and dynamically included people","```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.GroupsApi(); group_id = 'group_id_example' # str | Group ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''ASC'' # str | Ascending or descending sort order (optional) (default to 'ASC') expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) try: # Get group members, includes individuals, owners, and dynamically included people api_response = api_instance.get_group_members(group_id, page_size=page_size, page_number=page_number, sort_order=sort_order, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling GroupsApi->get_group_members: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/groups/{groupId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add members,"```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.GroupsApi(); group_id = 'group_id_example' # str | Group ID body = PureCloudPlatformClientV2.GroupMembersUpdate() # GroupMembersUpdate | Add members try: # Add members api_response = api_instance.post_group_members(group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling GroupsApi->post_group_members: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of identity providers,"```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: # The list of identity providers api_response = api_instance.get_identityproviders() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/identityproviders Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create 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.CustomProvider() # CustomProvider | Provider try: # Create Identity Provider api_response = api_instance.post_identityproviders(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->post_identityproviders: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/adfs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete ADFS 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: # Delete ADFS Identity Provider api_response = api_instance.delete_identityproviders_adfs() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_adfs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders/adfs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get ADFS 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 ADFS Identity Provider api_response = api_instance.get_identityproviders_adfs() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders_adfs: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/identityproviders/adfs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/Create ADFS 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.ADFS() # ADFS | Provider try: # Update/Create ADFS Identity Provider api_response = api_instance.put_identityproviders_adfs(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->put_identityproviders_adfs: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/cic Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Customer Interaction Center (CIC) 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: # Delete Customer Interaction Center (CIC) Identity Provider api_response = api_instance.delete_identityproviders_cic() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_cic: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders/cic Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Customer Interaction Center (CIC) 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 Customer Interaction Center (CIC) Identity Provider api_response = api_instance.get_identityproviders_cic() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders_cic: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/identityproviders/cic Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/Create Customer Interaction Center (CIC) 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.CustomerInteractionCenter() # CustomerInteractionCenter | Provider try: # Update/Create Customer Interaction Center (CIC) Identity Provider api_response = api_instance.put_identityproviders_cic(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->put_identityproviders_cic: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/generic Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Generic SAML 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: # Delete Generic SAML Identity Provider api_response = api_instance.delete_identityproviders_generic() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_generic: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders/generic Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Generic SAML 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 Generic SAML Identity Provider api_response = api_instance.get_identityproviders_generic() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders_generic: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/identityproviders/generic Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/Create Generic SAML 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.GenericSAML() # GenericSAML | Provider try: # Update/Create Generic SAML Identity Provider api_response = api_instance.put_identityproviders_generic(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->put_identityproviders_generic: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/gsuite Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete G Suite 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: # Delete G Suite Identity Provider api_response = api_instance.delete_identityproviders_gsuite() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_gsuite: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders/gsuite Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get G Suite 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 G Suite Identity Provider api_response = api_instance.get_identityproviders_gsuite() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders_gsuite: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/identityproviders/gsuite Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/Create G Suite 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.GSuite() # GSuite | Provider try: # Update/Create G Suite Identity Provider api_response = api_instance.put_identityproviders_gsuite(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->put_identityproviders_gsuite: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/identitynow Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete IdentityNow 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: # Delete IdentityNow Provider api_response = api_instance.delete_identityproviders_identitynow() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_identitynow: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders/identitynow Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get IdentityNow 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 IdentityNow Provider api_response = api_instance.get_identityproviders_identitynow() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders_identitynow: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/identityproviders/identitynow Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/Create IdentityNow 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.IdentityNow() # IdentityNow | Provider try: # Update/Create IdentityNow Provider api_response = api_instance.put_identityproviders_identitynow(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->put_identityproviders_identitynow: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/okta Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Okta 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: # Delete Okta Identity Provider api_response = api_instance.delete_identityproviders_okta() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_okta: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders/okta Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Okta 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 Okta Identity Provider api_response = api_instance.get_identityproviders_okta() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders_okta: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/identityproviders/okta Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/Create Okta 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.Okta() # Okta | Provider try: # Update/Create Okta Identity Provider api_response = api_instance.put_identityproviders_okta(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->put_identityproviders_okta: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/onelogin Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete OneLogin 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: # Delete OneLogin Identity Provider api_response = api_instance.delete_identityproviders_onelogin() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_onelogin: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders/onelogin Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get OneLogin 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 OneLogin Identity Provider api_response = api_instance.get_identityproviders_onelogin() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders_onelogin: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/identityproviders/onelogin Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/Create OneLogin 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.OneLogin() # OneLogin | Provider try: # Update/Create OneLogin Identity Provider api_response = api_instance.put_identityproviders_onelogin(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->put_identityproviders_onelogin: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/ping Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Ping 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: # Delete Ping Identity Provider api_response = api_instance.delete_identityproviders_ping() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_ping: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders/ping Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Ping 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 Ping Identity Provider api_response = api_instance.get_identityproviders_ping() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders_ping: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/identityproviders/ping Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/Create Ping 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.PingIdentity() # PingIdentity | Provider try: # Update/Create Ping Identity Provider api_response = api_instance.put_identityproviders_ping(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->put_identityproviders_ping: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/purecloud Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete PureCloud 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: # Delete PureCloud Identity Provider api_response = api_instance.delete_identityproviders_purecloud() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_purecloud: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders/purecloud Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get PureCloud 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 PureCloud Identity Provider api_response = api_instance.get_identityproviders_purecloud() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders_purecloud: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/identityproviders/purecloud Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/Create PureCloud 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.PureCloud() # PureCloud | Provider try: # Update/Create PureCloud Identity Provider api_response = api_instance.put_identityproviders_purecloud(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->put_identityproviders_purecloud: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/pureengage Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete PureEngage 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: # Delete PureEngage Identity Provider api_response = api_instance.delete_identityproviders_pureengage() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_pureengage: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/identityproviders/pureengage Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get PureEngage 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 PureEngage Identity Provider api_response = api_instance.get_identityproviders_pureengage() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->get_identityproviders_pureengage: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/identityproviders/pureengage Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update/Create PureEngage 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.PureEngage() # PureEngage | Provider try: # Update/Create PureEngage Identity Provider api_response = api_instance.put_identityproviders_pureengage(body) pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->put_identityproviders_pureengage: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/identityproviders/salesforce Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete 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: # Delete Salesforce Identity Provider api_response = api_instance.delete_identityproviders_salesforce() pprint(api_response) except ApiException as e: print(""Exception when calling IdentityProviderApi->delete_identityproviders_salesforce: %s\n"" % e)```" 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)```" Provide a Python example that uses the GET /api/v2/journey/actiontargets/{actionTargetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a single action target.,"```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_target_id = 'action_target_id_example' # str | ID of the action target. try: # Retrieve a single action target. api_response = api_instance.get_journey_actiontarget(action_target_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_actiontarget: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/journey/actiontargets/{actionTargetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a single action target.,"```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_target_id = 'action_target_id_example' # str | ID of the action target. body = PureCloudPlatformClientV2.PatchActionTarget() # PatchActionTarget | (optional) try: # Update a single action target. api_response = api_instance.patch_journey_actiontarget(action_target_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->patch_journey_actiontarget: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/actiontemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve all action templates.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.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=name,-createdDate). (optional) media_type = 'media_type_example' # str | Media type (optional) state = 'state_example' # str | Action template state. (optional) query_fields = ['query_fields_example'] # list[str] | ActionTemplate 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 templates. api_response = api_instance.get_journey_actiontemplates(page_number=page_number, page_size=page_size, sort_by=sort_by, media_type=media_type, state=state, query_fields=query_fields, query_value=query_value) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_actiontemplates: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/actiontemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a single action template.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.JourneyApi(); body = PureCloudPlatformClientV2.ActionTemplate() # ActionTemplate | (optional) try: # Create a single action template. api_response = api_instance.post_journey_actiontemplates(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_actiontemplates: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/journey/actiontemplates/{actionTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a single action template.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.JourneyApi(); action_template_id = 'action_template_id_example' # str | ID of the action template. hard_delete = True # bool | Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (optional) try: # Delete a single action template. api_instance.delete_journey_actiontemplate(action_template_id, hard_delete=hard_delete) except ApiException as e: print(""Exception when calling JourneyApi->delete_journey_actiontemplate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/actiontemplates/{actionTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a single action template.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.JourneyApi(); action_template_id = 'action_template_id_example' # str | ID of the action template. try: # Retrieve a single action template. api_response = api_instance.get_journey_actiontemplate(action_template_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_actiontemplate: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/journey/actiontemplates/{actionTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a single action template.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.JourneyApi(); action_template_id = 'action_template_id_example' # str | ID of the action template. body = PureCloudPlatformClientV2.PatchActionTemplate() # PatchActionTemplate | (optional) try: # Update a single action template. api_response = api_instance.patch_journey_actiontemplate(action_template_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->patch_journey_actiontemplate: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/deployments/{deploymentId}/actionevent Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Sends an action event, which is used for changing the state of actions that have been offered to the user.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.JourneyApi(); deployment_id = 'deployment_id_example' # str | The ID of the deployment sending the beacon. body = PureCloudPlatformClientV2.ActionEventRequest() # ActionEventRequest | try: # Sends an action event, which is used for changing the state of actions that have been offered to the user. api_instance.post_journey_deployment_actionevent(deployment_id, body) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_deployment_actionevent: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/deployments/{deploymentId}/appevents Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Send a journey app event, used for tracking customer activity on an application.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.JourneyApi(); deployment_id = 'deployment_id_example' # str | The ID of the deployment sending the app event. body = PureCloudPlatformClientV2.AppEventRequest() # AppEventRequest | (optional) try: # Send a journey app event, used for tracking customer activity on an application. api_response = api_instance.post_journey_deployment_appevents(deployment_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_deployment_appevents: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send a ping.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.JourneyApi(); deployment_id = 'deployment_id_example' # str | The ID of the deployment sending the ping. customer_cookie_id = 'customer_cookie_id_example' # str | ID of the customer associated with the ping. dl = 'dl_example' # str | Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions. (optional) dt = 'dt_example' # str | Document Title. A human readable name for the page or screen (optional) app_namespace = 'app_namespace_example' # str | Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions (optional) session_id = 'session_id_example' # str | UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session (optional) since_last_beacon_milliseconds = 56 # int | How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings. (optional) try: # Send a ping. api_response = api_instance.get_journey_deployment_customer_ping(deployment_id, customer_cookie_id, dl=dl, dt=dt, app_namespace=app_namespace, session_id=session_id, since_last_beacon_milliseconds=since_last_beacon_milliseconds) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_deployment_customer_ping: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/deployments/{deploymentId}/webevents Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Send a journey web event, used for tracking customer activity on a website.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.JourneyApi(); deployment_id = 'deployment_id_example' # str | The ID of the deployment sending the web event. body = PureCloudPlatformClientV2.WebEventRequest() # WebEventRequest | (optional) try: # Send a journey web event, used for tracking customer activity on a website. api_response = api_instance.post_journey_deployment_webevents(deployment_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_deployment_webevents: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/flows/paths/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for flow paths.,"```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.FlowPathsQuery() # FlowPathsQuery | (optional) try: # Query for flow paths. api_response = api_instance.post_journey_flows_paths_query(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_flows_paths_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/outcomes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve all outcomes.,"```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. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). (optional) outcome_ids = ['outcome_ids_example'] # list[str] | IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request. (optional) query_fields = ['query_fields_example'] # list[str] | Outcome 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 outcomes. api_response = api_instance.get_journey_outcomes(page_number=page_number, page_size=page_size, sort_by=sort_by, outcome_ids=outcome_ids, query_fields=query_fields, query_value=query_value) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_outcomes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/outcomes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an outcome.,"```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.OutcomeRequest() # OutcomeRequest | (optional) try: # Create an outcome. api_response = api_instance.post_journey_outcomes(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_outcomes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/outcomes/predictors Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve all outcome predictors.,"```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(); try: # Retrieve all outcome predictors. api_response = api_instance.get_journey_outcomes_predictors() pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_outcomes_predictors: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/outcomes/predictors Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an outcome predictor.,"```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.OutcomePredictorRequest() # OutcomePredictorRequest | (optional) try: # Create an outcome predictor. api_response = api_instance.post_journey_outcomes_predictors(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_outcomes_predictors: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/journey/outcomes/predictors/{predictorId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an outcome predictor.,"```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(); predictor_id = 'predictor_id_example' # str | ID of predictor try: # Delete an outcome predictor. api_instance.delete_journey_outcomes_predictor(predictor_id) except ApiException as e: print(""Exception when calling JourneyApi->delete_journey_outcomes_predictor: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/outcomes/predictors/{predictorId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a single outcome predictor.,"```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(); predictor_id = 'predictor_id_example' # str | ID of predictor try: # Retrieve a single outcome predictor. api_response = api_instance.get_journey_outcomes_predictor(predictor_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_outcomes_predictor: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/journey/outcomes/{outcomeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an outcome.,"```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(); outcome_id = 'outcome_id_example' # str | ID of the outcome. try: # Delete an outcome. api_instance.delete_journey_outcome(outcome_id) except ApiException as e: print(""Exception when calling JourneyApi->delete_journey_outcome: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/outcomes/{outcomeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a single outcome.,"```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(); outcome_id = 'outcome_id_example' # str | ID of the outcome. try: # Retrieve a single outcome. api_response = api_instance.get_journey_outcome(outcome_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_outcome: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/journey/outcomes/{outcomeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an outcome.,"```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(); outcome_id = 'outcome_id_example' # str | ID of the outcome. body = PureCloudPlatformClientV2.PatchOutcome() # PatchOutcome | (optional) try: # Update an outcome. api_response = api_instance.patch_journey_outcome(outcome_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->patch_journey_outcome: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/segments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve all segments.,"```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(); sort_by = 'sort_by_example' # str | Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate). (optional) page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) is_active = True # bool | Determines whether or not to show only active segments. (optional) segment_ids = ['segment_ids_example'] # list[str] | IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request. (optional) query_fields = ['query_fields_example'] # list[str] | Segment 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 segments. api_response = api_instance.get_journey_segments(sort_by=sort_by, page_size=page_size, page_number=page_number, is_active=is_active, segment_ids=segment_ids, query_fields=query_fields, query_value=query_value) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_segments: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/segments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a segment.,"```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.JourneySegmentRequest() # JourneySegmentRequest | (optional) try: # Create a segment. api_response = api_instance.post_journey_segments(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_segments: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/journey/segments/{segmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a segment.,"```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(); segment_id = 'segment_id_example' # str | ID of the segment. try: # Delete a segment. api_instance.delete_journey_segment(segment_id) except ApiException as e: print(""Exception when calling JourneyApi->delete_journey_segment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/segments/{segmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a single segment.,"```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(); segment_id = 'segment_id_example' # str | ID of the segment. try: # Retrieve a single segment. api_response = api_instance.get_journey_segment(segment_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_segment: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/journey/segments/{segmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a segment.,"```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(); segment_id = 'segment_id_example' # str | ID of the segment. body = PureCloudPlatformClientV2.PatchSegment() # PatchSegment | (optional) try: # Update a segment. api_response = api_instance.patch_journey_segment(segment_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->patch_journey_segment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/sessions/{sessionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a single session.,"```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(); session_id = 'session_id_example' # str | ID of the session. try: # Retrieve a single session. api_response = api_instance.get_journey_session(session_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_session: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/sessions/{sessionId}/events Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve all events for a given session.,"```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(); session_id = 'session_id_example' # str | System-generated UUID that represents the session the event is a part of. 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) event_type = 'event_type_example' # str | A comma separated list of journey event types to include in the results. (optional) try: # Retrieve all events for a given session. api_response = api_instance.get_journey_session_events(session_id, page_size=page_size, after=after, event_type=event_type) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_session_events: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/sessions/{sessionId}/outcomescores Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve latest outcome score associated with a session for all outcomes.,"```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(); session_id = 'session_id_example' # str | ID of the session. try: # Retrieve latest outcome score associated with a session for all outcomes. api_response = api_instance.get_journey_session_outcomescores(session_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_session_outcomescores: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/views Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Journey Views,"```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) name_or_created_by = 'name_or_created_by_example' # str | Journey View Name or Created By (optional) expand = 'expand_example' # str | Parameter to request additional data to return in Journey payload (optional) id = 'id_example' # str | Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items. (optional) try: # Get a list of Journey Views api_response = api_instance.get_journey_views(page_number=page_number, page_size=page_size, name_or_created_by=name_or_created_by, expand=expand, id=id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_views: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/views Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new Journey View,"```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.JourneyView() # JourneyView | JourneyView try: # Create a new Journey View api_response = api_instance.post_journey_views(body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_views: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/views/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the jobs for an organization.,"```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 | The number of the page to return (optional) (default to 1) page_size = 25 # int | Max number of entities to return (optional) (default to 25) interval = '2023-07-17T00:00:00Z/2023-07-18T00:00:00Z' # str | An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval. (optional) statuses = 'statuses=Accepted,Executing,Complete,Failed' # str | Job statuses to filter for (optional) try: # Get the jobs for an organization. api_response = api_instance.get_journey_views_jobs(page_number=page_number, page_size=page_size, interval=interval, statuses=statuses) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_views_jobs: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/journey/views/{viewId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Journey View by ID. deletes all versions,"```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(); view_id = 'view_id_example' # str | viewId try: # Delete a Journey View by ID api_instance.delete_journey_view(view_id) except ApiException as e: print(""Exception when calling JourneyApi->delete_journey_view: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/views/{viewId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Journey View by ID. returns the latest version,"```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(); view_id = 'view_id_example' # str | viewId try: # Get a Journey View by ID api_response = api_instance.get_journey_view(view_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_view: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/views/{viewId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Journey View by ID. creates a new version,"```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(); view_id = 'view_id_example' # str | viewId body = PureCloudPlatformClientV2.JourneyView() # JourneyView | JourneyView try: # Update a Journey View by ID api_response = api_instance.post_journey_view_versions(view_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_view_versions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Submit a job request for a journey view version. used for long descriptions,"```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(); view_id = 'view_id_example' # str | Journey View Id journey_version_id = 'journey_version_id_example' # str | Journey View Version try: # Submit a job request for a journey view version. api_response = api_instance.post_journey_view_version_jobs(view_id, journey_version_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->post_journey_view_version_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/latest Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the latest job of a journey view version. used for long descriptions,"```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(); view_id = 'view_id_example' # str | Journey View Id journey_version_id = 'journey_version_id_example' # str | Journey View Version try: # Get the latest job of a journey view version. api_response = api_instance.get_journey_view_version_jobs_latest(view_id, journey_version_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_view_version_jobs_latest: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the job for a journey view version. used for long descriptions,"```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(); view_id = 'view_id_example' # str | Journey View Id journey_version_id = 'journey_version_id_example' # str | Journey View Version job_id = 'job_id_example' # str | JobId try: # Get the job for a journey view version. api_response = api_instance.get_journey_view_version_job(view_id, journey_version_id, job_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_view_version_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/jobs/{jobId}/results Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the result of a job for a journey view version. used for long descriptions,"```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(); view_id = 'view_id_example' # str | JourneyViewResult id journey_view_version = 'journey_view_version_example' # str | Journey View Version job_id = 'job_id_example' # str | Id of the executing job try: # Get the result of a job for a journey view version. api_response = api_instance.get_journey_view_version_job_results(view_id, journey_view_version, job_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_view_version_job_results: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/journey/views/{viewId}/versions/{versionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Journey View by ID and version,"```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(); view_id = 'view_id_example' # str | viewId version_id = 'version_id_example' # str | versionId try: # Get a Journey View by ID and version api_response = api_instance.get_journey_view_version(view_id, version_id) pprint(api_response) except ApiException as e: print(""Exception when calling JourneyApi->get_journey_view_version: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/documentuploads Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a presigned URL for uploading a knowledge import file with a set of documents,"```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.UploadsApi(); body = PureCloudPlatformClientV2.UploadUrlRequest() # UploadUrlRequest | query try: # Creates a presigned URL for uploading a knowledge import file with a set of documents api_response = api_instance.post_knowledge_documentuploads(body) pprint(api_response) except ApiException as e: print(""Exception when calling UploadsApi->post_knowledge_documentuploads: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/guest/sessions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create guest session,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); body = PureCloudPlatformClientV2.KnowledgeGuestSession() # KnowledgeGuestSession | try: # Create guest session api_response = api_instance.post_knowledge_guest_sessions(body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_guest_sessions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/guest/sessions/{sessionId}/categories Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get categories,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) parent_id = 'parent_id_example' # str | If specified, retrieves the children categories by parent category ID. (optional) is_root = True # bool | If specified, retrieves only the root categories. (optional) name = 'name_example' # str | Filter to return the categories that starts with the given category name. (optional) sort_by = ''Name'' # str | Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (optional) (default to 'Name') expand = 'expand_example' # str | The specified entity attribute will be filled. Supported value:\""Ancestors\"": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. (optional) include_document_count = True # bool | If specified, retrieves the number of documents related to category. (optional) try: # Get categories api_response = api_instance.get_knowledge_guest_session_categories(session_id, before=before, after=after, page_size=page_size, parent_id=parent_id, is_root=is_root, name=name, sort_by=sort_by, expand=expand, include_document_count=include_document_count) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_guest_session_categories: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/guest/sessions/{sessionId}/documents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get documents.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. category_id = ['category_id_example'] # list[str] | If specified, retrieves documents associated with category ids, comma separated values expected. (optional) page_size = 56 # int | Number of entities to return. Maximum of 200. (optional) try: # Get documents. api_response = api_instance.get_knowledge_guest_session_documents(session_id, category_id=category_id, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_guest_session_documents: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/answers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Answer documents.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. body = PureCloudPlatformClientV2.KnowledgeDocumentsAnswerFilter() # KnowledgeDocumentsAnswerFilter | try: # Answer documents. api_response = api_instance.post_knowledge_guest_session_documents_answers(session_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_guest_session_documents_answers: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/presentations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Indicate that documents were presented to the user.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. body = PureCloudPlatformClientV2.KnowledgeGuestDocumentPresentation() # KnowledgeGuestDocumentPresentation | (optional) try: # Indicate that documents were presented to the user. api_instance.post_knowledge_guest_session_documents_presentations(session_id, body=body) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_guest_session_documents_presentations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search the documents in a guest session.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. expand = ['expand_example'] # list[str] | Fields, if any, to expand for each document in the search result matching the query. (optional) body = PureCloudPlatformClientV2.KnowledgeDocumentGuestSearchRequest() # KnowledgeDocumentGuestSearchRequest | (optional) try: # Search the documents in a guest session. api_response = api_instance.post_knowledge_guest_session_documents_search(session_id, expand=expand, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_guest_session_documents_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/search/suggestions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the knowledge documents to provide suggestions for auto completion.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. body = PureCloudPlatformClientV2.KnowledgeGuestDocumentSuggestionRequest() # KnowledgeGuestDocumentSuggestionRequest | (optional) try: # Query the knowledge documents to provide suggestions for auto completion. api_response = api_instance.post_knowledge_guest_session_documents_search_suggestions(session_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_guest_session_documents_search_suggestions: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/knowledge/guest/sessions/{sessionId}/documents/search/{searchId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update search result.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. search_id = 'search_id_example' # str | Search Result ID body = PureCloudPlatformClientV2.SearchUpdateRequest() # SearchUpdateRequest | try: # Update search result. api_instance.patch_knowledge_guest_session_documents_search_search_id(session_id, search_id, body) except ApiException as e: print(""Exception when calling KnowledgeApi->patch_knowledge_guest_session_documents_search_search_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a knowledge document by ID.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. document_id = 'document_id_example' # str | Document ID try: # Get a knowledge document by ID. api_response = api_instance.get_knowledge_guest_session_document(session_id, document_id) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_guest_session_document: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/copies Genesys Cloud Python SDK.,Genesys describes this as an API used to: Indicate that the document was copied by the user.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. document_id = 'document_id_example' # str | Document ID body = PureCloudPlatformClientV2.KnowledgeGuestDocumentCopy() # KnowledgeGuestDocumentCopy | (optional) try: # Indicate that the document was copied by the user. api_instance.post_knowledge_guest_session_document_copies(session_id, document_id, body=body) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_guest_session_document_copies: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Give feedback on a document,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. document_id = 'document_id_example' # str | Document ID. body = PureCloudPlatformClientV2.KnowledgeGuestDocumentFeedback() # KnowledgeGuestDocumentFeedback | (optional) try: # Give feedback on a document api_response = api_instance.post_knowledge_guest_session_document_feedback(session_id, document_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_guest_session_document_feedback: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/views Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create view event for a document.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.KnowledgeApi(); session_id = 'session_id_example' # str | Knowledge guest session ID. document_id = 'document_id_example' # str | Document ID body = PureCloudPlatformClientV2.KnowledgeGuestDocumentView() # KnowledgeGuestDocumentView | (optional) try: # Create view event for a document. api_instance.post_knowledge_guest_session_document_views(session_id, document_id, body=body) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_guest_session_document_views: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get knowledge bases,"```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.KnowledgeApi(); before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) limit = 'limit_example' # str | Number of entities to return. Maximum of 100. Deprecated in favour of pageSize (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 100. (optional) name = 'name_example' # str | Filter by Name. (optional) core_language = 'core_language_example' # str | Filter by core language. (optional) published = True # bool | Filter by published status. (optional) sort_by = 'sort_by_example' # str | Sort by. (optional) sort_order = 'sort_order_example' # str | Sort Order. (optional) try: # Get knowledge bases api_response = api_instance.get_knowledge_knowledgebases(before=before, after=after, limit=limit, page_size=page_size, name=name, core_language=core_language, published=published, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebases: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create new knowledge base,"```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.KnowledgeApi(); body = PureCloudPlatformClientV2.KnowledgeBaseCreateRequest() # KnowledgeBaseCreateRequest | try: # Create new knowledge base api_response = api_instance.post_knowledge_knowledgebases(body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebases: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete knowledge base,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID try: # Delete knowledge base api_response = api_instance.delete_knowledge_knowledgebase(knowledge_base_id) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->delete_knowledge_knowledgebase: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get knowledge base,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID try: # Get knowledge base api_response = api_instance.get_knowledge_knowledgebase(knowledge_base_id) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update knowledge base,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID body = PureCloudPlatformClientV2.KnowledgeBaseUpdateRequest() # KnowledgeBaseUpdateRequest | try: # Update knowledge base api_response = api_instance.patch_knowledge_knowledgebase(knowledge_base_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->patch_knowledge_knowledgebase: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get categories,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) parent_id = 'parent_id_example' # str | If specified, retrieves the children categories by parent category ID. (optional) is_root = True # bool | If specified, retrieves only the root categories. (optional) name = 'name_example' # str | Filter to return the categories that starts with the given category name. (optional) sort_by = ''Name'' # str | Name: sort by category names alphabetically; Hierarchy: sort by the full path of hierarchical category names alphabetically (optional) (default to 'Name') expand = 'expand_example' # str | The specified entity attribute will be filled. Supported value:\""Ancestors\"": every ancestors will be filled via the parent attribute recursively,but only the id, name, parentId will be present for the ancestors. (optional) include_document_count = True # bool | If specified, retrieves the number of documents related to category. (optional) try: # Get categories api_response = api_instance.get_knowledge_knowledgebase_categories(knowledge_base_id, before=before, after=after, page_size=page_size, parent_id=parent_id, is_root=is_root, name=name, sort_by=sort_by, expand=expand, include_document_count=include_document_count) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_categories: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create new category,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID body = PureCloudPlatformClientV2.CategoryCreateRequest() # CategoryCreateRequest | try: # Create new category api_response = api_instance.post_knowledge_knowledgebase_categories(knowledge_base_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_categories: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete category,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID category_id = 'category_id_example' # str | Category ID try: # Delete category api_response = api_instance.delete_knowledge_knowledgebase_category(knowledge_base_id, category_id) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->delete_knowledge_knowledgebase_category: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get category,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID category_id = 'category_id_example' # str | Category ID try: # Get category api_response = api_instance.get_knowledge_knowledgebase_category(knowledge_base_id, category_id) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_category: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/categories/{categoryId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update category,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID category_id = 'category_id_example' # str | Category ID body = PureCloudPlatformClientV2.CategoryUpdateRequest() # CategoryUpdateRequest | try: # Update category api_response = api_instance.patch_knowledge_knowledgebase_category(knowledge_base_id, category_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_category: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get documents.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) interval = 'interval_example' # str | Retrieves the documents modified in specified date and time range. If the after and before cursor parameters are within this interval, it would return valid data, otherwise it throws an error.The dates in the interval are represented in ISO-8601 format: YYYY-MM-DDThh:mm:ssZ/YYYY-MM-DDThh:mm:ssZ (optional) document_id = ['document_id_example'] # list[str] | Retrieves the specified documents, comma separated values expected. (optional) category_id = ['category_id_example'] # list[str] | If specified, retrieves documents associated with category ids, comma separated values expected. (optional) include_subcategories = True # bool | Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories. (optional) include_drafts = True # bool | If includeDrafts is true, Documents in the draft state are also returned in the response. (optional) label_ids = ['label_ids_example'] # list[str] | If specified, retrieves documents associated with label ids, comma separated values expected. (optional) expand = ['expand_example'] # list[str] | The specified entity attributes will be filled. Comma separated values expected. (optional) external_ids = ['external_ids_example'] # list[str] | If specified, retrieves documents associated with external ids, comma separated values expected. (optional) try: # Get documents. api_response = api_instance.get_knowledge_knowledgebase_documents(knowledge_base_id, before=before, after=after, page_size=page_size, interval=interval, document_id=document_id, category_id=category_id, include_subcategories=include_subcategories, include_drafts=include_drafts, label_ids=label_ids, expand=expand, external_ids=external_ids) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_documents: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create document.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID body = PureCloudPlatformClientV2.KnowledgeDocumentReq() # KnowledgeDocumentReq | try: # Create document. api_response = api_instance.post_knowledge_knowledgebase_documents(knowledge_base_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_documents: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Answer documents.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID body = PureCloudPlatformClientV2.KnowledgeDocumentsAnswerFilter() # KnowledgeDocumentsAnswerFilter | try: # Answer documents. api_response = api_instance.post_knowledge_knowledgebase_documents_answers(knowledge_base_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_documents_answers: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/presentations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Indicate that documents were presented to the 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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID. body = PureCloudPlatformClientV2.KnowledgeDocumentPresentation() # KnowledgeDocumentPresentation | (optional) try: # Indicate that documents were presented to the user. api_instance.post_knowledge_knowledgebase_documents_presentations(knowledge_base_id, body=body) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_documents_presentations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for knowledge documents.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge Base ID expand = ['expand_example'] # list[str] | Fields, if any, to expand for each document in the search result matching the query. (optional) body = PureCloudPlatformClientV2.KnowledgeDocumentQuery() # KnowledgeDocumentQuery | (optional) try: # Query for knowledge documents. api_response = api_instance.post_knowledge_knowledgebase_documents_query(knowledge_base_id, expand=expand, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_documents_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search the documents in a knowledge base.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | The ID of knowledge base containing the documents to query. expand = ['expand_example'] # list[str] | Fields, if any, to expand for each document in the search result matching the query. (optional) body = PureCloudPlatformClientV2.KnowledgeDocumentSearchRequest() # KnowledgeDocumentSearchRequest | (optional) try: # Search the documents in a knowledge base. api_response = api_instance.post_knowledge_knowledgebase_documents_search(knowledge_base_id, expand=expand, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_documents_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/suggestions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the knowledge documents to provide suggestions for auto completion.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | The ID of knowledge base containing the documents to query. body = PureCloudPlatformClientV2.KnowledgeDocumentSuggestionRequest() # KnowledgeDocumentSuggestionRequest | (optional) try: # Query the knowledge documents to provide suggestions for auto completion. api_response = api_instance.post_knowledge_knowledgebase_documents_search_suggestions(knowledge_base_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_documents_search_suggestions: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/search/{searchId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update search result.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | The ID of knowledge base containing the documents to query. search_id = 'search_id_example' # str | Search Result ID body = PureCloudPlatformClientV2.SearchUpdateRequest() # SearchUpdateRequest | (optional) try: # Update search result. api_instance.patch_knowledge_knowledgebase_documents_search_search_id(knowledge_base_id, search_id, body=body) except ApiException as e: print(""Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_documents_search_search_id: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete document.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID. document_id = 'document_id_example' # str | Document ID. try: # Delete document. api_instance.delete_knowledge_knowledgebase_document(knowledge_base_id, document_id) except ApiException as e: print(""Exception when calling KnowledgeApi->delete_knowledge_knowledgebase_document: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get document.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID. document_id = 'document_id_example' # str | Document ID. expand = ['expand_example'] # list[str] | The specified entity attributes will be filled. Comma separated values expected. Max No. of variations that can be returned on expand is 20. (optional) state = 'state_example' # str | \""when state is \""Draft\"", draft version of the document is returned,otherwise by default published version is returned in the response. (optional) try: # Get document. api_response = api_instance.get_knowledge_knowledgebase_document(knowledge_base_id, document_id, expand=expand, state=state) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_document: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update document.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID. document_id = 'document_id_example' # str | Document ID. body = PureCloudPlatformClientV2.KnowledgeDocumentReq() # KnowledgeDocumentReq | try: # Update document. api_response = api_instance.patch_knowledge_knowledgebase_document(knowledge_base_id, document_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_document: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/copies Genesys Cloud Python SDK.,Genesys describes this as an API used to: Indicate that the document was copied by the 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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID. document_id = 'document_id_example' # str | Document ID. body = PureCloudPlatformClientV2.KnowledgeDocumentCopy() # KnowledgeDocumentCopy | (optional) try: # Indicate that the document was copied by the user. api_instance.post_knowledge_knowledgebase_document_copies(knowledge_base_id, document_id, body=body) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_document_copies: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of feedback records given on a document,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID. document_id = 'document_id_example' # str | Document ID. before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) only_commented = True # bool | If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false. (optional) document_version_id = 'document_version_id_example' # str | Document version ID to filter by. Supported only if onlyCommented=true is set. (optional) document_variation_id = 'document_variation_id_example' # str | Document variation ID to filter by. Supported only if onlyCommented=true is set. (optional) app_type = 'app_type_example' # str | Application type to filter by. Supported only if onlyCommented=true is set. (optional) query_type = 'query_type_example' # str | Query type to filter by. Supported only if onlyCommented=true is set. (optional) user_id = 'user_id_example' # str | The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set. (optional) queue_id = 'queue_id_example' # str | Queue ID to filter by. Supported only if onlyCommented=true is set. (optional) state = 'state_example' # str | State to filter by. Supported only if onlyCommented=true is set. Default: Final (optional) try: # Get a list of feedback records given on a document api_response = api_instance.get_knowledge_knowledgebase_document_feedback(knowledge_base_id, document_id, before=before, after=after, page_size=page_size, only_commented=only_commented, document_version_id=document_version_id, document_variation_id=document_variation_id, app_type=app_type, query_type=query_type, user_id=user_id, queue_id=queue_id, state=state) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_document_feedback: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Give feedback on a document,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID. document_id = 'document_id_example' # str | Document ID. body = PureCloudPlatformClientV2.KnowledgeDocumentFeedback() # KnowledgeDocumentFeedback | (optional) try: # Give feedback on a document api_response = api_instance.post_knowledge_knowledgebase_document_feedback(knowledge_base_id, document_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_document_feedback: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a single feedback record given on a document,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID. document_id = 'document_id_example' # str | Document ID. feedback_id = 'feedback_id_example' # str | Feedback ID. try: # Get a single feedback record given on a document api_response = api_instance.get_knowledge_knowledgebase_document_feedback_feedback_id(knowledge_base_id, document_id, feedback_id) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_document_feedback_feedback_id: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update feedback on a document,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID. document_id = 'document_id_example' # str | Document ID. feedback_id = 'feedback_id_example' # str | Feedback ID. body = PureCloudPlatformClientV2.KnowledgeDocumentFeedbackUpdateRequest() # KnowledgeDocumentFeedbackUpdateRequest | (optional) try: # Update feedback on a document api_response = api_instance.patch_knowledge_knowledgebase_document_feedback_feedback_id(knowledge_base_id, document_id, feedback_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_document_feedback_feedback_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get variations for a document.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Globally unique identifier for the knowledge base. document_id = 'document_id_example' # str | Globally unique identifier for the document. before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) document_state = 'document_state_example' # str | The state of the document. (optional) try: # Get variations for a document. api_response = api_instance.get_knowledge_knowledgebase_document_variations(knowledge_base_id, document_id, before=before, after=after, page_size=page_size, document_state=document_state) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_document_variations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a variation for a document.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Globally unique identifier for the knowledge base. document_id = 'document_id_example' # str | Globally unique identifier for the document. body = PureCloudPlatformClientV2.DocumentVariation() # DocumentVariation | try: # Create a variation for a document. api_response = api_instance.post_knowledge_knowledgebase_document_variations(knowledge_base_id, document_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_document_variations: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a variation for a document.,"```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.KnowledgeApi(); document_variation_id = 'document_variation_id_example' # str | Globally unique identifier for a document variation. document_id = 'document_id_example' # str | Globally unique identifier for a document. knowledge_base_id = 'knowledge_base_id_example' # str | Globally unique identifier for a knowledge base. try: # Delete a variation for a document. api_instance.delete_knowledge_knowledgebase_document_variation(document_variation_id, document_id, knowledge_base_id) except ApiException as e: print(""Exception when calling KnowledgeApi->delete_knowledge_knowledgebase_document_variation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a variation for a document.,"```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.KnowledgeApi(); document_variation_id = 'document_variation_id_example' # str | Globally unique identifier for a document variation. document_id = 'document_id_example' # str | Globally unique identifier for a document. knowledge_base_id = 'knowledge_base_id_example' # str | Globally unique identifier for a knowledge base. document_state = 'document_state_example' # str | The state of the document. (optional) try: # Get a variation for a document. api_response = api_instance.get_knowledge_knowledgebase_document_variation(document_variation_id, document_id, knowledge_base_id, document_state=document_state) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_document_variation: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/variations/{documentVariationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a variation for a document.,"```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.KnowledgeApi(); document_variation_id = 'document_variation_id_example' # str | Globally unique identifier for a document variation. document_id = 'document_id_example' # str | Globally unique identifier for a document. knowledge_base_id = 'knowledge_base_id_example' # str | Globally unique identifier for a knowledge base. body = PureCloudPlatformClientV2.DocumentVariation() # DocumentVariation | try: # Update a variation for a document. api_response = api_instance.patch_knowledge_knowledgebase_document_variation(document_variation_id, document_id, knowledge_base_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_document_variation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get document versions.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Globally unique identifier for the knowledge base. document_id = 'document_id_example' # str | Globally unique identifier for the document. before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) expand = ['expand_example'] # list[str] | The specified entity attributes will be filled. Comma separated values expected. (optional) try: # Get document versions. api_response = api_instance.get_knowledge_knowledgebase_document_versions(knowledge_base_id, document_id, before=before, after=after, page_size=page_size, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_document_versions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates or restores a document version.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Globally unique identifier for the knowledge base. document_id = 'document_id_example' # str | Globally unique identifier for the document. body = PureCloudPlatformClientV2.KnowledgeDocumentVersion() # KnowledgeDocumentVersion | try: # Creates or restores a document version. api_response = api_instance.post_knowledge_knowledgebase_document_versions(knowledge_base_id, document_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_document_versions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get document version.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Globally unique identifier for the knowledge base. document_id = 'document_id_example' # str | Globally unique identifier for the document. version_id = 'version_id_example' # str | Globally unique identifier for the document version. expand = ['expand_example'] # list[str] | The specified entity attributes will be filled. Comma separated values expected. (optional) try: # Get document version. api_response = api_instance.get_knowledge_knowledgebase_document_version(knowledge_base_id, document_id, version_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_document_version: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get variations for the given document version.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Globally unique identifier for the knowledge base. document_id = 'document_id_example' # str | Globally unique identifier for the document. version_id = 'version_id_example' # str | Globally unique identifier for the document version. before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) try: # Get variations for the given document version. api_response = api_instance.get_knowledge_knowledgebase_document_version_variations(knowledge_base_id, document_id, version_id, before=before, after=after, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_document_version_variations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/versions/{versionId}/variations/{variationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get variation for the given document version.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Globally unique identifier for the knowledge base. document_id = 'document_id_example' # str | Globally unique identifier for the document. version_id = 'version_id_example' # str | Globally unique identifier for the document version. variation_id = 'variation_id_example' # str | Globally unique identifier for the document version variation. try: # Get variation for the given document version. api_response = api_instance.get_knowledge_knowledgebase_document_version_variation(knowledge_base_id, document_id, version_id, variation_id) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_document_version_variation: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create view for a document.,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID. document_id = 'document_id_example' # str | Document ID. body = PureCloudPlatformClientV2.KnowledgeDocumentView() # KnowledgeDocumentView | (optional) try: # Create view for a document. api_instance.post_knowledge_knowledgebase_document_views(knowledge_base_id, document_id, body=body) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_document_views: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create export 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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID body = PureCloudPlatformClientV2.KnowledgeExportJobRequest() # KnowledgeExportJobRequest | try: # Create export job api_response = api_instance.post_knowledge_knowledgebase_export_jobs(knowledge_base_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_export_jobs: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete export 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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID export_job_id = 'export_job_id_example' # str | Export job ID try: # Delete export job api_instance.delete_knowledge_knowledgebase_export_job(knowledge_base_id, export_job_id) except ApiException as e: print(""Exception when calling KnowledgeApi->delete_knowledge_knowledgebase_export_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/export/jobs/{exportJobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get export job report,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID export_job_id = 'export_job_id_example' # str | Export job ID try: # Get export job report api_response = api_instance.get_knowledge_knowledgebase_export_job(knowledge_base_id, export_job_id) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_export_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create import 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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID body = PureCloudPlatformClientV2.KnowledgeImportJobRequest() # KnowledgeImportJobRequest | try: # Create import job api_response = api_instance.post_knowledge_knowledgebase_import_jobs(knowledge_base_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_import_jobs: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete import 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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID import_job_id = 'import_job_id_example' # str | Import job ID try: # Delete import job api_instance.delete_knowledge_knowledgebase_import_job(knowledge_base_id, import_job_id) except ApiException as e: print(""Exception when calling KnowledgeApi->delete_knowledge_knowledgebase_import_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get import job report,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID import_job_id = 'import_job_id_example' # str | Import job ID expand = ['expand_example'] # list[str] | If expand contains 'urls' downloadURL and failedEntitiesURL will be filled. (optional) try: # Get import job report api_response = api_instance.get_knowledge_knowledgebase_import_job(knowledge_base_id, import_job_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_import_job: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Start import 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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID import_job_id = 'import_job_id_example' # str | Import job ID body = PureCloudPlatformClientV2.ImportStatusRequest() # ImportStatusRequest | try: # Start import job api_response = api_instance.patch_knowledge_knowledgebase_import_job(knowledge_base_id, import_job_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_import_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get labels,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) name = 'name_example' # str | Filter to return the labels that contains the given phrase in the name. (optional) include_document_count = True # bool | If specified, retrieves the number of documents related to label. (optional) try: # Get labels api_response = api_instance.get_knowledge_knowledgebase_labels(knowledge_base_id, before=before, after=after, page_size=page_size, name=name, include_document_count=include_document_count) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_labels: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create new label,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID body = PureCloudPlatformClientV2.LabelCreateRequest() # LabelCreateRequest | try: # Create new label api_response = api_instance.post_knowledge_knowledgebase_labels(knowledge_base_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->post_knowledge_knowledgebase_labels: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete label,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID label_id = 'label_id_example' # str | Label ID try: # Delete label api_response = api_instance.delete_knowledge_knowledgebase_label(knowledge_base_id, label_id) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->delete_knowledge_knowledgebase_label: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get label,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID label_id = 'label_id_example' # str | Label ID try: # Get label api_response = api_instance.get_knowledge_knowledgebase_label(knowledge_base_id, label_id) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_label: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/labels/{labelId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update label,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID label_id = 'label_id_example' # str | Label ID body = PureCloudPlatformClientV2.LabelUpdateRequest() # LabelUpdateRequest | try: # Update label api_response = api_instance.patch_knowledge_knowledgebase_label(knowledge_base_id, label_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_label: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get knowledge base unanswered groups,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID app = 'app_example' # str | The app value to be used for filtering phrases. (optional) date_start = '2013-10-20' # date | The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) date_end = '2013-10-20' # date | The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) try: # Get knowledge base unanswered groups api_response = api_instance.get_knowledge_knowledgebase_unanswered_groups(knowledge_base_id, app=app, date_start=date_start, date_end=date_end) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_unanswered_groups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get knowledge base unanswered group for a particular groupId,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID group_id = 'group_id_example' # str | The ID of the group to be retrieved. app = 'app_example' # str | The app value to be used for filtering phrases. (optional) date_start = '2013-10-20' # date | The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) date_end = '2013-10-20' # date | The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) try: # Get knowledge base unanswered group for a particular groupId api_response = api_instance.get_knowledge_knowledgebase_unanswered_group(knowledge_base_id, group_id, app=app, date_start=date_start, date_end=date_end) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_unanswered_group: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get knowledge base unanswered phrase group for a particular phraseGroupId,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID group_id = 'group_id_example' # str | The ID of the group to be retrieved. phrase_group_id = 'phrase_group_id_example' # str | The ID of the phraseGroup to be retrieved. app = 'app_example' # str | The app value to be used for filtering phrases. (optional) date_start = '2013-10-20' # date | The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) date_end = '2013-10-20' # date | The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd (optional) try: # Get knowledge base unanswered phrase group for a particular phraseGroupId api_response = api_instance.get_knowledge_knowledgebase_unanswered_group_phrasegroup(knowledge_base_id, group_id, phrase_group_id, app=app, date_start=date_start, date_end=date_end) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->get_knowledge_knowledgebase_unanswered_group_phrasegroup: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Knowledge base unanswered phrase group,"```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.KnowledgeApi(); knowledge_base_id = 'knowledge_base_id_example' # str | Knowledge base ID group_id = 'group_id_example' # str | The ID of the group to be updated. phrase_group_id = 'phrase_group_id_example' # str | The ID of the phraseGroup to be updated. body = PureCloudPlatformClientV2.UnansweredPhraseGroupPatchRequestBody() # UnansweredPhraseGroupPatchRequestBody | Request body of the update unanswered group endpoint. try: # Update a Knowledge base unanswered phrase group api_response = api_instance.patch_knowledge_knowledgebase_unanswered_group_phrasegroup(knowledge_base_id, group_id, phrase_group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling KnowledgeApi->patch_knowledge_knowledgebase_unanswered_group_phrasegroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/domains Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all NLU Domains.,"```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.LanguageUnderstandingApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get all NLU Domains. api_response = api_instance.get_languageunderstanding_domains(page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domains: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/languageunderstanding/domains Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an NLU Domain.,"```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.LanguageUnderstandingApi(); body = PureCloudPlatformClientV2.NluDomain() # NluDomain | The NLU Domain to create. try: # Create an NLU Domain. api_response = api_instance.post_languageunderstanding_domains(body) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domains: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/languageunderstanding/domains/{domainId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an NLU Domain.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. try: # Delete an NLU Domain. api_instance.delete_languageunderstanding_domain(domain_id) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->delete_languageunderstanding_domain: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/domains/{domainId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Find an NLU Domain.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. try: # Find an NLU Domain. api_response = api_instance.get_languageunderstanding_domain(domain_id) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/languageunderstanding/domains/{domainId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an NLU Domain.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. body = PureCloudPlatformClientV2.NluDomain() # NluDomain | The updated NLU Domain. try: # Update an NLU Domain. api_response = api_instance.patch_languageunderstanding_domain(domain_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->patch_languageunderstanding_domain: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/domains/{domainId}/feedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all feedback in the given NLU Domain Version.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. intent_name = 'intent_name_example' # str | The top intent name to retrieve feedback for. (optional) assessment = 'assessment_example' # str | The top assessment to retrieve feedback for. (optional) date_start = '2013-10-20' # date | Begin of time window as ISO-8601 date. (optional) date_end = '2013-10-20' # date | End of time window as ISO-8601 date. (optional) include_deleted = True # bool | Whether to include soft-deleted items in the result. (optional) language = 'language_example' # str | Whether to filter response based on the language, e.g. en-us, pt-br. (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) enable_cursor_pagination = False # bool | Enable Cursor Pagination (optional) (default to False) include_training_utterances = True # bool | Include Training Utterances. By default they're included. (optional) (default to True) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. This is considered only when enableCursorPagination=true (optional) fields = ['fields_example'] # list[str] | Fields and properties to get, comma-separated (optional) try: # Get all feedback in the given NLU Domain Version. api_response = api_instance.get_languageunderstanding_domain_feedback(domain_id, intent_name=intent_name, assessment=assessment, date_start=date_start, date_end=date_end, include_deleted=include_deleted, language=language, page_number=page_number, page_size=page_size, enable_cursor_pagination=enable_cursor_pagination, include_training_utterances=include_training_utterances, after=after, fields=fields) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain_feedback: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/languageunderstanding/domains/{domainId}/feedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create feedback for the NLU Domain Version.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. body = PureCloudPlatformClientV2.NluFeedbackRequest() # NluFeedbackRequest | The Feedback to create. try: # Create feedback for the NLU Domain Version. api_response = api_instance.post_languageunderstanding_domain_feedback(domain_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_feedback: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete the feedback on the NLU Domain Version.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. feedback_id = 'feedback_id_example' # str | ID of the Feedback try: # Delete the feedback on the NLU Domain Version. api_instance.delete_languageunderstanding_domain_feedback_feedback_id(domain_id, feedback_id) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->delete_languageunderstanding_domain_feedback_feedback_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/domains/{domainId}/feedback/{feedbackId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Find a Feedback,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. feedback_id = 'feedback_id_example' # str | ID of the Feedback fields = ['fields_example'] # list[str] | Fields and properties to get, comma-separated (optional) try: # Find a Feedback api_response = api_instance.get_languageunderstanding_domain_feedback_feedback_id(domain_id, feedback_id, fields=fields) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain_feedback_feedback_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/domains/{domainId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all NLU Domain Versions for a given Domain.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. include_utterances = True # bool | Whether utterances for intent definition should be included when marshalling response. (optional) page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get all NLU Domain Versions for a given Domain. api_response = api_instance.get_languageunderstanding_domain_versions(domain_id, include_utterances=include_utterances, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain_versions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/languageunderstanding/domains/{domainId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an NLU Domain Version.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. body = PureCloudPlatformClientV2.NluDomainVersion() # NluDomainVersion | The NLU Domain Version to create. include_utterances = True # bool | Whether utterances for intent definition should be included when marshalling response. (optional) try: # Create an NLU Domain Version. api_response = api_instance.post_languageunderstanding_domain_versions(domain_id, body, include_utterances=include_utterances) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_versions: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an NLU Domain Version,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. domain_version_id = 'domain_version_id_example' # str | ID of the NLU domain version. try: # Delete an NLU Domain Version api_instance.delete_languageunderstanding_domain_version(domain_id, domain_version_id) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->delete_languageunderstanding_domain_version: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Find an NLU Domain Version.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. domain_version_id = 'domain_version_id_example' # str | ID of the NLU domain version. include_utterances = True # bool | Whether utterances for intent definition should be included when marshalling response. (optional) try: # Find an NLU Domain Version. api_response = api_instance.get_languageunderstanding_domain_version(domain_id, domain_version_id, include_utterances=include_utterances) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain_version: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an NLU Domain Version.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. domain_version_id = 'domain_version_id_example' # str | ID of the NLU domain version. body = PureCloudPlatformClientV2.NluDomainVersion() # NluDomainVersion | The updated NLU Domain Version. try: # Update an NLU Domain Version. api_response = api_instance.put_languageunderstanding_domain_version(domain_id, domain_version_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->put_languageunderstanding_domain_version: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/detect Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Detect intent, entities, etc. in the submitted text using the specified NLU domain version.","```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. domain_version_id = 'domain_version_id_example' # str | ID of the NLU domain version. body = PureCloudPlatformClientV2.NluDetectionRequest() # NluDetectionRequest | The input data to perform detection on. try: # Detect intent, entities, etc. in the submitted text using the specified NLU domain version. api_response = api_instance.post_languageunderstanding_domain_version_detect(domain_id, domain_version_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_version_detect: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/publish Genesys Cloud Python SDK.,Genesys describes this as an API used to: Publish the draft NLU Domain Version.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. domain_version_id = 'domain_version_id_example' # str | ID of the NLU domain version. try: # Publish the draft NLU Domain Version. api_response = api_instance.post_languageunderstanding_domain_version_publish(domain_id, domain_version_id) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_version_publish: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/report Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieved quality report for the specified NLU Domain Version,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. domain_version_id = 'domain_version_id_example' # str | ID of the NLU domain version. try: # Retrieved quality report for the specified NLU Domain Version api_response = api_instance.get_languageunderstanding_domain_version_report(domain_id, domain_version_id) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_domain_version_report: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/languageunderstanding/domains/{domainId}/versions/{domainVersionId}/train Genesys Cloud Python SDK.,Genesys describes this as an API used to: Train the draft NLU Domain Version.,"```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.LanguageUnderstandingApi(); domain_id = 'domain_id_example' # str | ID of the NLU domain. domain_version_id = 'domain_version_id_example' # str | ID of the NLU domain version. try: # Train the draft NLU Domain Version. api_response = api_instance.post_languageunderstanding_domain_version_train(domain_id, domain_version_id) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->post_languageunderstanding_domain_version_train: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/miners Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve the list of miners created.,"```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.LanguageUnderstandingApi(); miner_type = 'miner_type_example' # str | Type of miner, either intent or topic (optional) try: # Retrieve the list of miners created. api_response = api_instance.get_languageunderstanding_miners(miner_type=miner_type) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_miners: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/languageunderstanding/miners Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a unique miner.,"```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.LanguageUnderstandingApi(); body = PureCloudPlatformClientV2.Miner() # Miner | Details for creating a new miner resource. try: # Create a unique miner. api_response = api_instance.post_languageunderstanding_miners(body) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->post_languageunderstanding_miners: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/languageunderstanding/miners/{minerId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a miner.,"```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID try: # Delete a miner. api_instance.delete_languageunderstanding_miner(miner_id) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->delete_languageunderstanding_miner: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/miners/{minerId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get information about a miner.,"```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID try: # Get information about a miner. api_response = api_instance.get_languageunderstanding_miner(miner_id) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_miner: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/miners/{minerId}/drafts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve the list of drafts created.,"```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID try: # Retrieve the list of drafts created. api_response = api_instance.get_languageunderstanding_miner_drafts(miner_id) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_miner_drafts: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/languageunderstanding/miners/{minerId}/drafts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new draft resource.,"```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID body = PureCloudPlatformClientV2.Draft() # Draft | Details for creating draft resource try: # Create a new draft resource. api_response = api_instance.post_languageunderstanding_miner_drafts(miner_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->post_languageunderstanding_miner_drafts: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId} 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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID draft_id = 'draft_id_example' # str | Draft ID try: # Delete a draft api_instance.delete_languageunderstanding_miner_draft(miner_id, draft_id) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->delete_languageunderstanding_miner_draft: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get information about 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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID draft_id = 'draft_id_example' # str | Draft ID draft_intent_id = 'draft_intent_id_example' # str | Parameter to filter a specific intent. (optional) draft_topic_id = 'draft_topic_id_example' # str | Parameter to filter a specific topic. (optional) try: # Get information about a draft. api_response = api_instance.get_languageunderstanding_miner_draft(miner_id, draft_id, draft_intent_id=draft_intent_id, draft_topic_id=draft_topic_id) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_miner_draft: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/languageunderstanding/miners/{minerId}/drafts/{draftId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Save information for the draft. Either topic draft or intent draft should be sent.,"```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID draft_id = 'draft_id_example' # str | Draft ID body = PureCloudPlatformClientV2.DraftRequest() # DraftRequest | (optional) try: # Save information for the draft. Either topic draft or intent draft should be sent. api_response = api_instance.patch_languageunderstanding_miner_draft(miner_id, draft_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->patch_languageunderstanding_miner_draft: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/languageunderstanding/miners/{minerId}/execute Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file.","```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID body = PureCloudPlatformClientV2.MinerExecuteRequest() # MinerExecuteRequest | (optional) try: # Start the mining process. Specify date range pair with mediaType, queueIds, participantType for mining data from Genesys Cloud. Specify only uploadKey for mining through an external file. api_response = api_instance.post_languageunderstanding_miner_execute(miner_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->post_languageunderstanding_miner_execute: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/miners/{minerId}/intents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a list of mined intents.,"```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID expand = 'expand_example' # str | Option to fetch utterances. (optional) try: # Retrieve a list of mined intents. api_response = api_instance.get_languageunderstanding_miner_intents(miner_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_miner_intents: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/miners/{minerId}/intents/{intentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get information about a mined intent,"```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID intent_id = 'intent_id_example' # str | The ID of the intent to be retrieved. expand = 'expand_example' # str | Option to fetch utterances (optional) try: # Get information about a mined intent api_response = api_instance.get_languageunderstanding_miner_intent(miner_id, intent_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_miner_intent: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/miners/{minerId}/topics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a list of mined topics.,"```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID try: # Retrieve a list of mined topics. api_response = api_instance.get_languageunderstanding_miner_topics(miner_id) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_miner_topics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/miners/{minerId}/topics/{topicId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves details of a particular topic.,"```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID topic_id = 'topic_id_example' # str | The ID of the topic to be retrieved. expand = 'expand_example' # str | Option to fetch phrases (optional) try: # Retrieves details of a particular topic. api_response = api_instance.get_languageunderstanding_miner_topic(miner_id, topic_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_miner_topic: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languageunderstanding/miners/{minerId}/topics/{topicId}/phrases/{phraseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves utterances related to a phrase in a topic.,"```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.LanguageUnderstandingApi(); miner_id = 'miner_id_example' # str | Miner ID topic_id = 'topic_id_example' # str | The ID of the topic to be retrieved. phrase_id = 'phrase_id_example' # str | The ID of the phrase to be retrieved. try: # Retrieves utterances related to a phrase in a topic. api_response = api_instance.get_languageunderstanding_miner_topic_phrase(miner_id, topic_id, phrase_id) pprint(api_response) except ApiException as e: print(""Exception when calling LanguageUnderstandingApi->get_languageunderstanding_miner_topic_phrase: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languages/translations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all available languages for translation,"```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.LanguagesApi(); try: # Get all available languages for translation api_response = api_instance.get_languages_translations() pprint(api_response) except ApiException as e: print(""Exception when calling LanguagesApi->get_languages_translations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languages/translations/builtin Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the builtin translation for a language,"```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.LanguagesApi(); language = 'language_example' # str | The language of the builtin translation to retrieve try: # Get the builtin translation for a language api_response = api_instance.get_languages_translations_builtin(language) pprint(api_response) except ApiException as e: print(""Exception when calling LanguagesApi->get_languages_translations_builtin: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languages/translations/organization Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get effective translation for an organization by language,"```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.LanguagesApi(); language = 'language_example' # str | The language of the translation to retrieve for the organization try: # Get effective translation for an organization by language api_response = api_instance.get_languages_translations_organization(language) pprint(api_response) except ApiException as e: print(""Exception when calling LanguagesApi->get_languages_translations_organization: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/languages/translations/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get effective language translation for a 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.LanguagesApi(); user_id = 'user_id_example' # str | The user id try: # Get effective language translation for a user api_response = api_instance.get_languages_translations_user(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling LanguagesApi->get_languages_translations_user: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/assessments/scoring Genesys Cloud Python SDK.,Genesys describes this as an API used to: Score learning assessment for preview,"```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.LearningApi(); body = PureCloudPlatformClientV2.LearningAssessmentScoringRequest() # LearningAssessmentScoringRequest | Assessment form and answers to score try: # Score learning assessment for preview api_response = api_instance.post_learning_assessments_scoring(body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_assessments_scoring: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/assignments Genesys Cloud Python SDK.,Genesys describes this as an API used to: List of Learning module Assignments. Either moduleId or user value is required,"```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.LearningApi(); module_id = 'module_id_example' # str | Specifies the ID of the learning module. Fetch assignments for learning module ID (optional) interval = 'interval_example' # str | Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) completion_interval = 'completion_interval_example' # str | Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) overdue = ''Any'' # str | Specifies if only the non-overdue (overdue is \""False\"") or overdue (overdue is \""True\"") assignments are returned. If overdue is \""Any\"" or if the overdue parameter is not supplied, all assignments are returned (optional) (default to 'Any') page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) pcPass = ''Any'' # str | Specifies if only the failed (pass is \""False\"") or passed (pass is \""True\"") assignments (completed with assessment)are returned. If pass is \""Any\"" or if the pass parameter is not supplied, all assignments are returned (optional) (default to 'Any') min_percentage_score = 3.4 # float | The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional) max_percentage_score = 3.4 # float | The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional) sort_order = ''Desc'' # str | Specifies result set sort order; if not specified, default sort order is descending (Desc) (optional) (default to 'Desc') sort_by = 'sort_by_example' # str | Specifies which field to sort the results by, default sort is by recommendedCompletionDate (optional) user_id = ['user_id_example'] # list[str] | Specifies the list of user IDs to be queried, up to 100 user IDs. (optional) types = ['types_example'] # list[str] | Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated (optional) states = ['states_example'] # list[str] | Specifies the assignment states to filter by (optional) expand = ['expand_example'] # list[str] | Specifies the expand option for returning additional information (optional) try: # List of Learning module Assignments api_response = api_instance.get_learning_assignments(module_id=module_id, interval=interval, completion_interval=completion_interval, overdue=overdue, page_size=page_size, page_number=page_number, pcPass=pcPass, min_percentage_score=min_percentage_score, max_percentage_score=max_percentage_score, sort_order=sort_order, sort_by=sort_by, user_id=user_id, types=types, states=states, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_assignments: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/assignments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create Learning Assignment,"```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.LearningApi(); body = PureCloudPlatformClientV2.LearningAssignmentCreate() # LearningAssignmentCreate | The Learning Assignment to be created (optional) try: # Create Learning Assignment api_response = api_instance.post_learning_assignments(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_assignments: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/assignments/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve aggregated assignment data,"```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.LearningApi(); body = PureCloudPlatformClientV2.LearningAssignmentAggregateParam() # LearningAssignmentAggregateParam | Aggregate Request try: # Retrieve aggregated assignment data api_response = api_instance.post_learning_assignments_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_assignments_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/assignments/bulkadd Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add multiple learning assignments,"```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.LearningApi(); body = [PureCloudPlatformClientV2.LearningAssignmentItem()] # list[LearningAssignmentItem] | The learning assignments to be created (optional) try: # Add multiple learning assignments api_response = api_instance.post_learning_assignments_bulkadd(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_assignments_bulkadd: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/assignments/bulkremove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove multiple Learning Assignments,"```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.LearningApi(); body = ['body_example'] # list[str] | The IDs of the learning assignments to be removed (optional) try: # Remove multiple Learning Assignments api_response = api_instance.post_learning_assignments_bulkremove(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_assignments_bulkremove: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/assignments/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: List of Learning Assignments assigned to current 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.LearningApi(); module_id = 'module_id_example' # str | Specifies the ID of the learning module. Fetch assignments for learning module ID (optional) interval = 'interval_example' # str | Specifies the range of dueDates to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) completion_interval = 'completion_interval_example' # str | Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) overdue = ''Any'' # str | Specifies if only the non-overdue (overdue is \""False\"") or overdue (overdue is \""True\"") assignments are returned. If overdue is \""Any\"" or if the overdue parameter is not supplied, all assignments are returned (optional) (default to 'Any') page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) pcPass = ''Any'' # str | Specifies if only the failed (pass is \""False\"") or passed (pass is \""True\"") assignments (completed with assessment)are returned. If pass is \""Any\"" or if the pass parameter is not supplied, all assignments are returned (optional) (default to 'Any') min_percentage_score = 3.4 # float | The minimum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional) max_percentage_score = 3.4 # float | The maximum assessment score for an assignment (completed with assessment) to be included in the results (inclusive) (optional) sort_order = ''Desc'' # str | Specifies result set sort order; if not specified, default sort order is descending (Desc) (optional) (default to 'Desc') sort_by = 'sort_by_example' # str | Specifies which field to sort the results by, default sort is by recommendedCompletionDate (optional) types = ['types_example'] # list[str] | Specifies the module types to filter by. Informational, AssessedContent and Assessment are deprecated (optional) states = ['states_example'] # list[str] | Specifies the assignment states to filter by (optional) expand = ['expand_example'] # list[str] | Specifies the expand option for returning additional information (optional) try: # List of Learning Assignments assigned to current user api_response = api_instance.get_learning_assignments_me(module_id=module_id, interval=interval, completion_interval=completion_interval, overdue=overdue, page_size=page_size, page_number=page_number, pcPass=pcPass, min_percentage_score=min_percentage_score, max_percentage_score=max_percentage_score, sort_order=sort_order, sort_by=sort_by, types=types, states=states, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_assignments_me: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/learning/assignments/{assignmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a learning assignment,"```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.LearningApi(); assignment_id = 'assignment_id_example' # str | The Learning Assignment ID try: # Delete a learning assignment api_instance.delete_learning_assignment(assignment_id) except ApiException as e: print(""Exception when calling LearningApi->delete_learning_assignment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/assignments/{assignmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Learning Assignment. Permission not required if you are the assigned user of the learning assignment,"```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.LearningApi(); assignment_id = 'assignment_id_example' # str | The ID of Learning Assignment expand = ['expand_example'] # list[str] | Fields to expand in response (optional) try: # Get Learning Assignment api_response = api_instance.get_learning_assignment(assignment_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_assignment: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/learning/assignments/{assignmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Learning Assignment,"```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.LearningApi(); assignment_id = 'assignment_id_example' # str | The ID of Learning Assignment body = PureCloudPlatformClientV2.LearningAssignmentUpdate() # LearningAssignmentUpdate | The Learning Assignment to be updated (optional) try: # Update Learning Assignment api_response = api_instance.patch_learning_assignment(assignment_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->patch_learning_assignment: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/assignments/{assignmentId}/reassign Genesys Cloud Python SDK.,Genesys describes this as an API used to: Reassign Learning Assignment. This will reassign the state of the assignment to 'Assigned' and update the assignment to the latest version of the module,"```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.LearningApi(); assignment_id = 'assignment_id_example' # str | The Learning Assignment ID try: # Reassign Learning Assignment api_response = api_instance.post_learning_assignment_reassign(assignment_id) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_assignment_reassign: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/learning/assignments/{assignmentId}/reschedule Genesys Cloud Python SDK.,Genesys describes this as an API used to: Reschedule Learning Assignment,"```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.LearningApi(); assignment_id = 'assignment_id_example' # str | The ID of Learning Assignment body = PureCloudPlatformClientV2.LearningAssignmentReschedule() # LearningAssignmentReschedule | The Learning assignment reschedule model (optional) try: # Reschedule Learning Assignment api_response = api_instance.patch_learning_assignment_reschedule(assignment_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->patch_learning_assignment_reschedule: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/assignments/{assignmentId}/reset Genesys Cloud Python SDK.,Genesys describes this as an API used to: Reset Learning Assignment. This will reset the state of the assignment to 'Assigned' and remove the version of Learning module associated with the assignment,"```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.LearningApi(); assignment_id = 'assignment_id_example' # str | The Learning Assignment ID try: # Reset Learning Assignment api_response = api_instance.post_learning_assignment_reset(assignment_id) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_assignment_reset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/assignments/{assignmentId}/steps/{stepId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Learning Assignment Step. Permission not required if you are the assigned user of the learning assignment,"```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.LearningApi(); assignment_id = 'assignment_id_example' # str | The ID of Learning Assignment step_id = 'step_id_example' # str | The ID of Learning Assignment Step shareable_content_object_id = 'shareable_content_object_id_example' # str | The ID of SCO to load (optional) default_shareable_content_object = 'default_shareable_content_object_example' # str | The default SCO to retrieve (optional) expand = ['expand_example'] # list[str] | Fields to expand in response (optional) try: # Get Learning Assignment Step api_response = api_instance.get_learning_assignment_step(assignment_id, step_id, shareable_content_object_id=shareable_content_object_id, default_shareable_content_object=default_shareable_content_object, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_assignment_step: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/learning/assignments/{assignmentId}/steps/{stepId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Learning Assignment Step. Permission not required if you are the assigned user of the learning assignment,"```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.LearningApi(); assignment_id = 'assignment_id_example' # str | The ID of Learning Assignment step_id = 'step_id_example' # str | The ID of Learning Assignment Step body = PureCloudPlatformClientV2.LearningAssignmentStep() # LearningAssignmentStep | The Learning Assignment Step to be updated (optional) try: # Update Learning Assignment Step api_response = api_instance.patch_learning_assignment_step(assignment_id, step_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->patch_learning_assignment_step: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/modules Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all learning modules of an organization,"```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.LearningApi(); is_archived = False # bool | Archive status (optional) (default to False) types = ['types_example'] # list[str] | Specifies the module types. Informational, AssessedContent and Assessment are deprecated (optional) page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending') sort_by = ''name'' # str | Sort by (optional) (default to 'name') search_term = 'search_term_example' # str | Search Term (searchable by name) (optional) expand = ['expand_example'] # list[str] | Fields to expand in response(case insensitive) (optional) is_published = ''Any'' # str | Specifies if only the Unpublished (isPublished is \""False\"") or Published (isPublished is \""True\"") modules are returned. If isPublished is \""Any\"" or omitted, both types are returned (optional) (default to 'Any') statuses = ['statuses_example'] # list[str] | Specifies the module statuses to filter by (optional) external_ids = ['external_ids_example'] # list[str] | Specifies the module external IDs to filter by. Only one ID is allowed (optional) try: # Get all learning modules of an organization api_response = api_instance.get_learning_modules(is_archived=is_archived, types=types, page_size=page_size, page_number=page_number, sort_order=sort_order, sort_by=sort_by, search_term=search_term, expand=expand, is_published=is_published, statuses=statuses, external_ids=external_ids) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_modules: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/modules Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new learning module. This will create a new unpublished learning module with the specified fields.,"```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.LearningApi(); body = PureCloudPlatformClientV2.LearningModuleRequest() # LearningModuleRequest | The learning module to be created try: # Create a new learning module api_response = api_instance.post_learning_modules(body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_modules: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/modules/assignments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all learning modules of an organization including assignments for a specific 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.LearningApi(); user_ids = ['user_ids_example'] # list[str] | The IDs of the users to include page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) search_term = 'search_term_example' # str | Search Term (searches by name and description) (optional) overdue = ''Any'' # str | Specifies if only modules with overdue/not overdue (overdue is \""True\"" or \""False\"") assignments are returned. If overdue is \""Any\"" or omitted, both are returned and can including modules that are unassigned. (optional) (default to 'Any') assignment_states = ['assignment_states_example'] # list[str] | Specifies the assignment states to return. (optional) expand = ['expand_example'] # list[str] | Fields to expand in response(case insensitive) (optional) try: # Get all learning modules of an organization including assignments for a specific user api_response = api_instance.get_learning_modules_assignments(user_ids, page_size=page_size, page_number=page_number, search_term=search_term, overdue=overdue, assignment_states=assignment_states, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_modules_assignments: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/modules/coverart/{coverArtId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a specific Learning Module cover art using 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.LearningApi(); cover_art_id = 'cover_art_id_example' # str | Key identifier for the cover art try: # Get a specific Learning Module cover art using ID api_response = api_instance.get_learning_modules_coverart_cover_art_id(cover_art_id) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_modules_coverart_cover_art_id: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/learning/modules/{moduleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a learning module. This will delete a learning module if it is unpublished or it will delete a published and archived learning module,"```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.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module try: # Delete a learning module api_instance.delete_learning_module(module_id) except ApiException as e: print(""Exception when calling LearningApi->delete_learning_module: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/modules/{moduleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a learning module,"```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.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module expand = ['expand_example'] # list[str] | Fields to expand in response(case insensitive) (optional) try: # Get a learning module api_response = api_instance.get_learning_module(module_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_module: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/learning/modules/{moduleId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Update a learning module. This will update the name, description, completion time in days and inform steps for a learning module","```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.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module body = PureCloudPlatformClientV2.LearningModuleRequest() # LearningModuleRequest | The learning module to be updated try: # Update a learning module api_response = api_instance.put_learning_module(module_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->put_learning_module: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/modules/{moduleId}/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Starts a specified operation on learning module. This will initiate operation specified in the request body for a learning module,"```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.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module body = PureCloudPlatformClientV2.LearningModuleJobRequest() # LearningModuleJobRequest | The learning module job request try: # Starts a specified operation on learning module api_response = api_instance.post_learning_module_jobs(module_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_module_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/modules/{moduleId}/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a specific Learning Module job status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module job_id = 'job_id_example' # str | The ID of the learning module job try: # Get a specific Learning Module job status api_response = api_instance.get_learning_module_job(module_id, job_id) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_module_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/modules/{moduleId}/preview Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a learning module preview,"```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.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module try: # Get a learning module preview api_response = api_instance.get_learning_module_preview(module_id) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_module_preview: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/learning/modules/{moduleId}/preview Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a learning module preview. This will update a learning module preview,"```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.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module body = PureCloudPlatformClientV2.LearningModulePreviewUpdateRequest() # LearningModulePreviewUpdateRequest | The learning module to be updated try: # Update a learning module preview api_response = api_instance.put_learning_module_preview(module_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->put_learning_module_preview: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/modules/{moduleId}/publish Genesys Cloud Python SDK.,Genesys describes this as an API used to: Publish a Learning module,"```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.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module body = PureCloudPlatformClientV2.LearningModulePublishRequest() # LearningModulePublishRequest | The request body (optional) try: # Publish a Learning module api_response = api_instance.post_learning_module_publish(module_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_module_publish: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/modules/{moduleId}/rule Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a learning module rule,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module try: # Get a learning module rule api_response = api_instance.get_learning_module_rule(module_id) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_module_rule: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/learning/modules/{moduleId}/rule Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a learning module rule. This will update a learning module rule with the specified fields.,"```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.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module body = PureCloudPlatformClientV2.LearningModuleRule() # LearningModuleRule | The learning module rule to be updated try: # Update a learning module rule api_response = api_instance.put_learning_module_rule(module_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->put_learning_module_rule: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/learning/modules/{moduleId}/users/{userId}/assignments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an external assignment for a specific 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.LearningApi(); module_id = 'module_id_example' # str | Key identifier for the module user_id = 'user_id_example' # str | Key identifier for the user body = PureCloudPlatformClientV2.LearningAssignmentExternalUpdate() # LearningAssignmentExternalUpdate | The learning request for updating the assignment try: # Update an external assignment for a specific user api_response = api_instance.patch_learning_module_user_assignments(module_id, user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->patch_learning_module_user_assignments: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/modules/{moduleId}/versions/{versionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get specific version of a published module,"```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.LearningApi(); module_id = 'module_id_example' # str | The ID of the learning module version_id = 'version_id_example' # str | The version of learning module expand = ['expand_example'] # list[str] | Fields to expand in response(case insensitive) (optional) try: # Get specific version of a published module api_response = api_instance.get_learning_module_version(module_id, version_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_module_version: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/rules/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get users for learning module rule. This will get the users who matches the given rule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.LearningApi(); page_size = 50 # int | Page size (default to 50) page_number = 1 # int | Page number (default to 1) body = PureCloudPlatformClientV2.LearningAssignmentUserQuery() # LearningAssignmentUserQuery | The learning module rule to fetch users try: # Get users for learning module rule api_response = api_instance.post_learning_rules_query(page_size, page_number, body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_rules_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/scheduleslots/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of possible slots where a learning activity can be scheduled.,"```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.LearningApi(); body = PureCloudPlatformClientV2.LearningScheduleSlotsQueryRequest() # LearningScheduleSlotsQueryRequest | The slot search request try: # Get list of possible slots where a learning activity can be scheduled. api_response = api_instance.post_learning_scheduleslots_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_scheduleslots_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/learning/scorm Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a SCORM package upload request,"```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.LearningApi(); body = PureCloudPlatformClientV2.LearningScormUploadRequest() # LearningScormUploadRequest | The SCORM package to be uploaded (optional) try: # Create a SCORM package upload request api_response = api_instance.post_learning_scorm(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->post_learning_scorm: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/learning/scorm/{scormId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Learning SCORM Result,"```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.LearningApi(); scorm_id = 'scorm_id_example' # str | The ID of the SCORM package try: # Get Learning SCORM Result api_response = api_instance.get_learning_scorm_scorm_id(scorm_id) pprint(api_response) except ApiException as e: print(""Exception when calling LearningApi->get_learning_scorm_scorm_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/license/definitions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all PureCloud license definitions available for the organization.,"```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.LicenseApi(); try: # Get all PureCloud license definitions available for the organization. api_response = api_instance.get_license_definitions() pprint(api_response) except ApiException as e: print(""Exception when calling LicenseApi->get_license_definitions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/license/definitions/{licenseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get PureCloud license definition.,"```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.LicenseApi(); license_id = 'license_id_example' # str | ID try: # Get PureCloud license definition. api_response = api_instance.get_license_definition(license_id) pprint(api_response) except ApiException as e: print(""Exception when calling LicenseApi->get_license_definition: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/license/infer Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of licenses inferred based on a list of roleIds,"```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.LicenseApi(); body = ['body_example'] # list[str] | The roleIds to use while inferring licenses (optional) try: # Get a list of licenses inferred based on a list of roleIds api_response = api_instance.post_license_infer(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LicenseApi->post_license_infer: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/license/organization Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the organization's license assignments in a batch.,"```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.LicenseApi(); body = PureCloudPlatformClientV2.LicenseBatchAssignmentRequest() # LicenseBatchAssignmentRequest | The license assignments to update. (optional) try: # Update the organization's license assignments in a batch. api_response = api_instance.post_license_organization(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LicenseApi->post_license_organization: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/license/toggles/{featureName} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deprecated - no alternative required. This operation will always return 'true' for requested toggles,"```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.LicenseApi(); feature_name = 'feature_name_example' # str | featureName try: # Deprecated - no alternative required. This operation will always return 'true' for requested toggles api_response = api_instance.get_license_toggle(feature_name) pprint(api_response) except ApiException as e: print(""Exception when calling LicenseApi->get_license_toggle: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/license/toggles/{featureName} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deprecated. No alternative required - this endpoint has no effect,"```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.LicenseApi(); feature_name = 'feature_name_example' # str | featureName try: # Deprecated. No alternative required - this endpoint has no effect api_response = api_instance.post_license_toggle(feature_name) pprint(api_response) except ApiException as e: print(""Exception when calling LicenseApi->post_license_toggle: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/license/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a page of users and their licenses. Retrieve a page of users in an organization along with the licenses they possess.,"```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.LicenseApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a page of users and their licenses api_response = api_instance.get_license_users(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling LicenseApi->get_license_users: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/license/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch user licenses in a batch.,"```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.LicenseApi(); body = ['body_example'] # list[str] | The user IDs to fetch. (optional) try: # Fetch user licenses in a batch. api_response = api_instance.post_license_users(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LicenseApi->post_license_users: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/license/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get licenses for specified 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.LicenseApi(); user_id = 'user_id_example' # str | ID try: # Get licenses for specified user. api_response = api_instance.get_license_user(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling LicenseApi->get_license_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/locations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of all locations.,"```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.LocationsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) id = ['id_example'] # list[str] | id (optional) sort_order = 'sort_order_example' # str | Sort order (optional) try: # Get a list of all locations. api_response = api_instance.get_locations(page_size=page_size, page_number=page_number, id=id, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling LocationsApi->get_locations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/locations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a location,"```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.LocationsApi(); body = PureCloudPlatformClientV2.LocationCreateDefinition() # LocationCreateDefinition | Location try: # Create a location api_response = api_instance.post_locations(body) pprint(api_response) except ApiException as e: print(""Exception when calling LocationsApi->post_locations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/locations/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search locations using the q64 value returned from a previous search,"```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.SearchApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | Provides more details about a specified resource (optional) try: # Search locations using the q64 value returned from a previous search api_response = api_instance.get_locations_search(q64, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->get_locations_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/locations/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search locations,"```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.SearchApi(); body = PureCloudPlatformClientV2.LocationSearchRequest() # LocationSearchRequest | Search request options try: # Search locations api_response = api_instance.post_locations_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->post_locations_search: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/locations/{locationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a location,"```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.LocationsApi(); location_id = 'location_id_example' # str | Location ID try: # Delete a location api_instance.delete_location(location_id) except ApiException as e: print(""Exception when calling LocationsApi->delete_location: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/locations/{locationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Location by 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.LocationsApi(); location_id = 'location_id_example' # str | Location ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) try: # Get Location by ID. api_response = api_instance.get_location(location_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling LocationsApi->get_location: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/locations/{locationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a location,"```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.LocationsApi(); location_id = 'location_id_example' # str | Location ID body = PureCloudPlatformClientV2.LocationUpdateDefinition() # LocationUpdateDefinition | Location try: # Update a location api_response = api_instance.patch_location(location_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling LocationsApi->patch_location: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/locations/{locationId}/sublocations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get sublocations for location 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.LocationsApi(); location_id = 'location_id_example' # str | Location ID try: # Get sublocations for location ID. api_response = api_instance.get_location_sublocations(location_id) pprint(api_response) except ApiException as e: print(""Exception when calling LocationsApi->get_location_sublocations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/diagnostics/logcapture/browser/entries/download/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates an async download execution,"```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.LogCaptureApi(); body = PureCloudPlatformClientV2.LogCaptureQueryRequest() # LogCaptureQueryRequest | (optional) try: # Creates an async download execution api_response = api_instance.post_diagnostics_logcapture_browser_entries_download_jobs(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LogCaptureApi->post_diagnostics_logcapture_browser_entries_download_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets status of async download execution,"```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.LogCaptureApi(); job_id = 'job_id_example' # str | Job ID try: # Gets status of async download execution api_response = api_instance.get_diagnostics_logcapture_browser_entries_download_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling LogCaptureApi->get_diagnostics_logcapture_browser_entries_download_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/diagnostics/logcapture/browser/entries/query Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.","```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.LogCaptureApi(); before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) body = PureCloudPlatformClientV2.LogCaptureQueryRequest() # LogCaptureQueryRequest | (optional) try: # Query collected log entries. It returns a limited amount of records, to get all records use download endpoint. api_response = api_instance.post_diagnostics_logcapture_browser_entries_query(before=before, after=after, page_size=page_size, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LogCaptureApi->post_diagnostics_logcapture_browser_entries_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/diagnostics/logcapture/browser/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all log capture enabled users 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.LogCaptureApi(); include_expired = False # bool | Include expired users with log captures still available for search or download (optional) (default to False) try: # Get all log capture enabled users for an org api_response = api_instance.get_diagnostics_logcapture_browser_users(include_expired=include_expired) pprint(api_response) except ApiException as e: print(""Exception when calling LogCaptureApi->get_diagnostics_logcapture_browser_users: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/diagnostics/logcapture/browser/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Disable browser log capture for the 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.LogCaptureApi(); user_id = 'user_id_example' # str | The id of the user to disable browser log capture try: # Disable browser log capture for the user api_instance.delete_diagnostics_logcapture_browser_user(user_id) except ApiException as e: print(""Exception when calling LogCaptureApi->delete_diagnostics_logcapture_browser_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/diagnostics/logcapture/browser/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get log capture configuration for the 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.LogCaptureApi(); user_id = 'user_id_example' # str | The id of the user to get browser log capture configuration try: # Get log capture configuration for the user api_response = api_instance.get_diagnostics_logcapture_browser_user(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling LogCaptureApi->get_diagnostics_logcapture_browser_user: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/diagnostics/logcapture/browser/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Enable log capture for a user or update expiration,"```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.LogCaptureApi(); user_id = 'user_id_example' # str | The id of the user to enable browser log capture body = PureCloudPlatformClientV2.LogCaptureUserConfiguration() # LogCaptureUserConfiguration | (optional) try: # Enable log capture for a user or update expiration api_response = api_instance.post_diagnostics_logcapture_browser_user(user_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling LogCaptureApi->post_diagnostics_logcapture_browser_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/mobiledevices Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of all devices.,"```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.MobileDevicesApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''ascending'' # str | Ascending or descending sort order (optional) (default to 'ascending') try: # Get a list of all devices. api_response = api_instance.get_mobiledevices(page_size=page_size, page_number=page_number, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling MobileDevicesApi->get_mobiledevices: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/mobiledevices Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create User device,"```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.MobileDevicesApi(); body = PureCloudPlatformClientV2.UserDevice() # UserDevice | Device try: # Create User device api_response = api_instance.post_mobiledevices(body) pprint(api_response) except ApiException as e: print(""Exception when calling MobileDevicesApi->post_mobiledevices: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/mobiledevices/{deviceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete device,"```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.MobileDevicesApi(); device_id = 'device_id_example' # str | Device ID try: # Delete device api_instance.delete_mobiledevice(device_id) except ApiException as e: print(""Exception when calling MobileDevicesApi->delete_mobiledevice: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/mobiledevices/{deviceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get device,"```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.MobileDevicesApi(); device_id = 'device_id_example' # str | Device ID try: # Get device api_response = api_instance.get_mobiledevice(device_id) pprint(api_response) except ApiException as e: print(""Exception when calling MobileDevicesApi->get_mobiledevice: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/mobiledevices/{deviceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update device,"```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.MobileDevicesApi(); device_id = 'device_id_example' # str | Device ID body = PureCloudPlatformClientV2.UserDevice() # UserDevice | Device (optional) try: # Update device api_response = api_instance.put_mobiledevice(device_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling MobileDevicesApi->put_mobiledevice: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/notifications/availabletopics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get available notification topics.,"```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.NotificationsApi(); expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) include_preview = True # bool | Whether or not to include Preview topics (optional) (default to True) try: # Get available notification topics. api_response = api_instance.get_notifications_availabletopics(expand=expand, include_preview=include_preview) pprint(api_response) except ApiException as e: print(""Exception when calling NotificationsApi->get_notifications_availabletopics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/notifications/channels Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of existing channels,"```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.NotificationsApi(); includechannels = ''token'' # str | Show user's channels for this specific token or across all tokens for this user and app. Channel Ids for other access tokens will not be shown, but will be presented to show their existence. (optional) (default to 'token') try: # The list of existing channels api_response = api_instance.get_notifications_channels(includechannels=includechannels) pprint(api_response) except ApiException as e: print(""Exception when calling NotificationsApi->get_notifications_channels: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/notifications/channels Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new channel. There is a limit of 20 channels per user/app combination. Creating a 21st channel will remove the channel with oldest last used date. Channels without an active connection will be removed first.,"```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.NotificationsApi(); try: # Create a new channel api_response = api_instance.post_notifications_channels() pprint(api_response) except ApiException as e: print(""Exception when calling NotificationsApi->post_notifications_channels: %s\n"" % e)```" Provide a Python example that uses the HEAD /api/v2/notifications/channels/{channelId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Verify a channel still exists and is valid. Returns a 200 OK if channel exists, and a 404 Not Found if it doesn't","```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.NotificationsApi(); channel_id = 'channel_id_example' # str | Channel ID try: # Verify a channel still exists and is valid api_instance.head_notifications_channel(channel_id) except ApiException as e: print(""Exception when calling NotificationsApi->head_notifications_channel: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/notifications/channels/{channelId}/subscriptions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove all subscriptions,"```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.NotificationsApi(); channel_id = 'channel_id_example' # str | Channel ID try: # Remove all subscriptions api_instance.delete_notifications_channel_subscriptions(channel_id) except ApiException as e: print(""Exception when calling NotificationsApi->delete_notifications_channel_subscriptions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/notifications/channels/{channelId}/subscriptions Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of all subscriptions for this channel,"```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.NotificationsApi(); channel_id = 'channel_id_example' # str | Channel ID try: # The list of all subscriptions for this channel api_response = api_instance.get_notifications_channel_subscriptions(channel_id) pprint(api_response) except ApiException as e: print(""Exception when calling NotificationsApi->get_notifications_channel_subscriptions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/notifications/channels/{channelId}/subscriptions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a list of subscriptions to the existing list of subscriptions,"```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.NotificationsApi(); channel_id = 'channel_id_example' # str | Channel ID body = [PureCloudPlatformClientV2.ChannelTopic()] # list[ChannelTopic] | Body ignore_errors = False # bool | Optionally prevent throwing of errors for failed permissions checks. (optional) (default to False) try: # Add a list of subscriptions to the existing list of subscriptions api_response = api_instance.post_notifications_channel_subscriptions(channel_id, body, ignore_errors=ignore_errors) pprint(api_response) except ApiException as e: print(""Exception when calling NotificationsApi->post_notifications_channel_subscriptions: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/notifications/channels/{channelId}/subscriptions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace the current list of subscriptions with a new list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.NotificationsApi(); channel_id = 'channel_id_example' # str | Channel ID body = [PureCloudPlatformClientV2.ChannelTopic()] # list[ChannelTopic] | Body ignore_errors = False # bool | Optionally prevent throwing of errors for failed permissions checks. (optional) (default to False) try: # Replace the current list of subscriptions with a new list. api_response = api_instance.put_notifications_channel_subscriptions(channel_id, body, ignore_errors=ignore_errors) pprint(api_response) except ApiException as e: print(""Exception when calling NotificationsApi->put_notifications_channel_subscriptions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/oauth/authorizations Genesys Cloud Python SDK.,"Genesys describes this as an API used to: List clients that have been authorized, requested, or revoked by the resource owner","```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.OAuthApi(); accept_language = ''en-us'' # str | The language in which to display the client descriptions. (optional) (default to 'en-us') try: # List clients that have been authorized, requested, or revoked by the resource owner api_response = api_instance.get_oauth_authorizations(accept_language=accept_language) pprint(api_response) except ApiException as e: print(""Exception when calling OAuthApi->get_oauth_authorizations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/oauth/authorizations/{clientId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a client that is authorized by the resource owner,"```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.OAuthApi(); client_id = 'client_id_example' # str | The ID of client accept_language = ''en-us'' # str | The language in which to display the client descriptions. (optional) (default to 'en-us') try: # Get a client that is authorized by the resource owner api_response = api_instance.get_oauth_authorization(client_id, accept_language=accept_language) pprint(api_response) except ApiException as e: print(""Exception when calling OAuthApi->get_oauth_authorization: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/oauth/clients Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of OAuth clients,"```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.OAuthApi(); try: # The list of OAuth clients api_response = api_instance.get_oauth_clients() pprint(api_response) except ApiException as e: print(""Exception when calling OAuthApi->get_oauth_clients: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/oauth/clients Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create OAuth client. The OAuth Grant/Client is required in order to create an authentication token and gain access to PureCloud. The preferred authorizedGrantTypes is 'CODE' which requires applications to send a client ID and client secret. This is typically a web server. If the client is unable to secure the client secret then the 'TOKEN' grant type aka IMPLICIT should be used. This is would be for browser or mobile apps. If a client is to be used outside of the context of a user then the 'CLIENT-CREDENTIALS' grant may be used. In this case the client must be granted roles via the 'roleIds' field.,"```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.OAuthApi(); body = PureCloudPlatformClientV2.OAuthClientRequest() # OAuthClientRequest | Client try: # Create OAuth client api_response = api_instance.post_oauth_clients(body) pprint(api_response) except ApiException as e: print(""Exception when calling OAuthApi->post_oauth_clients: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/oauth/clients/{clientId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete OAuth Client,"```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.OAuthApi(); client_id = 'client_id_example' # str | Client ID try: # Delete OAuth Client api_instance.delete_oauth_client(client_id) except ApiException as e: print(""Exception when calling OAuthApi->delete_oauth_client: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/oauth/clients/{clientId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get OAuth Client,"```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.OAuthApi(); client_id = 'client_id_example' # str | Client ID try: # Get OAuth Client api_response = api_instance.get_oauth_client(client_id) pprint(api_response) except ApiException as e: print(""Exception when calling OAuthApi->get_oauth_client: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/oauth/clients/{clientId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update OAuth Client,"```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.OAuthApi(); client_id = 'client_id_example' # str | Client ID body = PureCloudPlatformClientV2.OAuthClientRequest() # OAuthClientRequest | Client try: # Update OAuth Client api_response = api_instance.put_oauth_client(client_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OAuthApi->put_oauth_client: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/oauth/clients/{clientId}/secret Genesys Cloud Python SDK.,Genesys describes this as an API used to: Regenerate Client Secret. This operation will set the client secret to a randomly generated cryptographically random value. All clients must be updated with the new secret. This operation should be used with caution.,"```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.OAuthApi(); client_id = 'client_id_example' # str | Client ID try: # Regenerate Client Secret api_response = api_instance.post_oauth_client_secret(client_id) pprint(api_response) except ApiException as e: print(""Exception when calling OAuthApi->post_oauth_client_secret: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/oauth/clients/{clientId}/usage/query Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Query for OAuth client API usage. After calling this method, you will then need to poll for the query results based on the returned execution 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.UsageApi(); client_id = 'client_id_example' # str | Client ID body = PureCloudPlatformClientV2.ApiUsageClientQuery() # ApiUsageClientQuery | Query try: # Query for OAuth client API usage api_response = api_instance.post_oauth_client_usage_query(client_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsageApi->post_oauth_client_usage_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the results of a usage query,"```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.UsageApi(); execution_id = 'execution_id_example' # str | ID of the query execution client_id = 'client_id_example' # str | Client ID try: # Get the results of a usage query api_response = api_instance.get_oauth_client_usage_query_result(execution_id, client_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsageApi->get_oauth_client_usage_query_result: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/oauth/clients/{clientId}/usage/summary Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a summary of OAuth client API usage. After calling this method, you will then need to poll for the query results based on the returned execution 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.UsageApi(); client_id = 'client_id_example' # str | Client ID days = ''7'' # str | Previous number of days to query (optional) (default to '7') try: # Get a summary of OAuth client API usage api_response = api_instance.get_oauth_client_usage_summary(client_id, days=days) pprint(api_response) except ApiException as e: print(""Exception when calling UsageApi->get_oauth_client_usage_summary: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/oauth/scopes Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of OAuth scopes,"```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.OAuthApi(); accept_language = ''en-us'' # str | The language with which to display the scope descriptions. (optional) (default to 'en-us') try: # The list of OAuth scopes api_response = api_instance.get_oauth_scopes(accept_language=accept_language) pprint(api_response) except ApiException as e: print(""Exception when calling OAuthApi->get_oauth_scopes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/oauth/scopes/{scopeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: An OAuth scope,"```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.OAuthApi(); scope_id = 'scope_id_example' # str | Scope ID accept_language = ''en-us'' # str | The language with which to display the scope description. (optional) (default to 'en-us') try: # An OAuth scope api_response = api_instance.get_oauth_scope(scope_id, accept_language=accept_language) pprint(api_response) except ApiException as e: print(""Exception when calling OAuthApi->get_oauth_scope: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisions Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Retrieve a list of all divisions defined for the organization. Request specific divisions by id using a query param ""id"", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3","```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.ObjectsApi(); 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) object_count = False # bool | Include the count of objects contained in the division (optional) (default to False) id = ['id_example'] # list[str] | Optionally request specific divisions by their IDs (optional) name = 'name_example' # str | Search term to filter by division name (optional) try: # Retrieve a list of all divisions defined for the organization api_response = api_instance.get_authorization_divisions(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, object_count=object_count, id=id, name=name) pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->get_authorization_divisions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/divisions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a division.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ObjectsApi(); body = PureCloudPlatformClientV2.AuthzDivision() # AuthzDivision | Division try: # Create a division. api_response = api_instance.post_authorization_divisions(body) pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->post_authorization_divisions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisions/home Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve the home division for the organization. Will not include object counts.,"```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.ObjectsApi(); try: # Retrieve the home division for the organization. api_response = api_instance.get_authorization_divisions_home() pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->get_authorization_divisions_home: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisions/limit Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns the maximum allowed number of divisions.,"```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.ObjectsApi(); try: # Returns the maximum allowed number of divisions. api_response = api_instance.get_authorization_divisions_limit() pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->get_authorization_divisions_limit: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/authorization/divisions/{divisionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a division.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ObjectsApi(); division_id = 'division_id_example' # str | Division ID force = False # bool | Force delete this division as well as the grants and objects associated with it (optional) (default to False) try: # Delete a division. api_instance.delete_authorization_division(division_id, force=force) except ApiException as e: print(""Exception when calling ObjectsApi->delete_authorization_division: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisions/{divisionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns an authorization division.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ObjectsApi(); division_id = 'division_id_example' # str | Division ID object_count = False # bool | Get count of objects in this division, grouped by type (optional) (default to False) try: # Returns an authorization division. api_response = api_instance.get_authorization_division(division_id, object_count=object_count) pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->get_authorization_division: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/authorization/divisions/{divisionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a division.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ObjectsApi(); division_id = 'division_id_example' # str | Division ID body = PureCloudPlatformClientV2.AuthzDivision() # AuthzDivision | Updated division data try: # Update a division. api_response = api_instance.put_authorization_division(division_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->put_authorization_division: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/divisions/{divisionId}/objects/{objectType} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Assign a list of objects to a division. Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [""206ce31f-61ec-40ed-a8b1-be6f06303998"",""250a754e-f5e4-4f51-800f-a92f09d3bf8c""]","```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.ObjectsApi(); division_id = 'division_id_example' # str | Division ID object_type = 'object_type_example' # str | The type of the objects. Must be one of the valid object types body = ['body_example'] # list[str] | Object Id List try: # Assign a list of objects to a division api_instance.post_authorization_division_object(division_id, object_type, body) except ApiException as e: print(""Exception when calling ObjectsApi->post_authorization_division_object: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/divisions/{divisionId}/restore Genesys Cloud Python SDK.,Genesys describes this as an API used to: Recreate a previously deleted division.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ObjectsApi(); division_id = 'division_id_example' # str | Division ID body = PureCloudPlatformClientV2.AuthzDivision() # AuthzDivision | Recreated division data (optional) try: # Recreate a previously deleted division. api_response = api_instance.post_authorization_division_restore(division_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ObjectsApi->post_authorization_division_restore: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/usage/events/definitions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all operational event definitions,"```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.OperationalEventsApi(); try: # Get all operational event definitions api_response = api_instance.get_usage_events_definitions() pprint(api_response) except ApiException as e: print(""Exception when calling OperationalEventsApi->get_usage_events_definitions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/usage/events/definitions/{eventDefinitionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an operational event definition by its 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.OperationalEventsApi(); event_definition_id = 'event_definition_id_example' # str | EventDefinition id try: # Get an operational event definition by its id api_response = api_instance.get_usage_events_definition(event_definition_id) pprint(api_response) except ApiException as e: print(""Exception when calling OperationalEventsApi->get_usage_events_definition: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/authentication/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets the organization's settings,"```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.OrganizationApi(); try: # Gets the organization's settings api_response = api_instance.get_organizations_authentication_settings() pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_authentication_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/organizations/authentication/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the organization's settings,"```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.OrganizationApi(); body = PureCloudPlatformClientV2.OrgAuthSettings() # OrgAuthSettings | Org settings try: # Update the organization's settings api_response = api_instance.patch_organizations_authentication_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->patch_organizations_authentication_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/organizations/features/{featureName} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update organization,"```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.OrganizationApi(); feature_name = 'feature_name_example' # str | Organization feature enabled = PureCloudPlatformClientV2.FeatureState() # FeatureState | New state of feature try: # Update organization api_response = api_instance.patch_organizations_feature(feature_name, enabled) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->patch_organizations_feature: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/limits/changerequests Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the available limit change requests. Timestamp interval defaults to the last 365 days if both query parameters are omitted. If only one parameter is omitted, the interval will default to a 180 day range in the specified direction.","```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.OrganizationApi(); after = 56 # int | Timestamp indicating the date to begin after when searching for requests. (optional) before = 56 # int | Timestamp indicating the date to end before when searching for requests. (optional) status = 'status_example' # str | Status of the request to be filtered by (optional) page_size = 25 # int | Page Size (optional) (default to 25) expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get the available limit change requests api_response = api_instance.get_organizations_limits_changerequests(after=after, before=before, status=status, page_size=page_size, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_limits_changerequests: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/limits/changerequests/{requestId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a limit change request,"```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.OrganizationApi(); request_id = 'request_id_example' # str | Unique id for the limit change request try: # Get a limit change request api_response = api_instance.get_organizations_limits_changerequest(request_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_limits_changerequest: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/limits/docs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get limit documentation,"```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.OrganizationApi(); try: # Get limit documentation api_response = api_instance.get_organizations_limits_docs() pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_limits_docs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/limits/docs/freetrial Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get free trial limit documentation,"```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.OrganizationApi(); try: # Get free trial limit documentation api_response = api_instance.get_organizations_limits_docs_freetrial() pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_limits_docs_freetrial: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/limits/namespaces Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the available limit namespaces,"```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.OrganizationApi(); page_size = 100 # int | Page size (optional) (default to 100) page_number = 1 # int | Page number (optional) (default to 1) try: # Get the available limit namespaces api_response = api_instance.get_organizations_limits_namespaces(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_limits_namespaces: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/limits/namespaces/{namespaceName} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the effective limits in a namespace for an organization,"```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.OrganizationApi(); namespace_name = 'namespace_name_example' # str | The namespace to fetch limits for try: # Get the effective limits in a namespace for an organization api_response = api_instance.get_organizations_limits_namespace(namespace_name) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_limits_namespace: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/limits/namespaces/{namespaceName}/counts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events 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.OrganizationApi(); namespace_name = 'namespace_name_example' # str | The namespace to get cursor = 'cursor_example' # str | Cursor provided when retrieving the last page (optional) entity_id = 'entity_id_example' # str | entity id of the count (optional) user_id = 'user_id_example' # str | userid of the count (optional) try: # Get estimated limit counts for a namespace. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking. api_response = api_instance.get_organizations_limits_namespace_counts(namespace_name, cursor=cursor, entity_id=entity_id, user_id=user_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_limits_namespace_counts: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/limits/namespaces/{namespaceName}/defaults Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the default limits in a namespace for an organization,"```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.OrganizationApi(); namespace_name = 'namespace_name_example' # str | The namespace to fetch defaults limits for try: # Get the default limits in a namespace for an organization api_response = api_instance.get_organizations_limits_namespace_defaults(namespace_name) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_limits_namespace_defaults: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/limits/namespaces/{namespaceName}/limits/{limitName}/counts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events 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.OrganizationApi(); namespace_name = 'namespace_name_example' # str | The namespace to get limit_name = 'limit_name_example' # str | The limit to get entity_id = 'entity_id_example' # str | entity id of the count (optional) user_id = 'user_id_example' # str | userid of the count (optional) cursor = 'cursor_example' # str | Cursor provided when retrieving the last page (optional) try: # Get estimated limit counts for a namespace and limit name. This is not a source of truth for limit values but a record of estimates to facilitate limit threshold tracking. api_response = api_instance.get_organizations_limits_namespace_limit_counts(namespace_name, limit_name, entity_id=entity_id, user_id=user_id, cursor=cursor) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_limits_namespace_limit_counts: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/organizations/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get organization.,"```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.OrganizationApi(); try: # Get organization. api_response = api_instance.get_organizations_me() pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->get_organizations_me: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/organizations/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update organization.,"```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.OrganizationApi(); body = PureCloudPlatformClientV2.Organization() # Organization | Organization (optional) try: # Update organization. api_response = api_instance.put_organizations_me(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationApi->put_organizations_me: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/orgauthorization/pairings Genesys Cloud Python SDK.,Genesys describes this as an API used to: A pairing id is created by the trustee and given to the trustor to create a trust.,"```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.OrganizationAuthorizationApi(); body = PureCloudPlatformClientV2.TrustRequestCreate() # TrustRequestCreate | Pairing Info try: # A pairing id is created by the trustee and given to the trustor to create a trust. api_response = api_instance.post_orgauthorization_pairings(body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->post_orgauthorization_pairings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/pairings/{pairingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Pairing Info,"```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.OrganizationAuthorizationApi(); pairing_id = 'pairing_id_example' # str | Pairing Id try: # Get Pairing Info api_response = api_instance.get_orgauthorization_pairing(pairing_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_pairing: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustees Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of trustees for this organization (i.e. organizations granted access to this organization).,"```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.OrganizationAuthorizationApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # The list of trustees for this organization (i.e. organizations granted access to this organization). api_response = api_instance.get_orgauthorization_trustees(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustees: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/orgauthorization/trustees Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new organization authorization trust. This is required to grant other organizations access to your organization.,"```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.OrganizationAuthorizationApi(); body = PureCloudPlatformClientV2.TrustCreate() # TrustCreate | Trust try: # Create a new organization authorization trust. This is required to grant other organizations access to your organization. api_response = api_instance.post_orgauthorization_trustees(body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustees: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/orgauthorization/trustees/audits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Org Trustee Audits,"```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.OrganizationAuthorizationApi(); body = PureCloudPlatformClientV2.TrusteeAuditQueryRequest() # TrusteeAuditQueryRequest | Values to scope the request. page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''timestamp'' # str | Sort by (optional) (default to 'timestamp') sort_order = ''descending'' # str | Sort order (optional) (default to 'descending') try: # Get Org Trustee Audits api_response = api_instance.post_orgauthorization_trustees_audits(body, page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustees_audits: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustees/default Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get organization authorization trust with Customer Care, if one exists.","```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.OrganizationAuthorizationApi(); try: # Get organization authorization trust with Customer Care, if one exists. api_response = api_instance.get_orgauthorization_trustees_default() pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustees_default: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/orgauthorization/trustees/default Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization.,"```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.OrganizationAuthorizationApi(); assign_default_role = True # bool | Assign Admin role to default pairing with Customer Care (optional) auto_expire = True # bool | Automatically expire pairing after 30 days (optional) try: # Create a new organization authorization trust with Customer Care. This is required to grant your regional Customer Care organization access to your organization. api_response = api_instance.post_orgauthorization_trustees_default(assign_default_role=assign_default_role, auto_expire=auto_expire) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustees_default: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Org Trust,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id try: # Delete Org Trust api_instance.delete_orgauthorization_trustee(trustee_org_id) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustees/{trusteeOrgId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Org Trust,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id try: # Get Org Trust api_response = api_instance.get_orgauthorization_trustee(trustee_org_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/orgauthorization/trustees/{trusteeOrgId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Org Trust,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id body = PureCloudPlatformClientV2.TrustUpdate() # TrustUpdate | Client try: # Update Org Trust api_response = api_instance.put_orgauthorization_trustee(trustee_org_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustee: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers Genesys Cloud Python SDK.,"Genesys describes this as an API used to: The list of cloned users from the trustee organization (i.e. users with a native user record). There can be no more than 5 cloned users per organization, so results are represented as simple list and not paged","```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id try: # The list of cloned users from the trustee organization (i.e. users with a native user record). api_response = api_instance.get_orgauthorization_trustee_clonedusers(trustee_org_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_clonedusers: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/clonedusers/{trusteeUserId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes cloned 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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_user_id = 'trustee_user_id_example' # str | Id of the cloned user to delete try: # Deletes cloned user api_instance.delete_orgauthorization_trustee_cloneduser(trustee_org_id, trustee_user_id) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee_cloneduser: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of trustee groups for this organization (i.e. groups granted access to this organization).,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # The list of trustee groups for this organization (i.e. groups granted access to this organization). api_response = api_instance.get_orgauthorization_trustee_groups(trustee_org_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_groups: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a group to the trust.,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id body = PureCloudPlatformClientV2.TrustMemberCreate() # TrustMemberCreate | Trust try: # Add a group to the trust. api_response = api_instance.post_orgauthorization_trustee_groups(trustee_org_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustee_groups: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Trustee Group,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_group_id = 'trustee_group_id_example' # str | Trustee Group Id try: # Delete Trustee Group api_instance.delete_orgauthorization_trustee_group(trustee_org_id, trustee_group_id) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee_group: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Trustee Group,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_group_id = 'trustee_group_id_example' # str | Trustee Group Id try: # Get Trustee Group api_response = api_instance.get_orgauthorization_trustee_group(trustee_org_id, trustee_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_group: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roledivisions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Trustee Group Roles,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_group_id = 'trustee_group_id_example' # str | Trustee Group Id body = PureCloudPlatformClientV2.RoleDivisionGrants() # RoleDivisionGrants | Set of roles with corresponding divisions to apply try: # Update Trustee Group Roles api_response = api_instance.put_orgauthorization_trustee_group_roledivisions(trustee_org_id, trustee_group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustee_group_roledivisions: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Trustee Group Roles,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_group_id = 'trustee_group_id_example' # str | Trustee Group Id try: # Delete Trustee Group Roles api_instance.delete_orgauthorization_trustee_group_roles(trustee_org_id, trustee_group_id) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee_group_roles: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Trustee Group Roles,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_group_id = 'trustee_group_id_example' # str | Trustee Group Id try: # Get Trustee Group Roles api_response = api_instance.get_orgauthorization_trustee_group_roles(trustee_org_id, trustee_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_group_roles: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/groups/{trusteeGroupId}/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Trustee Group Roles,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_group_id = 'trustee_group_id_example' # str | Trustee Group Id body = ['body_example'] # list[str] | List of roles try: # Update Trustee Group Roles api_response = api_instance.put_orgauthorization_trustee_group_roles(trustee_org_id, trustee_group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustee_group_roles: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of trustee users for this organization (i.e. users granted access to this organization).,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # The list of trustee users for this organization (i.e. users granted access to this organization). api_response = api_instance.get_orgauthorization_trustee_users(trustee_org_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_users: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/orgauthorization/trustees/{trusteeOrgId}/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a user to the trust.,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id body = PureCloudPlatformClientV2.TrustMemberCreate() # TrustMemberCreate | Trust try: # Add a user to the trust. api_response = api_instance.post_orgauthorization_trustee_users(trustee_org_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustee_users: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Trustee 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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id try: # Delete Trustee User api_instance.delete_orgauthorization_trustee_user(trustee_org_id, trustee_user_id) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Trustee 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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id try: # Get Trustee User api_response = api_instance.get_orgauthorization_trustee_user(trustee_org_id, trustee_user_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_user: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roledivisions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Trustee User Roles,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id body = PureCloudPlatformClientV2.RoleDivisionGrants() # RoleDivisionGrants | Set of roles with corresponding divisions to apply try: # Update Trustee User Roles api_response = api_instance.put_orgauthorization_trustee_user_roledivisions(trustee_org_id, trustee_user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustee_user_roledivisions: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Trustee User Roles,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id try: # Delete Trustee User Roles api_instance.delete_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustee_user_roles: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Trustee User Roles,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id try: # Get Trustee User Roles api_response = api_instance.get_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustee_user_roles: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/orgauthorization/trustees/{trusteeOrgId}/users/{trusteeUserId}/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Trustee User Roles,"```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.OrganizationAuthorizationApi(); trustee_org_id = 'trustee_org_id_example' # str | Trustee Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id body = ['body_example'] # list[str] | List of roles try: # Update Trustee User Roles api_response = api_instance.put_orgauthorization_trustee_user_roles(trustee_org_id, trustee_user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustee_user_roles: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/orgauthorization/trustor/audits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Org Trustor Audits,"```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.OrganizationAuthorizationApi(); body = PureCloudPlatformClientV2.TrustorAuditQueryRequest() # TrustorAuditQueryRequest | Values to scope the request. page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''timestamp'' # str | Sort by (optional) (default to 'timestamp') sort_order = ''descending'' # str | Sort order (optional) (default to 'descending') try: # Get Org Trustor Audits api_response = api_instance.post_orgauthorization_trustor_audits(body, page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->post_orgauthorization_trustor_audits: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustors Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of organizations that have authorized/trusted your organization.,"```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.OrganizationAuthorizationApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # The list of organizations that have authorized/trusted your organization. api_response = api_instance.get_orgauthorization_trustors(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustors: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orgauthorization/trustors/{trustorOrgId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Org Trust,"```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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id try: # Delete Org Trust api_instance.delete_orgauthorization_trustor(trustor_org_id) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustor: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustors/{trustorOrgId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Org Trust,"```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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id try: # Get Org Trust api_response = api_instance.get_orgauthorization_trustor(trustor_org_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of cloned users in the trustor organization (i.e. users with a native user record).,"```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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id try: # The list of cloned users in the trustor organization (i.e. users with a native user record). api_response = api_instance.get_orgauthorization_trustor_clonedusers(trustor_org_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor_clonedusers: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Cloned 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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id try: # Delete Cloned User api_instance.delete_orgauthorization_trustor_cloneduser(trustor_org_id, trustee_user_id) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustor_cloneduser: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Cloned 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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id try: # Get Cloned User api_response = api_instance.get_orgauthorization_trustor_cloneduser(trustor_org_id, trustee_user_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor_cloneduser: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/clonedusers/{trusteeUserId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a clone of the trustee user in the trustor 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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id try: # Creates a clone of the trustee user in the trustor org. api_response = api_instance.put_orgauthorization_trustor_cloneduser(trustor_org_id, trustee_user_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustor_cloneduser: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustors/{trustorOrgId}/groups Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of groups in the trustor organization (i.e. groups granted access).,"```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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustee Organization Id page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # The list of groups in the trustor organization (i.e. groups granted access). api_response = api_instance.get_orgauthorization_trustor_groups(trustor_org_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor_groups: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Trustee Group,"```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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id trustor_group_id = 'trustor_group_id_example' # str | Trustor Group Id try: # Delete Trustee Group api_instance.delete_orgauthorization_trustor_group(trustor_org_id, trustor_group_id) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustor_group: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Trustee Group,"```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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id trustor_group_id = 'trustor_group_id_example' # str | Trustor Group Id try: # Get Trustee Group api_response = api_instance.get_orgauthorization_trustor_group(trustor_org_id, trustor_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor_group: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/groups/{trustorGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a Trustee Group to the trust.,"```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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id trustor_group_id = 'trustor_group_id_example' # str | Trustor Group Id try: # Add a Trustee Group to the trust. api_response = api_instance.put_orgauthorization_trustor_group(trustor_org_id, trustor_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustor_group: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: The list of users in the trustor organization (i.e. users granted access).,"```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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustee Organization Id page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # The list of users in the trustor organization (i.e. users granted access). api_response = api_instance.get_orgauthorization_trustor_users(trustor_org_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor_users: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Trustee 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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id try: # Delete Trustee User api_instance.delete_orgauthorization_trustor_user(trustor_org_id, trustee_user_id) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->delete_orgauthorization_trustor_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Trustee 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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id try: # Get Trustee User api_response = api_instance.get_orgauthorization_trustor_user(trustor_org_id, trustee_user_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->get_orgauthorization_trustor_user: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/orgauthorization/trustors/{trustorOrgId}/users/{trusteeUserId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a Trustee user to the trust.,"```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.OrganizationAuthorizationApi(); trustor_org_id = 'trustor_org_id_example' # str | Trustor Organization Id trustee_user_id = 'trustee_user_id_example' # str | Trustee User Id try: # Add a Trustee user to the trust. api_response = api_instance.put_orgauthorization_trustor_user(trustor_org_id, trustee_user_id) pprint(api_response) except ApiException as e: print(""Exception when calling OrganizationAuthorizationApi->put_orgauthorization_trustor_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/attemptlimits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query attempt limits list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query attempt limits list api_response = api_instance.get_outbound_attemptlimits(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_attemptlimits: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/attemptlimits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create attempt limits,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.AttemptLimits() # AttemptLimits | AttemptLimits try: # Create attempt limits api_response = api_instance.post_outbound_attemptlimits(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_attemptlimits: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/attemptlimits/{attemptLimitsId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete attempt limits,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); attempt_limits_id = 'attempt_limits_id_example' # str | Attempt limits ID try: # Delete attempt limits api_instance.delete_outbound_attemptlimit(attempt_limits_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_attemptlimit: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/attemptlimits/{attemptLimitsId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get attempt limits,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); attempt_limits_id = 'attempt_limits_id_example' # str | Attempt limits ID try: # Get attempt limits api_response = api_instance.get_outbound_attemptlimit(attempt_limits_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_attemptlimit: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/attemptlimits/{attemptLimitsId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update attempt limits,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); attempt_limits_id = 'attempt_limits_id_example' # str | Attempt limits ID body = PureCloudPlatformClientV2.AttemptLimits() # AttemptLimits | AttemptLimits try: # Update attempt limits api_response = api_instance.put_outbound_attemptlimit(attempt_limits_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_attemptlimit: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/callabletimesets Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query callable time set list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query callable time set list api_response = api_instance.get_outbound_callabletimesets(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_callabletimesets: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/callabletimesets Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create callable time set,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.CallableTimeSet() # CallableTimeSet | DialerCallableTimeSet try: # Create callable time set api_response = api_instance.post_outbound_callabletimesets(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_callabletimesets: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/callabletimesets/{callableTimeSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete callable time set,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); callable_time_set_id = 'callable_time_set_id_example' # str | Callable Time Set ID try: # Delete callable time set api_instance.delete_outbound_callabletimeset(callable_time_set_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_callabletimeset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/callabletimesets/{callableTimeSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get callable time set,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); callable_time_set_id = 'callable_time_set_id_example' # str | Callable Time Set ID try: # Get callable time set api_response = api_instance.get_outbound_callabletimeset(callable_time_set_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_callabletimeset: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/callabletimesets/{callableTimeSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update callable time set,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); callable_time_set_id = 'callable_time_set_id_example' # str | Callable Time Set ID body = PureCloudPlatformClientV2.CallableTimeSet() # CallableTimeSet | DialerCallableTimeSet try: # Update callable time set api_response = api_instance.put_outbound_callabletimeset(callable_time_set_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_callabletimeset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/callanalysisresponsesets Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query a list of dialer call analysis response sets.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query a list of dialer call analysis response sets. api_response = api_instance.get_outbound_callanalysisresponsesets(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_callanalysisresponsesets: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/callanalysisresponsesets Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a dialer call analysis response set.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.ResponseSet() # ResponseSet | ResponseSet try: # Create a dialer call analysis response set. api_response = api_instance.post_outbound_callanalysisresponsesets(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_callanalysisresponsesets: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a dialer call analysis response set.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); call_analysis_set_id = 'call_analysis_set_id_example' # str | Call Analysis Response Set ID try: # Delete a dialer call analysis response set. api_instance.delete_outbound_callanalysisresponseset(call_analysis_set_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_callanalysisresponseset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a dialer call analysis response set.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); call_analysis_set_id = 'call_analysis_set_id_example' # str | Call Analysis Response Set ID try: # Get a dialer call analysis response set. api_response = api_instance.get_outbound_callanalysisresponseset(call_analysis_set_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_callanalysisresponseset: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/callanalysisresponsesets/{callAnalysisSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a dialer call analysis response set.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); call_analysis_set_id = 'call_analysis_set_id_example' # str | Call Analysis Response Set ID body = PureCloudPlatformClientV2.ResponseSet() # ResponseSet | ResponseSet try: # Update a dialer call analysis response set. api_response = api_instance.put_outbound_callanalysisresponseset(call_analysis_set_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_callanalysisresponseset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaignrules Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query Campaign Rule list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query Campaign Rule list api_response = api_instance.get_outbound_campaignrules(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaignrules: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/campaignrules Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create Campaign Rule,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.CampaignRule() # CampaignRule | CampaignRule try: # Create Campaign Rule api_response = api_instance.post_outbound_campaignrules(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_campaignrules: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/campaignrules/{campaignRuleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Campaign Rule,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_rule_id = 'campaign_rule_id_example' # str | Campaign Rule ID try: # Delete Campaign Rule api_instance.delete_outbound_campaignrule(campaign_rule_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_campaignrule: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaignrules/{campaignRuleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Campaign Rule,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_rule_id = 'campaign_rule_id_example' # str | Campaign Rule ID try: # Get Campaign Rule api_response = api_instance.get_outbound_campaignrule(campaign_rule_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaignrule: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/campaignrules/{campaignRuleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Campaign Rule,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_rule_id = 'campaign_rule_id_example' # str | Campaign Rule ID body = PureCloudPlatformClientV2.CampaignRule() # CampaignRule | CampaignRule try: # Update Campaign Rule api_response = api_instance.put_outbound_campaignrule(campaign_rule_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_campaignrule: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query a list of dialer campaigns.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) id = ['id_example'] # list[str] | id (optional) contact_list_id = 'contact_list_id_example' # str | Contact List ID (optional) dnc_list_ids = 'dnc_list_ids_example' # str | DNC list ID (optional) distribution_queue_id = 'distribution_queue_id_example' # str | Distribution queue ID (optional) edge_group_id = 'edge_group_id_example' # str | Edge group ID (optional) call_analysis_response_set_id = 'call_analysis_response_set_id_example' # str | Call analysis response set ID (optional) division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query a list of dialer campaigns. api_response = api_instance.get_outbound_campaigns(page_size=page_size, page_number=page_number, filter_type=filter_type, name=name, id=id, contact_list_id=contact_list_id, dnc_list_ids=dnc_list_ids, distribution_queue_id=distribution_queue_id, edge_group_id=edge_group_id, call_analysis_response_set_id=call_analysis_response_set_id, division_id=division_id, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaigns: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/campaigns Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a campaign.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.Campaign() # Campaign | Campaign try: # Create a campaign. api_response = api_instance.post_outbound_campaigns(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_campaigns: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/all Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query across all types of campaigns by division,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) id = ['id_example'] # list[str] | Campaign ID(s) (optional) name = 'name_example' # str | Campaign name(s) (optional) division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) media_type = ['media_type_example'] # list[str] | Media type(s) (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query across all types of campaigns by division api_response = api_instance.get_outbound_campaigns_all(page_size=page_size, page_number=page_number, id=id, name=name, division_id=division_id, media_type=media_type, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaigns_all: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/all/divisionviews Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query across all types of campaigns,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) id = ['id_example'] # list[str] | Campaign ID(s) (optional) name = 'name_example' # str | Campaign name(s) (optional) division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) media_type = ['media_type_example'] # list[str] | Media type(s) (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query across all types of campaigns api_response = api_instance.get_outbound_campaigns_all_divisionviews(page_size=page_size, page_number=page_number, id=id, name=name, division_id=division_id, media_type=media_type, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaigns_all_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Query a list of basic Campaign information objects. This returns a simplified version of a Campaign, consisting of name and division.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) id = ['id_example'] # list[str] | id (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query a list of basic Campaign information objects api_response = api_instance.get_outbound_campaigns_divisionviews(page_size=page_size, page_number=page_number, filter_type=filter_type, name=name, id=id, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaigns_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/divisionviews/{campaignId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a basic Campaign information object. This returns a simplified version of a Campaign, consisting of name and division.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Get a basic Campaign information object api_response = api_instance.get_outbound_campaigns_divisionview(campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaigns_divisionview: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/campaigns/progress Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get progress for a list of campaigns,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = ['body_example'] # list[str] | Campaign IDs try: # Get progress for a list of campaigns api_response = api_instance.post_outbound_campaigns_progress(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_campaigns_progress: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/campaigns/{campaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a campaign.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Delete a campaign. api_response = api_instance.delete_outbound_campaign(campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_campaign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get dialer campaign.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Get dialer campaign. api_response = api_instance.get_outbound_campaign(campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaign: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/outbound/campaigns/{campaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a campaign.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID body = PureCloudPlatformClientV2.CampaignPatchRequest() # CampaignPatchRequest | CampaignPatchRequest try: # Update a campaign. api_instance.patch_outbound_campaign(campaign_id, body) except ApiException as e: print(""Exception when calling OutboundApi->patch_outbound_campaign: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/campaigns/{campaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a campaign.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID body = PureCloudPlatformClientV2.Campaign() # Campaign | Campaign try: # Update a campaign. api_response = api_instance.put_outbound_campaign(campaign_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_campaign: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview Genesys Cloud Python SDK.,Genesys describes this as an API used to: Initiate request for a preview of how agents will be mapped to this campaign's contact list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Initiate request for a preview of how agents will be mapped to this campaign's contact list. api_response = api_instance.post_outbound_campaign_agentownedmappingpreview(campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_campaign_agentownedmappingpreview: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/agentownedmappingpreview/results Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a preview of how agents will be mapped to this campaign's contact list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Get a preview of how agents will be mapped to this campaign's contact list. api_response = api_instance.get_outbound_campaign_agentownedmappingpreview_results(campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaign_agentownedmappingpreview_results: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/campaigns/{campaignId}/agents/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send notification that an agent's state changed. New agent state.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID user_id = 'user_id_example' # str | Agent's user ID body = PureCloudPlatformClientV2.Agent() # Agent | agent try: # Send notification that an agent's state changed api_response = api_instance.put_outbound_campaign_agent(campaign_id, user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_campaign_agent: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/diagnostics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get campaign diagnostics,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Get campaign diagnostics api_response = api_instance.get_outbound_campaign_diagnostics(campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaign_diagnostics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/interactions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get dialer campaign interactions.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Get dialer campaign interactions. api_response = api_instance.get_outbound_campaign_interactions(campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaign_interactions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/linedistribution Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get line distribution information for campaigns using same Edge Group or Site as given campaign,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID include_only_active_campaigns = True # bool | If true will return only active Campaigns (optional) (default to True) edge_group_id = 'edge_group_id_example' # str | Edge group to be used in line distribution calculations instead of current Campaign's Edge Group. Campaign's Site and Edge Group are mutually exclusive. (optional) site_id = 'site_id_example' # str | Site to be used in line distribution calculations instead of current Campaign's Site. Campaign's Site and Edge Group are mutually exclusive. (optional) use_weight = True # bool | Enable usage of weight, this value overrides current Campaign's setting in line distribution calculations (optional) relative_weight = 56 # int | Relative weight to be used in line distribution calculations instead of current Campaign's relative weight (optional) outbound_line_count = 56 # int | The number of outbound lines to be used in line distribution calculations, instead of current Campaign's Outbound Lines Count (optional) try: # Get line distribution information for campaigns using same Edge Group or Site as given campaign api_response = api_instance.get_outbound_campaign_linedistribution(campaign_id, include_only_active_campaigns=include_only_active_campaigns, edge_group_id=edge_group_id, site_id=site_id, use_weight=use_weight, relative_weight=relative_weight, outbound_line_count=outbound_line_count) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaign_linedistribution: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/campaigns/{campaignId}/progress Genesys Cloud Python SDK.,Genesys describes this as an API used to: Reset campaign progress and recycle the campaign,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Reset campaign progress and recycle the campaign api_instance.delete_outbound_campaign_progress(campaign_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_campaign_progress: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/progress Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get campaign progress,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Get campaign progress api_response = api_instance.get_outbound_campaign_progress(campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaign_progress: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/skillcombinations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the remaining and total contact count for each skill combination in a skills campaign,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Get the remaining and total contact count for each skill combination in a skills campaign api_response = api_instance.get_outbound_campaign_skillcombinations(campaign_id, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaign_skillcombinations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/campaigns/{campaignId}/stats Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get statistics about a Dialer Campaign,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Get statistics about a Dialer Campaign api_response = api_instance.get_outbound_campaign_stats(campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_campaign_stats: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlistfilters Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query Contact list filters,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') contact_list_id = 'contact_list_id_example' # str | Contact List ID (optional) try: # Query Contact list filters api_response = api_instance.get_outbound_contactlistfilters(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order, contact_list_id=contact_list_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlistfilters: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlistfilters Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create Contact List Filter,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.ContactListFilter() # ContactListFilter | ContactListFilter try: # Create Contact List Filter api_response = api_instance.post_outbound_contactlistfilters(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlistfilters: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlistfilters/bulk/retrieve Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve multiple contact list filters,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.ContactListFilterBulkRetrieveBody() # ContactListFilterBulkRetrieveBody | The contact list filters to retrieve try: # Retrieve multiple contact list filters api_response = api_instance.post_outbound_contactlistfilters_bulk_retrieve(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlistfilters_bulk_retrieve: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlistfilters/preview Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a preview of the output of a contact list filter,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.ContactListFilter() # ContactListFilter | ContactListFilter try: # Get a preview of the output of a contact list filter api_response = api_instance.post_outbound_contactlistfilters_preview(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlistfilters_preview: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/contactlistfilters/{contactListFilterId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Contact List Filter,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_filter_id = 'contact_list_filter_id_example' # str | Contact List Filter ID try: # Delete Contact List Filter api_instance.delete_outbound_contactlistfilter(contact_list_filter_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_contactlistfilter: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlistfilters/{contactListFilterId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Contact list filter,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_filter_id = 'contact_list_filter_id_example' # str | Contact List Filter ID try: # Get Contact list filter api_response = api_instance.get_outbound_contactlistfilter(contact_list_filter_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlistfilter: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/contactlistfilters/{contactListFilterId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Contact List Filter,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_filter_id = 'contact_list_filter_id_example' # str | Contact List Filter ID body = PureCloudPlatformClientV2.ContactListFilter() # ContactListFilter | ContactListFilter try: # Update Contact List Filter api_response = api_instance.put_outbound_contactlistfilter(contact_list_filter_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_contactlistfilter: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/contactlists Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete multiple contact lists.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); id = ['id_example'] # list[str] | contact list id(s) to delete try: # Delete multiple contact lists. api_instance.delete_outbound_contactlists(id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_contactlists: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlists Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query a list of contact lists.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); include_import_status = False # bool | Include import status (optional) (default to False) include_size = False # bool | Include size (optional) (default to False) page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) id = ['id_example'] # list[str] | id (optional) division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query a list of contact lists. api_response = api_instance.get_outbound_contactlists(include_import_status=include_import_status, include_size=include_size, page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, id=id, division_id=division_id, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlists: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlists Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a contact List.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.ContactList() # ContactList | ContactList try: # Create a contact List. api_response = api_instance.post_outbound_contactlists(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlists: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlists/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Query a list of simplified contact list objects. This return a simplified version of contact lists, consisting of the name, division, column names, phone columns, import status, and size.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); include_import_status = False # bool | Include import status (optional) (default to False) include_size = False # bool | Include size (optional) (default to False) page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) id = ['id_example'] # list[str] | id (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query a list of simplified contact list objects. api_response = api_instance.get_outbound_contactlists_divisionviews(include_import_status=include_import_status, include_size=include_size, page_size=page_size, page_number=page_number, filter_type=filter_type, name=name, id=id, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlists_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlists/divisionviews/{contactListId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a basic ContactList information object. This returns a simplified version of a ContactList, consisting of the name, division, column names, phone columns, import status, and size.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contactlist ID include_import_status = False # bool | Include import status (optional) (default to False) include_size = False # bool | Include size (optional) (default to False) try: # Get a basic ContactList information object api_response = api_instance.get_outbound_contactlists_divisionview(contact_list_id, include_import_status=include_import_status, include_size=include_size) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlists_divisionview: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/contactlists/{contactListId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a contact list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | ContactList ID try: # Delete a contact list. api_instance.delete_outbound_contactlist(contact_list_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_contactlist: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a dialer contact list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | ContactList ID include_import_status = False # bool | Import status (optional) (default to False) include_size = False # bool | Include size (optional) (default to False) try: # Get a dialer contact list. api_response = api_instance.get_outbound_contactlist(contact_list_id, include_import_status=include_import_status, include_size=include_size) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlist: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/contactlists/{contactListId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a contact list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | ContactList ID body = PureCloudPlatformClientV2.ContactList() # ContactList | ContactList try: # Update a contact list. api_response = api_instance.put_outbound_contactlist(contact_list_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_contactlist: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/clear Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID try: # Deletes all contacts out of a list. All outstanding recalls or rule-scheduled callbacks for non-preview campaigns configured with the contactlist will be cancelled. api_instance.post_outbound_contactlist_clear(contact_list_id) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlist_clear: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/contactlists/{contactListId}/contacts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete contacts from a contact list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID contact_ids = ['contact_ids_example'] # list[str] | ContactIds to delete. try: # Delete contacts from a contact list. api_instance.delete_outbound_contactlist_contacts(contact_list_id, contact_ids) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_contactlist_contacts: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/contacts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add contacts to a contact list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID body = [PureCloudPlatformClientV2.WritableDialerContact()] # list[WritableDialerContact] | Contact priority = True # bool | Contact priority. True means the contact(s) will be dialed next; false means the contact will go to the end of the contact queue. (optional) clear_system_data = True # bool | Clear system data. True means the system columns (attempts, callable status, etc) stored on the contact will be cleared if the contact already exists; false means they won't. (optional) do_not_queue = True # bool | Do not queue. True means that updated contacts will not have their positions in the queue altered, so contacts that have already been dialed will not be redialed. For new contacts, this parameter has no effect; False means that updated contacts will be re-queued, according to the 'priority' parameter. (optional) try: # Add contacts to a contact list. api_response = api_instance.post_outbound_contactlist_contacts(contact_list_id, body, priority=priority, clear_system_data=clear_system_data, do_not_queue=do_not_queue) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlist_contacts: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get contacts from a contact list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID body = ['body_example'] # list[str] | ContactIds to get. try: # Get contacts from a contact list. api_response = api_instance.post_outbound_contactlist_contacts_bulk(contact_list_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlist_contacts_bulk: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get 10 most recent bulk operation jobs associated with contact list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID try: # Get 10 most recent bulk operation jobs associated with contact list. api_response = api_instance.get_outbound_contactlist_contacts_bulk_jobs(contact_list_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlist_contacts_bulk_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get bulk operation job.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID job_id = 'job_id_example' # str | Job ID try: # Get bulk operation job. api_response = api_instance.get_outbound_contactlist_contacts_bulk_job(contact_list_id, job_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlist_contacts_bulk_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/remove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Start an async job to delete contacts using a filter.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID body = PureCloudPlatformClientV2.ContactBulkSearchParameters() # ContactBulkSearchParameters | Contact filter information. try: # Start an async job to delete contacts using a filter. api_response = api_instance.post_outbound_contactlist_contacts_bulk_remove(contact_list_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlist_contacts_bulk_remove: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/contacts/bulk/update Genesys Cloud Python SDK.,Genesys describes this as an API used to: Start an async job to bulk edit contacts.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID body = PureCloudPlatformClientV2.ContactBulkEditRequest() # ContactBulkEditRequest | Contact bulk edit request information. try: # Start an async job to bulk edit contacts. api_response = api_instance.post_outbound_contactlist_contacts_bulk_update(contact_list_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlist_contacts_bulk_update: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/contacts/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query contacts from a contact list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID body = PureCloudPlatformClientV2.ContactListingRequest() # ContactListingRequest | Contact search parameters. try: # Query contacts from a contact list. api_response = api_instance.post_outbound_contactlist_contacts_search(contact_list_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlist_contacts_search: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a contact.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID contact_id = 'contact_id_example' # str | Contact ID try: # Delete a contact. api_instance.delete_outbound_contactlist_contact(contact_list_id, contact_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_contactlist_contact: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a contact.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID contact_id = 'contact_id_example' # str | Contact ID try: # Get a contact. api_response = api_instance.get_outbound_contactlist_contact(contact_list_id, contact_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlist_contact: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/contactlists/{contactListId}/contacts/{contactId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a contact.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | Contact List ID contact_id = 'contact_id_example' # str | Contact ID body = PureCloudPlatformClientV2.DialerContact() # DialerContact | Contact try: # Update a contact. api_response = api_instance.put_outbound_contactlist_contact(contact_list_id, contact_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_contactlist_contact: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/export Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the URI of a contact list export.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | ContactList ID download = ''false'' # str | Redirect to download uri (optional) (default to 'false') try: # Get the URI of a contact list export. api_response = api_instance.get_outbound_contactlist_export(contact_list_id, download=download) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlist_export: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlists/{contactListId}/export Genesys Cloud Python SDK.,Genesys describes this as an API used to: Initiate the export of a contact list. Returns 200 if received OK.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | ContactList ID body = PureCloudPlatformClientV2.ContactsExportRequest() # ContactsExportRequest | Export information to get (optional) try: # Initiate the export of a contact list. api_response = api_instance.post_outbound_contactlist_export(contact_list_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlist_export: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/importstatus Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get dialer contactList import status.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | ContactList ID try: # Get dialer contactList import status. api_response = api_instance.get_outbound_contactlist_importstatus(contact_list_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlist_importstatus: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlists/{contactListId}/timezonemappingpreview Genesys Cloud Python SDK.,Genesys describes this as an API used to: Preview the result of applying Automatic Time Zone Mapping to a contact list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_id = 'contact_list_id_example' # str | ContactList ID try: # Preview the result of applying Automatic Time Zone Mapping to a contact list api_response = api_instance.get_outbound_contactlist_timezonemappingpreview(contact_list_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlist_timezonemappingpreview: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/contactlisttemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete multiple contact list templates.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); id = ['id_example'] # list[str] | contact list template id(s) to delete try: # Delete multiple contact list templates. api_instance.delete_outbound_contactlisttemplates(id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_contactlisttemplates: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlisttemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query a list of contact list templates,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query a list of contact list templates api_response = api_instance.get_outbound_contactlisttemplates(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlisttemplates: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlisttemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create Contact List Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.ContactListTemplate() # ContactListTemplate | ContactListTemplate try: # Create Contact List Template api_response = api_instance.post_outbound_contactlisttemplates(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlisttemplates: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlisttemplates/bulk/add Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add multiple contact list templates,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = [PureCloudPlatformClientV2.ContactListTemplate()] # list[ContactListTemplate] | contact list template(s) to add try: # Add multiple contact list templates api_response = api_instance.post_outbound_contactlisttemplates_bulk_add(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlisttemplates_bulk_add: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/contactlisttemplates/bulk/retrieve Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get multiple contact list templates,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.ContactListTemplateBulkRetrieveBody() # ContactListTemplateBulkRetrieveBody | contact list templates to get try: # Get multiple contact list templates api_response = api_instance.post_outbound_contactlisttemplates_bulk_retrieve(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_contactlisttemplates_bulk_retrieve: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/contactlisttemplates/{contactListTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Contact List Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_template_id = 'contact_list_template_id_example' # str | ContactListTemplate ID try: # Delete Contact List Template api_instance.delete_outbound_contactlisttemplate(contact_list_template_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_contactlisttemplate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/contactlisttemplates/{contactListTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Contact List Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_template_id = 'contact_list_template_id_example' # str | ContactListTemplate ID try: # Get Contact List Template api_response = api_instance.get_outbound_contactlisttemplate(contact_list_template_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_contactlisttemplate: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/contactlisttemplates/{contactListTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a contact list template.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); contact_list_template_id = 'contact_list_template_id_example' # str | ContactListTemplate ID body = PureCloudPlatformClientV2.ContactListTemplate() # ContactListTemplate | ContactListTemplate try: # Update a contact list template. api_response = api_instance.put_outbound_contactlisttemplate(contact_list_template_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_contactlisttemplate: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/conversations/{conversationId}/dnc Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add phone numbers to a Dialer DNC list.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); conversation_id = 'conversation_id_example' # str | Conversation ID try: # Add phone numbers to a Dialer DNC list. api_instance.post_outbound_conversation_dnc(conversation_id) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_conversation_dnc: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/digitalrulesets Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query a list of Outbound Digital Rule Sets,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''name'' # str | The field to sort by (optional) (default to 'name') sort_order = ''ascending'' # str | The direction to sort (optional) (default to 'ascending') name = 'name_example' # str | Name (optional) id = ['id_example'] # list[str] | A list of digital rule set ids to bulk fetch (optional) try: # Query a list of Outbound Digital Rule Sets api_response = api_instance.get_outbound_digitalrulesets(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, name=name, id=id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_digitalrulesets: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/digitalrulesets Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an Outbound Digital Rule Set,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.DigitalRuleSet() # DigitalRuleSet | Digital Rule Set try: # Create an Outbound Digital Rule Set api_response = api_instance.post_outbound_digitalrulesets(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_digitalrulesets: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/digitalrulesets/{digitalRuleSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an Outbound Digital Rule Set,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); digital_rule_set_id = 'digital_rule_set_id_example' # str | The Digital Rule Set ID try: # Delete an Outbound Digital Rule Set api_instance.delete_outbound_digitalruleset(digital_rule_set_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_digitalruleset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/digitalrulesets/{digitalRuleSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an Outbound Digital Rule Set,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); digital_rule_set_id = 'digital_rule_set_id_example' # str | The Digital Rule Set ID try: # Get an Outbound Digital Rule Set api_response = api_instance.get_outbound_digitalruleset(digital_rule_set_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_digitalruleset: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/digitalrulesets/{digitalRuleSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an Outbound Digital Rule Set,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); digital_rule_set_id = 'digital_rule_set_id_example' # str | The Digital Rule Set ID body = PureCloudPlatformClientV2.DigitalRuleSet() # DigitalRuleSet | Digital Rule Set try: # Update an Outbound Digital Rule Set api_response = api_instance.put_outbound_digitalruleset(digital_rule_set_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_digitalruleset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/dnclists Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query dialer DNC lists,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); include_import_status = False # bool | Import status (optional) (default to False) include_size = False # bool | Include size (optional) (default to False) page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) dnc_source_type = 'dnc_source_type_example' # str | DncSourceType (optional) division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = 'sort_order_example' # str | Sort order (optional) try: # Query dialer DNC lists api_response = api_instance.get_outbound_dnclists(include_import_status=include_import_status, include_size=include_size, page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, dnc_source_type=dnc_source_type, division_id=division_id, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_dnclists: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/dnclists Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create dialer DNC list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.DncListCreate() # DncListCreate | DncList try: # Create dialer DNC list api_response = api_instance.post_outbound_dnclists(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_dnclists: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/dnclists/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Query a list of simplified dnc list objects. This return a simplified version of dnc lists, consisting of the name, division, import status, and size.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); include_import_status = False # bool | Include import status (optional) (default to False) include_size = False # bool | Include size (optional) (default to False) page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) dnc_source_type = 'dnc_source_type_example' # str | DncSourceType (optional) id = ['id_example'] # list[str] | id (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query a list of simplified dnc list objects. api_response = api_instance.get_outbound_dnclists_divisionviews(include_import_status=include_import_status, include_size=include_size, page_size=page_size, page_number=page_number, filter_type=filter_type, name=name, dnc_source_type=dnc_source_type, id=id, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_dnclists_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/dnclists/divisionviews/{dncListId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a basic DncList information object. This returns a simplified version of a DncList, consisting of the name, division, import status, and size.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | Dnclist ID include_import_status = False # bool | Include import status (optional) (default to False) include_size = False # bool | Include size (optional) (default to False) try: # Get a basic DncList information object api_response = api_instance.get_outbound_dnclists_divisionview(dnc_list_id, include_import_status=include_import_status, include_size=include_size) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_dnclists_divisionview: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/dnclists/{dncListId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete dialer DNC list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID try: # Delete dialer DNC list api_instance.delete_outbound_dnclist(dnc_list_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_dnclist: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/dnclists/{dncListId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get dialer DNC list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID include_import_status = False # bool | Import status (optional) (default to False) include_size = False # bool | Include size (optional) (default to False) try: # Get dialer DNC list api_response = api_instance.get_outbound_dnclist(dnc_list_id, include_import_status=include_import_status, include_size=include_size) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_dnclist: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/dnclists/{dncListId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update dialer DNC list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID body = PureCloudPlatformClientV2.DncList() # DncList | DncList try: # Update dialer DNC list api_response = api_instance.put_outbound_dnclist(dnc_list_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_dnclist: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes all or expired custom exclusion column entries from a DNC list. This operation is only for Internal DNC lists of custom exclusion column entries,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID expired_only = False # bool | Set to true to only remove DNC entries that are expired (optional) (default to False) try: # Deletes all or expired custom exclusion column entries from a DNC list. api_instance.delete_outbound_dnclist_customexclusioncolumns(dnc_list_id, expired_only=expired_only) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_dnclist_customexclusioncolumns: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/outbound/dnclists/{dncListId}/customexclusioncolumns Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add entries to or delete entries from a DNC list. Only Internal DNC lists may be deleted from,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID body = PureCloudPlatformClientV2.DncPatchCustomExclusionColumnsRequest() # DncPatchCustomExclusionColumnsRequest | DNC Custom exclusion column entries try: # Add entries to or delete entries from a DNC list. api_instance.patch_outbound_dnclist_customexclusioncolumns(dnc_list_id, body) except ApiException as e: print(""Exception when calling OutboundApi->patch_outbound_dnclist_customexclusioncolumns: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/dnclists/{dncListId}/emailaddresses Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes all or expired email addresses from a DNC list. This operation is Only for Internal DNC lists of email addresses,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID expired_only = False # bool | Set to true to only remove DNC entries that are expired (optional) (default to False) try: # Deletes all or expired email addresses from a DNC list. api_instance.delete_outbound_dnclist_emailaddresses(dnc_list_id, expired_only=expired_only) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_dnclist_emailaddresses: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/outbound/dnclists/{dncListId}/emailaddresses Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add emails to or Delete emails from a DNC list. Only Internal DNC lists may be added to or deleted from,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID body = PureCloudPlatformClientV2.DncPatchEmailsRequest() # DncPatchEmailsRequest | DNC Emails try: # Add emails to or Delete emails from a DNC list. api_instance.patch_outbound_dnclist_emailaddresses(dnc_list_id, body) except ApiException as e: print(""Exception when calling OutboundApi->patch_outbound_dnclist_emailaddresses: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/dnclists/{dncListId}/emailaddresses Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add email addresses to a DNC list. Only Internal DNC lists may be appended to,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID body = ['body_example'] # list[str] | DNC email addresses try: # Add email addresses to a DNC list. api_instance.post_outbound_dnclist_emailaddresses(dnc_list_id, body) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_dnclist_emailaddresses: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/dnclists/{dncListId}/export Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the URI of a DNC list export.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID download = ''false'' # str | Redirect to download uri (optional) (default to 'false') try: # Get the URI of a DNC list export. api_response = api_instance.get_outbound_dnclist_export(dnc_list_id, download=download) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_dnclist_export: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/dnclists/{dncListId}/export Genesys Cloud Python SDK.,Genesys describes this as an API used to: Initiate the export of a dnc list. Returns 200 if received OK.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID try: # Initiate the export of a dnc list. api_response = api_instance.post_outbound_dnclist_export(dnc_list_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_dnclist_export: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/dnclists/{dncListId}/importstatus Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get dialer dncList import status.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID try: # Get dialer dncList import status. api_response = api_instance.get_outbound_dnclist_importstatus(dnc_list_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_dnclist_importstatus: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/dnclists/{dncListId}/phonenumbers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes all or expired phone numbers from a DNC list. This operation is Only for Internal DNC lists of phone numbers,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID expired_only = False # bool | Set to true to only remove DNC entries that are expired (optional) (default to False) try: # Deletes all or expired phone numbers from a DNC list. api_instance.delete_outbound_dnclist_phonenumbers(dnc_list_id, expired_only=expired_only) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_dnclist_phonenumbers: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/outbound/dnclists/{dncListId}/phonenumbers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add numbers to or delete numbers from a DNC list. Only Internal DNC lists may be added to deleted from,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID body = PureCloudPlatformClientV2.DncPatchPhoneNumbersRequest() # DncPatchPhoneNumbersRequest | DNC Phone Numbers try: # Add numbers to or delete numbers from a DNC list. api_instance.patch_outbound_dnclist_phonenumbers(dnc_list_id, body) except ApiException as e: print(""Exception when calling OutboundApi->patch_outbound_dnclist_phonenumbers: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/dnclists/{dncListId}/phonenumbers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add phone numbers to a DNC list. Only Internal DNC lists may be appended to,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); dnc_list_id = 'dnc_list_id_example' # str | DncList ID body = ['body_example'] # list[str] | DNC Phone Numbers expiration_date_time = 'expiration_date_time_example' # str | Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format (optional) try: # Add phone numbers to a DNC list. api_instance.post_outbound_dnclist_phonenumbers(dnc_list_id, body, expiration_date_time=expiration_date_time) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_dnclist_phonenumbers: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/events Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query Event Logs,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') category = 'category_example' # str | Category (optional) level = 'level_example' # str | Level (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query Event Logs api_response = api_instance.get_outbound_events(page_size=page_size, page_number=page_number, filter_type=filter_type, category=category, level=level, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_events: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/events/{eventId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Dialer Event,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); event_id = 'event_id_example' # str | Event Log ID try: # Get Dialer Event api_response = api_instance.get_outbound_event(event_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_event: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/filespecificationtemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query File Specification Templates,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query File Specification Templates api_response = api_instance.get_outbound_filespecificationtemplates(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_filespecificationtemplates: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/filespecificationtemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create File Specification Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.FileSpecificationTemplate() # FileSpecificationTemplate | FileSpecificationTemplate try: # Create File Specification Template api_response = api_instance.post_outbound_filespecificationtemplates(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_filespecificationtemplates: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/filespecificationtemplates/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete multiple file specification templates.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); id = ['id_example'] # list[str] | File Specification template id(s) to delete try: # Delete multiple file specification templates. api_instance.delete_outbound_filespecificationtemplates_bulk(id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_filespecificationtemplates_bulk: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete File Specification Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); file_specification_template_id = 'file_specification_template_id_example' # str | File Specification Template ID try: # Delete File Specification Template api_instance.delete_outbound_filespecificationtemplate(file_specification_template_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_filespecificationtemplate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get File Specification Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); file_specification_template_id = 'file_specification_template_id_example' # str | File Specification Template ID try: # Get File Specification Template api_response = api_instance.get_outbound_filespecificationtemplate(file_specification_template_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_filespecificationtemplate: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/filespecificationtemplates/{fileSpecificationTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update File Specification Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); file_specification_template_id = 'file_specification_template_id_example' # str | File Specification Template ID body = PureCloudPlatformClientV2.FileSpecificationTemplate() # FileSpecificationTemplate | fileSpecificationTemplate try: # Update File Specification Template api_response = api_instance.put_outbound_filespecificationtemplate(file_specification_template_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_filespecificationtemplate: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/importtemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete multiple import templates.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); id = ['id_example'] # list[str] | import template id(s) to delete try: # Delete multiple import templates. api_instance.delete_outbound_importtemplates(id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_importtemplates: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/importtemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query Import Templates,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); include_import_status = False # bool | Import status (optional) (default to False) page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') contact_list_template_id = 'contact_list_template_id_example' # str | Contact List Template ID (optional) try: # Query Import Templates api_response = api_instance.get_outbound_importtemplates(include_import_status=include_import_status, page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order, contact_list_template_id=contact_list_template_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_importtemplates: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/importtemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create Import Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.ImportTemplate() # ImportTemplate | ImportTemplate try: # Create Import Template api_response = api_instance.post_outbound_importtemplates(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_importtemplates: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/importtemplates/bulk/add Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add multiple import templates,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = [PureCloudPlatformClientV2.ImportTemplate()] # list[ImportTemplate] | import template(s) to add try: # Add multiple import templates api_response = api_instance.post_outbound_importtemplates_bulk_add(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_importtemplates_bulk_add: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/importtemplates/{importTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Import Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); import_template_id = 'import_template_id_example' # str | Import Template ID try: # Delete Import Template api_instance.delete_outbound_importtemplate(import_template_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_importtemplate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/importtemplates/{importTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Import Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); import_template_id = 'import_template_id_example' # str | Import Template ID include_import_status = False # bool | Import status (optional) (default to False) try: # Get Import Template api_response = api_instance.get_outbound_importtemplate(import_template_id, include_import_status=include_import_status) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_importtemplate: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/importtemplates/{importTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Import Template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); import_template_id = 'import_template_id_example' # str | Import Template ID body = PureCloudPlatformClientV2.ImportTemplate() # ImportTemplate | importTemplate try: # Update Import Template api_response = api_instance.put_outbound_importtemplate(import_template_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_importtemplate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/importtemplates/{importTemplateId}/importstatus Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the import status for an import template.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); import_template_id = 'import_template_id_example' # str | importTemplateId list_name_prefix = 'list_name_prefix_example' # str | listNamePrefix (optional) try: # Get the import status for an import template. api_response = api_instance.get_outbound_importtemplate_importstatus(import_template_id, list_name_prefix=list_name_prefix) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_importtemplate_importstatus: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/messagingcampaigns Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query a list of Messaging Campaigns,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''name'' # str | The field to sort by (optional) (default to 'name') sort_order = ''ascending'' # str | The direction to sort (optional) (default to 'ascending') name = 'name_example' # str | Name (optional) contact_list_id = 'contact_list_id_example' # str | Contact List ID (optional) division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) type = 'type_example' # str | Campaign Type (optional) sender_sms_phone_number = 'sender_sms_phone_number_example' # str | Sender SMS Phone Number (optional) id = ['id_example'] # list[str] | A list of messaging campaign ids to bulk fetch (optional) try: # Query a list of Messaging Campaigns api_response = api_instance.get_outbound_messagingcampaigns(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, name=name, contact_list_id=contact_list_id, division_id=division_id, type=type, sender_sms_phone_number=sender_sms_phone_number, id=id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_messagingcampaigns: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/messagingcampaigns Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Messaging Campaign,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.MessagingCampaign() # MessagingCampaign | Messaging Campaign try: # Create a Messaging Campaign api_response = api_instance.post_outbound_messagingcampaigns(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_messagingcampaigns: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/messagingcampaigns/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Query a list of basic Messaging Campaign information objects. This returns a listing of simplified Messaging Campaigns, each consisting of id, name, and division.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''a'' # str | The direction to sort (optional) (default to 'a') name = 'name_example' # str | Name (optional) type = 'type_example' # str | Campaign Type (optional) id = ['id_example'] # list[str] | id (optional) sender_sms_phone_number = 'sender_sms_phone_number_example' # str | Sender SMS Phone Number (optional) try: # Query a list of basic Messaging Campaign information objects api_response = api_instance.get_outbound_messagingcampaigns_divisionviews(page_size=page_size, page_number=page_number, sort_order=sort_order, name=name, type=type, id=id, sender_sms_phone_number=sender_sms_phone_number) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_messagingcampaigns_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/messagingcampaigns/divisionviews/{messagingCampaignId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a basic Messaging Campaign information object. This returns a simplified version of a Messaging Campaign, consisting of id, name, and division.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); messaging_campaign_id = 'messaging_campaign_id_example' # str | The Messaging Campaign ID try: # Get a basic Messaging Campaign information object api_response = api_instance.get_outbound_messagingcampaigns_divisionview(messaging_campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_messagingcampaigns_divisionview: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/messagingcampaigns/progress Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get progress for a list of messaging campaigns,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = ['body_example'] # list[str] | Messaging Campaign IDs try: # Get progress for a list of messaging campaigns api_response = api_instance.post_outbound_messagingcampaigns_progress(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_messagingcampaigns_progress: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an Outbound Messaging Campaign,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); messaging_campaign_id = 'messaging_campaign_id_example' # str | The Messaging Campaign ID try: # Delete an Outbound Messaging Campaign api_response = api_instance.delete_outbound_messagingcampaign(messaging_campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_messagingcampaign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an Outbound Messaging Campaign,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); messaging_campaign_id = 'messaging_campaign_id_example' # str | The Messaging Campaign ID try: # Get an Outbound Messaging Campaign api_response = api_instance.get_outbound_messagingcampaign(messaging_campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_messagingcampaign: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/messagingcampaigns/{messagingCampaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an Outbound Messaging Campaign,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); messaging_campaign_id = 'messaging_campaign_id_example' # str | The Messaging Campaign ID body = PureCloudPlatformClientV2.MessagingCampaign() # MessagingCampaign | MessagingCampaign try: # Update an Outbound Messaging Campaign api_response = api_instance.put_outbound_messagingcampaign(messaging_campaign_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_messagingcampaign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/diagnostics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get messaging campaign diagnostics,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); messaging_campaign_id = 'messaging_campaign_id_example' # str | The Messaging Campaign ID try: # Get messaging campaign diagnostics api_response = api_instance.get_outbound_messagingcampaign_diagnostics(messaging_campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_messagingcampaign_diagnostics: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress Genesys Cloud Python SDK.,Genesys describes this as an API used to: Reset messaging campaign progress and recycle the messaging campaign. Documented permissions are applicable based on campaign 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.OutboundApi(); messaging_campaign_id = 'messaging_campaign_id_example' # str | The Messaging Campaign ID try: # Reset messaging campaign progress and recycle the messaging campaign api_instance.delete_outbound_messagingcampaign_progress(messaging_campaign_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_messagingcampaign_progress: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get messaging campaign's progress,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); messaging_campaign_id = 'messaging_campaign_id_example' # str | The Messaging Campaign ID try: # Get messaging campaign's progress api_response = api_instance.get_outbound_messagingcampaign_progress(messaging_campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_messagingcampaign_progress: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/rulesets Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query a list of Rule Sets.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query a list of Rule Sets. api_response = api_instance.get_outbound_rulesets(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_rulesets: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/rulesets Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Rule Set.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.RuleSet() # RuleSet | RuleSet try: # Create a Rule Set. api_response = api_instance.post_outbound_rulesets(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_rulesets: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/rulesets/{ruleSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Rule Set.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); rule_set_id = 'rule_set_id_example' # str | Rule Set ID try: # Delete a Rule Set. api_instance.delete_outbound_ruleset(rule_set_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_ruleset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/rulesets/{ruleSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Rule Set by 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.OutboundApi(); rule_set_id = 'rule_set_id_example' # str | Rule Set ID try: # Get a Rule Set by ID. api_response = api_instance.get_outbound_ruleset(rule_set_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_ruleset: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/rulesets/{ruleSetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Rule Set.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); rule_set_id = 'rule_set_id_example' # str | Rule Set ID body = PureCloudPlatformClientV2.RuleSet() # RuleSet | RuleSet try: # Update a Rule Set. api_response = api_instance.put_outbound_ruleset(rule_set_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_ruleset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/schedules/campaigns Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for a list of dialer campaign schedules.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); try: # Query for a list of dialer campaign schedules. api_response = api_instance.get_outbound_schedules_campaigns() pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_schedules_campaigns: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/schedules/campaigns/{campaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a dialer campaign schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Delete a dialer campaign schedule. api_instance.delete_outbound_schedules_campaign(campaign_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_schedules_campaign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/schedules/campaigns/{campaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a dialer campaign schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID try: # Get a dialer campaign schedule. api_response = api_instance.get_outbound_schedules_campaign(campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_schedules_campaign: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/schedules/campaigns/{campaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a new campaign schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); campaign_id = 'campaign_id_example' # str | Campaign ID body = PureCloudPlatformClientV2.CampaignSchedule() # CampaignSchedule | CampaignSchedule try: # Update a new campaign schedule. api_response = api_instance.put_outbound_schedules_campaign(campaign_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_schedules_campaign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/schedules/emailcampaigns Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for a list of email campaign schedules.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); try: # Query for a list of email campaign schedules. api_response = api_instance.get_outbound_schedules_emailcampaigns() pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_schedules_emailcampaigns: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an email campaign schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); email_campaign_id = 'email_campaign_id_example' # str | Email Campaign ID try: # Delete an email campaign schedule. api_instance.delete_outbound_schedules_emailcampaign(email_campaign_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_schedules_emailcampaign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an email campaign schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); email_campaign_id = 'email_campaign_id_example' # str | Email Campaign ID try: # Get an email campaign schedule. api_response = api_instance.get_outbound_schedules_emailcampaign(email_campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_schedules_emailcampaign: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/schedules/emailcampaigns/{emailCampaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an email campaign schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); email_campaign_id = 'email_campaign_id_example' # str | Email Campaign ID body = PureCloudPlatformClientV2.EmailCampaignSchedule() # EmailCampaignSchedule | EmailCampaignSchedule try: # Update an email campaign schedule. api_response = api_instance.put_outbound_schedules_emailcampaign(email_campaign_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_schedules_emailcampaign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/schedules/messagingcampaigns Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for a list of messaging campaign schedules.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); try: # Query for a list of messaging campaign schedules. api_response = api_instance.get_outbound_schedules_messagingcampaigns() pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_schedules_messagingcampaigns: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a messaging campaign schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); messaging_campaign_id = 'messaging_campaign_id_example' # str | Messaging Campaign ID try: # Delete a messaging campaign schedule. api_instance.delete_outbound_schedules_messagingcampaign(messaging_campaign_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_schedules_messagingcampaign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a messaging campaign schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); messaging_campaign_id = 'messaging_campaign_id_example' # str | Messaging Campaign ID try: # Get a messaging campaign schedule. api_response = api_instance.get_outbound_schedules_messagingcampaign(messaging_campaign_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_schedules_messagingcampaign: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/schedules/messagingcampaigns/{messagingCampaignId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a new messaging campaign schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); messaging_campaign_id = 'messaging_campaign_id_example' # str | Messaging Campaign ID body = PureCloudPlatformClientV2.MessagingCampaignSchedule() # MessagingCampaignSchedule | MessagingCampaignSchedule try: # Update a new messaging campaign schedule. api_response = api_instance.put_outbound_schedules_messagingcampaign(messaging_campaign_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_schedules_messagingcampaign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/schedules/sequences Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for a list of dialer sequence schedules.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); try: # Query for a list of dialer sequence schedules. api_response = api_instance.get_outbound_schedules_sequences() pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_schedules_sequences: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/schedules/sequences/{sequenceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a dialer sequence schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); sequence_id = 'sequence_id_example' # str | Sequence ID try: # Delete a dialer sequence schedule. api_instance.delete_outbound_schedules_sequence(sequence_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_schedules_sequence: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/schedules/sequences/{sequenceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a dialer sequence schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); sequence_id = 'sequence_id_example' # str | Sequence ID try: # Get a dialer sequence schedule. api_response = api_instance.get_outbound_schedules_sequence(sequence_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_schedules_sequence: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/schedules/sequences/{sequenceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a new sequence schedule.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); sequence_id = 'sequence_id_example' # str | Sequence ID body = PureCloudPlatformClientV2.SequenceSchedule() # SequenceSchedule | SequenceSchedule try: # Update a new sequence schedule. api_response = api_instance.put_outbound_schedules_sequence(sequence_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_schedules_sequence: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/sequences Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query a list of dialer campaign sequences.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); page_size = 25 # int | Page size. The max that will be returned is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) allow_empty_result = False # bool | Whether to return an empty page when there are no results for that page (optional) (default to False) filter_type = ''Prefix'' # str | Filter type (optional) (default to 'Prefix') name = 'name_example' # str | Name (optional) sort_by = 'sort_by_example' # str | Sort by (optional) sort_order = ''a'' # str | Sort order (optional) (default to 'a') try: # Query a list of dialer campaign sequences. api_response = api_instance.get_outbound_sequences(page_size=page_size, page_number=page_number, allow_empty_result=allow_empty_result, filter_type=filter_type, name=name, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_sequences: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/outbound/sequences Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new campaign sequence.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.CampaignSequence() # CampaignSequence | Organization try: # Create a new campaign sequence. api_response = api_instance.post_outbound_sequences(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->post_outbound_sequences: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/outbound/sequences/{sequenceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a dialer campaign sequence.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); sequence_id = 'sequence_id_example' # str | Campaign Sequence ID try: # Delete a dialer campaign sequence. api_instance.delete_outbound_sequence(sequence_id) except ApiException as e: print(""Exception when calling OutboundApi->delete_outbound_sequence: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/sequences/{sequenceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a dialer campaign sequence.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); sequence_id = 'sequence_id_example' # str | Campaign Sequence ID try: # Get a dialer campaign sequence. api_response = api_instance.get_outbound_sequence(sequence_id) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_sequence: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/sequences/{sequenceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a new campaign sequence.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); sequence_id = 'sequence_id_example' # str | Campaign Sequence ID body = PureCloudPlatformClientV2.CampaignSequence() # CampaignSequence | Organization try: # Update a new campaign sequence. api_response = api_instance.put_outbound_sequence(sequence_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_sequence: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the outbound settings for this organization,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); try: # Get the outbound settings for this organization api_response = api_instance.get_outbound_settings() pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/outbound/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the outbound settings for this organization,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.OutboundSettings() # OutboundSettings | outboundSettings try: # Update the outbound settings for this organization api_instance.patch_outbound_settings(body) except ApiException as e: print(""Exception when calling OutboundApi->patch_outbound_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/outbound/wrapupcodemappings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the Dialer wrap up code mapping.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); try: # Get the Dialer wrap up code mapping. api_response = api_instance.get_outbound_wrapupcodemappings() pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->get_outbound_wrapupcodemappings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/outbound/wrapupcodemappings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the Dialer wrap up code mapping.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.OutboundApi(); body = PureCloudPlatformClientV2.WrapUpCodeMapping() # WrapUpCodeMapping | wrapUpCodeMapping try: # Update the Dialer wrap up code mapping. api_response = api_instance.put_outbound_wrapupcodemappings(body) pprint(api_response) except ApiException as e: print(""Exception when calling OutboundApi->put_outbound_wrapupcodemappings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/presence/definitions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Presence Definitions,"```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.PresenceApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) deleted = ''false'' # str | Deleted query can be TRUE, FALSE or ALL (optional) (default to 'false') locale_code = 'locale_code_example' # str | The locale code to fetch for each presence definition. Use ALL to fetch everything. (optional) try: # Get an Organization's list of Presence Definitions. Apps should migrate to use GET /api/v2/presence/definitions instead api_response = api_instance.get_presencedefinitions(page_number=page_number, page_size=page_size, deleted=deleted, locale_code=locale_code) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_presencedefinitions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/presence/definitions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Presence Definition,"```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.PresenceApi(); body = PureCloudPlatformClientV2.OrganizationPresence() # OrganizationPresence | The Presence Definition to create try: # Create a Presence Definition. Apps should migrate to use POST /api/v2/presence/definitions instead api_response = api_instance.post_presencedefinitions(body) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->post_presencedefinitions: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/presence/definitions/{definitionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Presence Definition,"```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.PresenceApi(); presence_id = 'presence_id_example' # str | Organization Presence ID try: # Delete a Presence Definition. Apps should migrate to use DELETE /api/v2/presence/definitions/{definitionId} instead api_instance.delete_presencedefinition(presence_id) except ApiException as e: print(""Exception when calling PresenceApi->delete_presencedefinition: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/presence/definitions/{definitionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Presence Definition,"```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.PresenceApi(); presence_id = 'presence_id_example' # str | Organization Presence ID locale_code = 'locale_code_example' # str | The locale code to fetch for the presence definition. Use ALL to fetch everything. (optional) try: # Get a Presence Definition. Apps should migrate to use GET /api/v2/presence/definitions/{definitionId} instead api_response = api_instance.get_presencedefinition(presence_id, locale_code=locale_code) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_presencedefinition: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/presence/definitions/{definitionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Presence Definition,"```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.PresenceApi(); presence_id = 'presence_id_example' # str | Organization Presence ID body = PureCloudPlatformClientV2.OrganizationPresence() # OrganizationPresence | The OrganizationPresence to update try: # Update a Presence Definition. Apps should migrate to use PUT /api/v2/presence/definitions/{definitionId} instead) api_response = api_instance.put_presencedefinition(presence_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->put_presencedefinition: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/presence/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the presence settings,"```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.PresenceApi(); try: # Get the presence settings api_response = api_instance.get_presence_settings() pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_presence_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/presence/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the presence settings,"```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.PresenceApi(); body = PureCloudPlatformClientV2.PresenceSettings() # PresenceSettings | Presence Settings try: # Update the presence settings api_response = api_instance.put_presence_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->put_presence_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/presence/sources Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Presence Sources,"```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.PresenceApi(); deactivated = ''false'' # str | Deactivated query can be TRUE or FALSE (optional) (default to 'false') try: # Get a list of Presence Sources api_response = api_instance.get_presence_sources(deactivated=deactivated) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_presence_sources: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/presence/sources Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Presence Source,"```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.PresenceApi(); body = PureCloudPlatformClientV2.Source() # Source | The Presence Source to create try: # Create a Presence Source api_response = api_instance.post_presence_sources(body) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->post_presence_sources: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/presence/sources/{sourceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Presence Source,"```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.PresenceApi(); source_id = 'source_id_example' # str | Presence Source ID try: # Delete a Presence Source api_instance.delete_presence_source(source_id) except ApiException as e: print(""Exception when calling PresenceApi->delete_presence_source: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/presence/sources/{sourceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Presence Source,"```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.PresenceApi(); source_id = 'source_id_example' # str | Presence Source ID try: # Get a Presence Source api_response = api_instance.get_presence_source(source_id) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_presence_source: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/presence/sources/{sourceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Presence Source,"```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.PresenceApi(); source_id = 'source_id_example' # str | Presence Source ID body = PureCloudPlatformClientV2.Source() # Source | The updated Presence Source try: # Update a Presence Source api_response = api_instance.put_presence_source(source_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->put_presence_source: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/presence/users/{userId}/primarysource Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a user's Primary Presence Source,"```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.PresenceApi(); user_id = 'user_id_example' # str | user ID try: # Get a user's Primary Presence Source api_response = api_instance.get_presence_user_primarysource(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_presence_user_primarysource: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/presence/users/{userId}/primarysource Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a user's Primary Presence Source,"```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.PresenceApi(); user_id = 'user_id_example' # str | user ID body = PureCloudPlatformClientV2.UserPrimarySource() # UserPrimarySource | Primary Source try: # Update a user's Primary Presence Source api_response = api_instance.put_presence_user_primarysource(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->put_presence_user_primarysource: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/systempresences Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of SystemPresences,"```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.PresenceApi(); try: # Get the list of SystemPresences api_response = api_instance.get_systempresences() pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_systempresences: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/presences/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update bulk user Presences,"```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.PresenceApi(); body = [PureCloudPlatformClientV2.MutableUserPresence()] # list[MutableUserPresence] | List of User presences try: # Update bulk user Presences api_response = api_instance.put_users_presences_bulk(body) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->put_users_presences_bulk: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/presences/purecloud/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source,"```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.PresenceApi(); id = ['id_example'] # list[str] | A comma separated list of user IDs to fetch their presence status in bulk. Limit 50. (optional) try: # Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source api_response = api_instance.get_users_presences_purecloud_bulk(id=id) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_users_presences_purecloud_bulk: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/presences/{sourceId}/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get bulk user presences for a single presence source,"```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.PresenceApi(); source_id = 'source_id_example' # str | The requested presence source ID. id = ['id_example'] # list[str] | A comma separated list of user IDs to fetch their presence status in bulk. Limit 50. (optional) try: # Get bulk user presences for a single presence source api_response = api_instance.get_users_presence_bulk(source_id, id=id) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_users_presence_bulk: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/presences/purecloud Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a user's Genesys Cloud presence. Get the default Genesys Cloud user presence source PURECLOUD,"```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.PresenceApi(); user_id = 'user_id_example' # str | user Id try: # Get a user's Genesys Cloud presence. api_response = api_instance.get_user_presences_purecloud(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_user_presences_purecloud: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/presences/purecloud Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch a Genesys Cloud user's presence. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the PURECLOUD source as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.,"```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.PresenceApi(); user_id = 'user_id_example' # str | user Id body = PureCloudPlatformClientV2.UserPresence() # UserPresence | User presence try: # Patch a Genesys Cloud user's presence api_response = api_instance.patch_user_presences_purecloud(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->patch_user_presences_purecloud: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/presences/{sourceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a user's Presence. Get a user's presence for the specified source that is not specifically listed. Used to support custom presence sources. This endpoint does not support registered presence sources.,"```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.PresenceApi(); user_id = 'user_id_example' # str | user Id source_id = 'source_id_example' # str | Presence source ID try: # Get a user's Presence api_response = api_instance.get_user_presence(user_id, source_id) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->get_user_presence: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/presences/{sourceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch a user's Presence. Patch a user's presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.,"```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.PresenceApi(); user_id = 'user_id_example' # str | user Id source_id = 'source_id_example' # str | Presence source ID body = PureCloudPlatformClientV2.UserPresence() # UserPresence | User presence try: # Patch a user's Presence api_response = api_instance.patch_user_presence(user_id, source_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling PresenceApi->patch_user_presence: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/processautomation/triggers Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Retrieves all triggers, optionally filtered by query 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.ProcessAutomationApi(); before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) topic_name = 'topic_name_example' # str | Topic name(s). Separated by commas (optional) enabled = True # bool | Boolean indicating desired enabled state of triggers (optional) has_delay_by = True # bool | Boolean to filter based on delayBySeconds being set in triggers. Default returns all, true returns only those with delayBySeconds set, false returns those without delayBySeconds set. (optional) try: # Retrieves all triggers, optionally filtered by query parameters. api_response = api_instance.get_processautomation_triggers(before=before, after=after, page_size=page_size, topic_name=topic_name, enabled=enabled, has_delay_by=has_delay_by) pprint(api_response) except ApiException as e: print(""Exception when calling ProcessAutomationApi->get_processautomation_triggers: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/processautomation/triggers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Trigger,"```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.ProcessAutomationApi(); body = PureCloudPlatformClientV2.CreateTriggerRequest() # CreateTriggerRequest | Input used to create a Trigger. try: # Create a Trigger api_response = api_instance.post_processautomation_triggers(body) pprint(api_response) except ApiException as e: print(""Exception when calling ProcessAutomationApi->post_processautomation_triggers: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/processautomation/triggers/topics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get topics available for organization,"```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.ProcessAutomationApi(); before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) try: # Get topics available for organization api_response = api_instance.get_processautomation_triggers_topics(before=before, after=after, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling ProcessAutomationApi->get_processautomation_triggers_topics: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/processautomation/triggers/topics/{topicName}/test Genesys Cloud Python SDK.,Genesys describes this as an API used to: Test the matching of all organization Triggers on given topic using provided event body,"```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.ProcessAutomationApi(); topic_name = 'topic_name_example' # str | topicName body = 'body_example' # str | eventBody (optional) try: # Test the matching of all organization Triggers on given topic using provided event body api_response = api_instance.post_processautomation_triggers_topic_test(topic_name, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ProcessAutomationApi->post_processautomation_triggers_topic_test: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/processautomation/triggers/{triggerId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Trigger,"```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.ProcessAutomationApi(); trigger_id = 'trigger_id_example' # str | triggerId try: # Delete a Trigger api_instance.delete_processautomation_trigger(trigger_id) except ApiException as e: print(""Exception when calling ProcessAutomationApi->delete_processautomation_trigger: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/processautomation/triggers/{triggerId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a single Trigger 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.ProcessAutomationApi(); trigger_id = 'trigger_id_example' # str | triggerId try: # Retrieve a single Trigger matching id api_response = api_instance.get_processautomation_trigger(trigger_id) pprint(api_response) except ApiException as e: print(""Exception when calling ProcessAutomationApi->get_processautomation_trigger: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/processautomation/triggers/{triggerId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Trigger,"```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.ProcessAutomationApi(); trigger_id = 'trigger_id_example' # str | triggerId body = PureCloudPlatformClientV2.UpdateTriggerRequest() # UpdateTriggerRequest | Input to update Trigger. (topicName cannot be updated, a new trigger must be created to use a new topicName) try: # Update a Trigger api_response = api_instance.put_processautomation_trigger(trigger_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ProcessAutomationApi->put_processautomation_trigger: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/processautomation/triggers/{triggerId}/test Genesys Cloud Python SDK.,Genesys describes this as an API used to: Test the matching of a Trigger based on provided event body,"```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.ProcessAutomationApi(); trigger_id = 'trigger_id_example' # str | triggerId body = 'body_example' # str | eventBody (optional) try: # Test the matching of a Trigger based on provided event body api_response = api_instance.post_processautomation_trigger_test(trigger_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ProcessAutomationApi->post_processautomation_trigger_test: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/evaluations/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for evaluation 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.QualityApi(); body = PureCloudPlatformClientV2.EvaluationAggregationQuery() # EvaluationAggregationQuery | query try: # Query for evaluation aggregates api_response = api_instance.post_analytics_evaluations_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_analytics_evaluations_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/surveys/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for survey 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.QualityApi(); body = PureCloudPlatformClientV2.SurveyAggregationQuery() # SurveyAggregationQuery | query try: # Query for survey aggregates api_response = api_instance.post_analytics_surveys_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_analytics_surveys_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/agents/activity Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Gets a list of Agent Activities. Each item on the list shows one agent's evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users","```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.QualityApi(); 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) start_time = '2013-10-20T19:20:30+01:00' # datetime | Start time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional) end_time = '2013-10-20T19:20:30+01:00' # datetime | End time of agent activity based on assigned date. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional) agent_user_id = ['agent_user_id_example'] # list[str] | user id of agent requested (optional) evaluator_user_id = 'evaluator_user_id_example' # str | user id of the evaluator (optional) name = 'name_example' # str | name (optional) group = 'group_example' # str | group id (optional) agent_team_id = 'agent_team_id_example' # str | team id of agents requested (optional) form_context_id = 'form_context_id_example' # str | shared id between form versions (optional) try: # Gets a list of Agent Activities api_response = api_instance.get_quality_agents_activity(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, start_time=start_time, end_time=end_time, agent_user_id=agent_user_id, evaluator_user_id=evaluator_user_id, name=name, group=group, agent_team_id=agent_team_id, form_context_id=form_context_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_agents_activity: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/calibrations Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the list of calibrations. NOTE: The count for total and pageCount might not be accurate when querying for a large number of calibrations. nextUri, if present, will indicate that there are more calibrations to fetch.","```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.QualityApi(); calibrator_id = 'calibrator_id_example' # str | user id of calibrator 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) conversation_id = 'conversation_id_example' # str | conversation id (optional) start_time = '2013-10-20T19:20:30+01:00' # datetime | Beginning of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional) end_time = '2013-10-20T19:20:30+01:00' # datetime | end of the calibration query. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional) try: # Get the list of calibrations api_response = api_instance.get_quality_calibrations(calibrator_id, page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, conversation_id=conversation_id, start_time=start_time, end_time=end_time) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_calibrations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/quality/calibrations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a calibration,"```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.QualityApi(); body = PureCloudPlatformClientV2.CalibrationCreate() # CalibrationCreate | calibration expand = 'expand_example' # str | calibratorId (optional) try: # Create a calibration api_response = api_instance.post_quality_calibrations(body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_quality_calibrations: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/quality/calibrations/{calibrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a calibration by 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.QualityApi(); calibration_id = 'calibration_id_example' # str | Calibration ID calibrator_id = 'calibrator_id_example' # str | calibratorId try: # Delete a calibration by id. api_response = api_instance.delete_quality_calibration(calibration_id, calibrator_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->delete_quality_calibration: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/calibrations/{calibrationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a calibration by id. Requires either calibrator id or conversation 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.QualityApi(); calibration_id = 'calibration_id_example' # str | Calibration ID calibrator_id = 'calibrator_id_example' # str | calibratorId (optional) conversation_id = 'conversation_id_example' # str | conversationId (optional) try: # Get a calibration by id. Requires either calibrator id or conversation id api_response = api_instance.get_quality_calibration(calibration_id, calibrator_id=calibrator_id, conversation_id=conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_calibration: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/quality/calibrations/{calibrationId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex","```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.QualityApi(); calibration_id = 'calibration_id_example' # str | Calibration ID body = PureCloudPlatformClientV2.Calibration() # Calibration | Calibration try: # Update a calibration to the specified calibration via PUT. Editable fields include: evaluators, expertEvaluator, and scoringIndex api_response = api_instance.put_quality_calibration(calibration_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->put_quality_calibration: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/quality/conversations/audits/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create audit query execution,"```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.QualityApi(); body = PureCloudPlatformClientV2.QMAuditQueryRequest() # QMAuditQueryRequest | query try: # Create audit query execution api_response = api_instance.post_quality_conversations_audits_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_quality_conversations_audits_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/conversations/audits/query/{transactionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get status of audit query execution,"```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.QualityApi(); transaction_id = 'transaction_id_example' # str | Transaction ID try: # Get status of audit query execution api_response = api_instance.get_quality_conversations_audits_query_transaction_id(transaction_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_conversations_audits_query_transaction_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/conversations/audits/query/{transactionId}/results Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get results of audit query,"```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.QualityApi(); transaction_id = 'transaction_id_example' # str | Transaction ID cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional) page_size = 25 # int | Page size (optional) (default to 25) expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) try: # Get results of audit query api_response = api_instance.get_quality_conversations_audits_query_transaction_id_results(transaction_id, cursor=cursor, page_size=page_size, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_conversations_audits_query_transaction_id_results: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/quality/conversations/{conversationId}/evaluations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an evaluation,"```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.QualityApi(); conversation_id = 'conversation_id_example' # str | conversationId body = PureCloudPlatformClientV2.EvaluationCreateBody() # EvaluationCreateBody | evaluation expand = 'expand_example' # str | evaluatorId (optional) try: # Create an evaluation api_response = api_instance.post_quality_conversation_evaluations(conversation_id, body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_quality_conversation_evaluations: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an evaluation,"```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.QualityApi(); conversation_id = 'conversation_id_example' # str | conversationId evaluation_id = 'evaluation_id_example' # str | evaluationId expand = 'expand_example' # str | evaluatorId, evaluationForm (optional) try: # Delete an evaluation api_response = api_instance.delete_quality_conversation_evaluation(conversation_id, evaluation_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->delete_quality_conversation_evaluation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an evaluation,"```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.QualityApi(); conversation_id = 'conversation_id_example' # str | conversationId evaluation_id = 'evaluation_id_example' # str | evaluationId expand = 'expand_example' # str | agent, assignee, evaluator, evaluationForm (optional) try: # Get an evaluation api_response = api_instance.get_quality_conversation_evaluation(conversation_id, evaluation_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_conversation_evaluation: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/quality/conversations/{conversationId}/evaluations/{evaluationId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Update an evaluation. The quality:evaluation:edit permission allows modification of most fields, while the quality:evaluation:editScore permission allows an evaluator to change just the question scores, and the quality:evaluation:editAgentSignoff permission allows an agent to change the agent comments and sign off on the evaluation. authorizedActions is not returned for this PUT request, and is only returned for GET requests to this endpoint.","```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.QualityApi(); conversation_id = 'conversation_id_example' # str | conversationId evaluation_id = 'evaluation_id_example' # str | evaluationId body = PureCloudPlatformClientV2.Evaluation() # Evaluation | evaluation expand = 'expand_example' # str | evaluatorId, evaluationForm, assignee, evaluator (optional) try: # Update an evaluation api_response = api_instance.put_quality_conversation_evaluation(conversation_id, evaluation_id, body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->put_quality_conversation_evaluation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/conversations/{conversationId}/surveys Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the surveys for a conversation,"```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.QualityApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get the surveys for a conversation api_response = api_instance.get_quality_conversation_surveys(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_conversation_surveys: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/quality/evaluations/aggregates/query/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for evaluation aggregates for the current 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.QualityApi(); body = PureCloudPlatformClientV2.EvaluationAggregationQueryMe() # EvaluationAggregationQueryMe | query try: # Query for evaluation aggregates for the current user api_response = api_instance.post_quality_evaluations_aggregates_query_me(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_quality_evaluations_aggregates_query_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/evaluations/query Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Queries Evaluations and returns a paged list. Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to 'Never Release' are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given property's value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the 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.QualityApi(); 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) expand = ['expand_example'] # list[str] | variable name requested by expand list (optional) previous_page = 'previous_page_example' # str | Previous page token (optional) conversation_id = 'conversation_id_example' # str | conversationId specified (optional) agent_user_id = 'agent_user_id_example' # str | user id of the agent (optional) agent_team_id = 'agent_team_id_example' # str | team id of the agent (optional) evaluator_user_id = 'evaluator_user_id_example' # str | evaluator user id (optional) assignee_user_id = 'assignee_user_id_example' # str | assignee user id (optional) queue_id = 'queue_id_example' # str | queue id (optional) start_time = 'start_time_example' # str | start time of the evaluation query (optional) end_time = 'end_time_example' # str | end time of the evaluation query (optional) form_context_id = 'form_context_id_example' # str | shared id between form versions (optional) evaluation_state = ['evaluation_state_example'] # list[str] | (optional) is_released = True # bool | the evaluation has been released (optional) agent_has_read = True # bool | agent has the evaluation (optional) expand_answer_total_scores = True # bool | get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request. (optional) maximum = 56 # int | the maximum number of results to return (optional) sort_order = 'sort_order_example' # str | NOTE: Does not work when conversationId is supplied. (optional) try: # Queries Evaluations and returns a paged list api_response = api_instance.get_quality_evaluations_query(page_size=page_size, page_number=page_number, expand=expand, previous_page=previous_page, conversation_id=conversation_id, agent_user_id=agent_user_id, agent_team_id=agent_team_id, evaluator_user_id=evaluator_user_id, assignee_user_id=assignee_user_id, queue_id=queue_id, start_time=start_time, end_time=end_time, form_context_id=form_context_id, evaluation_state=evaluation_state, is_released=is_released, agent_has_read=agent_has_read, expand_answer_total_scores=expand_answer_total_scores, maximum=maximum, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_evaluations_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/quality/evaluations/scoring Genesys Cloud Python SDK.,Genesys describes this as an API used to: Score evaluation,"```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.QualityApi(); body = PureCloudPlatformClientV2.EvaluationFormAndScoringSet() # EvaluationFormAndScoringSet | evaluationAndScoringSet try: # Score evaluation api_response = api_instance.post_quality_evaluations_scoring(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_quality_evaluations_scoring: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/evaluators/activity Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an evaluator activity,"```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.QualityApi(); 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) start_time = '2013-10-20T19:20:30+01:00' # datetime | The start time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional) end_time = '2013-10-20T19:20:30+01:00' # datetime | The end time specified. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z (optional) name = 'name_example' # str | Evaluator name (optional) permission = ['permission_example'] # list[str] | permission strings (optional) group = 'group_example' # str | group id (optional) agent_team_id = 'agent_team_id_example' # str | team id of agents to be considered (optional) try: # Get an evaluator activity api_response = api_instance.get_quality_evaluators_activity(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, start_time=start_time, end_time=end_time, name=name, permission=permission, group=group, agent_team_id=agent_team_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_evaluators_activity: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/forms/evaluations Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the list of evaluation forms. By default, ""published"" field is always returned as false for all evaluation forms. If you set ""expand=publishHistory"", then you will be able to get published versions for each corresponding evaluation form. In addition, ""questionGroups"", the detailed information about evaluation form, is not returned. We will enhance this field in a future release.","```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.QualityApi(); 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) next_page = 'next_page_example' # str | next page token (optional) previous_page = 'previous_page_example' # str | Previous page token (optional) expand = 'expand_example' # str | If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions (optional) name = 'name_example' # str | Name (optional) sort_order = 'sort_order_example' # str | Order to sort results, either asc or desc (optional) try: # Get the list of evaluation forms api_response = api_instance.get_quality_forms_evaluations(page_size=page_size, page_number=page_number, sort_by=sort_by, next_page=next_page, previous_page=previous_page, expand=expand, name=name, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_forms_evaluations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/quality/forms/evaluations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an evaluation form.,"```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.QualityApi(); body = PureCloudPlatformClientV2.EvaluationForm() # EvaluationForm | Evaluation form try: # Create an evaluation form. api_response = api_instance.post_quality_forms_evaluations(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_quality_forms_evaluations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/forms/evaluations/bulk/contexts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a list of the latest published evaluation form versions by context ids,"```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.QualityApi(); context_id = ['context_id_example'] # list[str] | A comma-delimited list of valid evaluation form context ids try: # Retrieve a list of the latest published evaluation form versions by context ids api_response = api_instance.get_quality_forms_evaluations_bulk_contexts(context_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_forms_evaluations_bulk_contexts: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/quality/forms/evaluations/{formId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an evaluation form.,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID try: # Delete an evaluation form. api_instance.delete_quality_forms_evaluation(form_id) except ApiException as e: print(""Exception when calling QualityApi->delete_quality_forms_evaluation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/forms/evaluations/{formId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an evaluation form,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID try: # Get an evaluation form api_response = api_instance.get_quality_forms_evaluation(form_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_forms_evaluation: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/quality/forms/evaluations/{formId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an evaluation form.,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID body = PureCloudPlatformClientV2.EvaluationForm() # EvaluationForm | Evaluation form try: # Update an evaluation form. api_response = api_instance.put_quality_forms_evaluation(form_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->put_quality_forms_evaluation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/forms/evaluations/{formId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets all the revisions for a specific evaluation.,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') try: # Gets all the revisions for a specific evaluation. api_response = api_instance.get_quality_forms_evaluation_versions(form_id, page_size=page_size, page_number=page_number, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_forms_evaluation_versions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/forms/surveys Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the list of survey forms. If you set ""expand=publishHistory"", then you will be able to get published versions for each corresponding survey form.","```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.QualityApi(); 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) next_page = 'next_page_example' # str | next page token (optional) previous_page = 'previous_page_example' # str | Previous page token (optional) expand = 'expand_example' # str | If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions (optional) name = 'name_example' # str | Name (optional) sort_order = 'sort_order_example' # str | Order to sort results, either asc or desc (optional) try: # Get the list of survey forms. If you set \""expand=publishHistory\"", then you will be able to get published versions for each corresponding survey form. api_response = api_instance.get_quality_forms_surveys(page_size=page_size, page_number=page_number, sort_by=sort_by, next_page=next_page, previous_page=previous_page, expand=expand, name=name, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_forms_surveys: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/quality/forms/surveys Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a survey form.,"```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.QualityApi(); body = PureCloudPlatformClientV2.SurveyForm() # SurveyForm | Survey form try: # Create a survey form. api_response = api_instance.post_quality_forms_surveys(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_quality_forms_surveys: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/forms/surveys/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a list of survey forms by their ids,"```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.QualityApi(); id = ['id_example'] # list[str] | A comma-delimited list of valid survey form ids try: # Retrieve a list of survey forms by their ids api_response = api_instance.get_quality_forms_surveys_bulk(id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_forms_surveys_bulk: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/forms/surveys/bulk/contexts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a list of the latest form versions by context ids,"```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.QualityApi(); context_id = ['context_id_example'] # list[str] | A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100. published = True # bool | If true, the latest published version will be included. If false, only the unpublished version will be included. (optional) (default to True) try: # Retrieve a list of the latest form versions by context ids api_response = api_instance.get_quality_forms_surveys_bulk_contexts(context_id, published=published) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_forms_surveys_bulk_contexts: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/quality/forms/surveys/{formId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a survey form.,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID try: # Delete a survey form. api_instance.delete_quality_forms_survey(form_id) except ApiException as e: print(""Exception when calling QualityApi->delete_quality_forms_survey: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/forms/surveys/{formId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a survey form,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID try: # Get a survey form api_response = api_instance.get_quality_forms_survey(form_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_forms_survey: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/quality/forms/surveys/{formId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form.,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID body = PureCloudPlatformClientV2.SurveyForm() # SurveyForm | Survey form try: # Disable a particular version of a survey form and invalidates any invitations that have already been sent to customers using this version of the form. api_response = api_instance.patch_quality_forms_survey(form_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->patch_quality_forms_survey: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/quality/forms/surveys/{formId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a survey form.,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID body = PureCloudPlatformClientV2.SurveyForm() # SurveyForm | Survey form try: # Update a survey form. api_response = api_instance.put_quality_forms_survey(form_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->put_quality_forms_survey: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/forms/surveys/{formId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets all the revisions for a specific survey.,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Gets all the revisions for a specific survey. api_response = api_instance.get_quality_forms_survey_versions(form_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_forms_survey_versions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/publishedforms/evaluations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the published evaluation forms.,"```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.QualityApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) name = 'name_example' # str | Name (optional) only_latest_per_context = False # bool | onlyLatestPerContext (optional) (default to False) try: # Get the published evaluation forms. api_response = api_instance.get_quality_publishedforms_evaluations(page_size=page_size, page_number=page_number, name=name, only_latest_per_context=only_latest_per_context) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_publishedforms_evaluations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/quality/publishedforms/evaluations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Publish an evaluation form.,"```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.QualityApi(); body = PureCloudPlatformClientV2.PublishForm() # PublishForm | Publish request containing id of form to publish try: # Publish an evaluation form. api_response = api_instance.post_quality_publishedforms_evaluations(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_quality_publishedforms_evaluations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/publishedforms/evaluations/{formId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the most recent published version of an evaluation form.,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID try: # Get the most recent published version of an evaluation form. api_response = api_instance.get_quality_publishedforms_evaluation(form_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_publishedforms_evaluation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/publishedforms/surveys Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the published survey forms.,"```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.QualityApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) name = 'name_example' # str | Name (optional) only_latest_enabled_per_context = False # bool | onlyLatestEnabledPerContext (optional) (default to False) try: # Get the published survey forms. api_response = api_instance.get_quality_publishedforms_surveys(page_size=page_size, page_number=page_number, name=name, only_latest_enabled_per_context=only_latest_enabled_per_context) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_publishedforms_surveys: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/quality/publishedforms/surveys Genesys Cloud Python SDK.,Genesys describes this as an API used to: Publish a survey form.,"```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.QualityApi(); body = PureCloudPlatformClientV2.PublishForm() # PublishForm | Survey form try: # Publish a survey form. api_response = api_instance.post_quality_publishedforms_surveys(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_quality_publishedforms_surveys: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/publishedforms/surveys/{formId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the most recent published version of a survey form.,"```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.QualityApi(); form_id = 'form_id_example' # str | Form ID try: # Get the most recent published version of a survey form. api_response = api_instance.get_quality_publishedforms_survey(form_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_publishedforms_survey: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/surveys/scorable Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a survey as an end-customer, for the purposes of scoring it.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.QualityApi(); customer_survey_url = 'customer_survey_url_example' # str | customerSurveyUrl try: # Get a survey as an end-customer, for the purposes of scoring it. api_response = api_instance.get_quality_surveys_scorable(customer_survey_url) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_surveys_scorable: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/quality/surveys/scorable Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Update a survey as an end-customer, for the purposes of scoring it.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.QualityApi(); customer_survey_url = 'customer_survey_url_example' # str | customerSurveyUrl body = PureCloudPlatformClientV2.ScorableSurvey() # ScorableSurvey | survey try: # Update a survey as an end-customer, for the purposes of scoring it. api_response = api_instance.put_quality_surveys_scorable(customer_survey_url, body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->put_quality_surveys_scorable: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/quality/surveys/scoring Genesys Cloud Python SDK.,Genesys describes this as an API used to: Score survey,"```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.QualityApi(); body = PureCloudPlatformClientV2.SurveyFormAndScoringSet() # SurveyFormAndScoringSet | surveyAndScoringSet try: # Score survey api_response = api_instance.post_quality_surveys_scoring(body) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->post_quality_surveys_scoring: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/quality/surveys/{surveyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a survey for a conversation,"```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.QualityApi(); survey_id = 'survey_id_example' # str | surveyId try: # Get a survey for a conversation api_response = api_instance.get_quality_survey(survey_id) pprint(api_response) except ApiException as e: print(""Exception when calling QualityApi->get_quality_survey: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/recordingmetadata Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing.,"```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.RecordingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID try: # Get recording metadata for a conversation. Does not return playable media. Annotations won't be included in the response if either recording:recording:view or recording:annotation:view permission is missing. api_response = api_instance.get_conversation_recordingmetadata(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_conversation_recordingmetadata: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/recordingmetadata/{recordingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get metadata for a specific recording. Does not return playable media.,"```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.RecordingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID recording_id = 'recording_id_example' # str | Recording ID try: # Get metadata for a specific recording. Does not return playable media. api_response = api_instance.get_conversation_recordingmetadata_recording_id(conversation_id, recording_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_conversation_recordingmetadata_recording_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/recordings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all of a Conversation's Recordings.,"```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.RecordingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID max_wait_ms = 5000 # int | The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (optional) (default to 5000) format_id = ''WEBM'' # str | The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (optional) (default to 'WEBM') media_formats = ['media_formats_example'] # list[str] | All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3. (optional) try: # Get all of a Conversation's Recordings. api_response = api_instance.get_conversation_recordings(conversation_id, max_wait_ms=max_wait_ms, format_id=format_id, media_formats=media_formats) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_conversation_recordings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/recordings/{recordingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a specific recording.,"```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.RecordingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID recording_id = 'recording_id_example' # str | Recording ID format_id = ''WEBM'' # str | The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE (optional) (default to 'WEBM') email_format_id = ''EML'' # str | The desired media format when downloading an email recording. Valid values:EML,NONE (optional) (default to 'EML') chat_format_id = ''ZIP'' # str | The desired media format when downloading a chat recording. Valid values:ZIP,NONE (optional) (default to 'ZIP') message_format_id = ''ZIP'' # str | The desired media format when downloading a message recording. Valid values:ZIP,NONE (optional) (default to 'ZIP') download = False # bool | requesting a download format of the recording. Valid values:true,false (optional) (default to False) file_name = 'file_name_example' # str | the name of the downloaded fileName (optional) locale = 'locale_example' # str | The locale for the requested file when downloading, as an ISO 639-1 code (optional) media_formats = ['media_formats_example'] # list[str] | All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3 (optional) try: # Gets a specific recording. api_response = api_instance.get_conversation_recording(conversation_id, recording_id, format_id=format_id, email_format_id=email_format_id, chat_format_id=chat_format_id, message_format_id=message_format_id, download=download, file_name=file_name, locale=locale, media_formats=media_formats) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_conversation_recording: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/{conversationId}/recordings/{recordingId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Updates the retention records on a recording. Currently supports updating and removing both archive and delete dates for eligible recordings. A request to change the archival date of an archived recording will result in a restoration of the recording until the new date set. The recording:recording:view permission is required for the recording, as well as either the recording:recording:editRetention or recording:screenRecording:editRetention permissions depending on the type of recording.","```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.RecordingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID recording_id = 'recording_id_example' # str | Recording ID body = PureCloudPlatformClientV2.Recording() # Recording | recording clear_export = True # bool | Whether to clear the pending export for the recording (optional) try: # Updates the retention records on a recording. api_response = api_instance.put_conversation_recording(conversation_id, recording_id, body, clear_export=clear_export) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->put_conversation_recording: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get annotations for recording,"```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.RecordingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID recording_id = 'recording_id_example' # str | Recording ID try: # Get annotations for recording api_response = api_instance.get_conversation_recording_annotations(conversation_id, recording_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_conversation_recording_annotations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create annotation,"```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.RecordingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID recording_id = 'recording_id_example' # str | Recording ID body = PureCloudPlatformClientV2.Annotation() # Annotation | annotation try: # Create annotation api_response = api_instance.post_conversation_recording_annotations(conversation_id, recording_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_conversation_recording_annotations: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete annotation,"```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.RecordingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID recording_id = 'recording_id_example' # str | Recording ID annotation_id = 'annotation_id_example' # str | Annotation ID try: # Delete annotation api_instance.delete_conversation_recording_annotation(conversation_id, recording_id, annotation_id) except ApiException as e: print(""Exception when calling RecordingApi->delete_conversation_recording_annotation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get annotation,"```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.RecordingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID recording_id = 'recording_id_example' # str | Recording ID annotation_id = 'annotation_id_example' # str | Annotation ID try: # Get annotation api_response = api_instance.get_conversation_recording_annotation(conversation_id, recording_id, annotation_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_conversation_recording_annotation: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/conversations/{conversationId}/recordings/{recordingId}/annotations/{annotationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update annotation,"```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.RecordingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID recording_id = 'recording_id_example' # str | Recording ID annotation_id = 'annotation_id_example' # str | Annotation ID body = PureCloudPlatformClientV2.Annotation() # Annotation | annotation try: # Update annotation api_response = api_instance.put_conversation_recording_annotation(conversation_id, recording_id, annotation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->put_conversation_recording_annotation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orphanrecordings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets all orphan recordings,"```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.RecordingApi(); 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) has_conversation = False # bool | Filter resulting orphans by whether the conversation is known. False returns all orphans for the organization. (optional) (default to False) media = 'media_example' # str | Filter resulting orphans based on their media type (optional) try: # Gets all orphan recordings api_response = api_instance.get_orphanrecordings(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, has_conversation=has_conversation, media=media) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_orphanrecordings: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/orphanrecordings/{orphanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a single orphan recording,"```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.RecordingApi(); orphan_id = 'orphan_id_example' # str | Orphan ID try: # Deletes a single orphan recording api_response = api_instance.delete_orphanrecording(orphan_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->delete_orphanrecording: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orphanrecordings/{orphanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a single orphan recording,"```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.RecordingApi(); orphan_id = 'orphan_id_example' # str | Orphan ID try: # Gets a single orphan recording api_response = api_instance.get_orphanrecording(orphan_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_orphanrecording: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/orphanrecordings/{orphanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates an orphan recording to a regular recording with retention values. If this operation is successful the orphan will no longer exist. It will be replaced by the resulting recording in the response. This replacement recording is accessible by the normal Recording api.,"```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.RecordingApi(); orphan_id = 'orphan_id_example' # str | Orphan ID body = PureCloudPlatformClientV2.OrphanUpdateRequest() # OrphanUpdateRequest | (optional) try: # Updates an orphan recording to a regular recording with retention values api_response = api_instance.put_orphanrecording(orphan_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->put_orphanrecording: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/orphanrecordings/{orphanId}/media Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets the media of a single orphan recording. A 202 response means the orphaned media is currently transcoding and will be available shortly.A 200 response denotes the transcoded orphan media is available now and is contained in the response body.,"```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.RecordingApi(); orphan_id = 'orphan_id_example' # str | Orphan ID format_id = ''WEBM'' # str | The desired media format. (optional) (default to 'WEBM') email_format_id = ''EML'' # str | The desired media format when downloading an email recording. (optional) (default to 'EML') chat_format_id = ''ZIP'' # str | The desired media format when downloading a chat recording. (optional) (default to 'ZIP') message_format_id = ''ZIP'' # str | The desired media format when downloading a message recording. (optional) (default to 'ZIP') download = False # bool | requesting a download format of the recording (optional) (default to False) file_name = 'file_name_example' # str | the name of the downloaded fileName (optional) locale = 'locale_example' # str | The locale for the requested file when downloading, as an ISO 639-1 code (optional) media_formats = ['media_formats_example'] # list[str] | All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3 (optional) try: # Gets the media of a single orphan recording api_response = api_instance.get_orphanrecording_media(orphan_id, format_id=format_id, email_format_id=email_format_id, chat_format_id=chat_format_id, message_format_id=message_format_id, download=download, file_name=file_name, locale=locale, media_formats=media_formats) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_orphanrecording_media: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recording/batchrequests Genesys Cloud Python SDK.,Genesys describes this as an API used to: Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk 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.RecordingApi(); body = PureCloudPlatformClientV2.BatchDownloadJobSubmission() # BatchDownloadJobSubmission | Job submission criteria try: # Submit a batch download request for recordings. Recordings in response will be in their original format/codec - configured in the Trunk configuration. api_response = api_instance.post_recording_batchrequests(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_recording_batchrequests: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/batchrequests/{jobId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple 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.RecordingApi(); job_id = 'job_id_example' # str | jobId try: # Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple results. api_response = api_instance.get_recording_batchrequest(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_batchrequest: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/recording/crossplatform/mediaretentionpolicies Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Delete media retention policies. Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the 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.RecordingApi(); ids = 'ids_example' # str | try: # Delete media retention policies api_instance.delete_recording_crossplatform_mediaretentionpolicies(ids) except ApiException as e: print(""Exception when calling RecordingApi->delete_recording_crossplatform_mediaretentionpolicies: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/crossplatform/mediaretentionpolicies Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Gets media retention policy list with query options to filter on name and enabled. for a less verbose response, add summary=true to this endpoint","```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.RecordingApi(); 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) name = 'name_example' # str | the policy name - used for filtering results in searches. (optional) enabled = True # bool | checks to see if policy is enabled - use enabled = true or enabled = false (optional) summary = False # bool | provides a less verbose response of policy lists. (optional) (default to False) has_errors = True # bool | provides a way to fetch all policies with errors or policies that do not have errors (optional) delete_days_threshold = 56 # int | provides a way to fetch all policies with any actions having deleteDays exceeding the provided value (optional) try: # Gets media retention policy list with query options to filter on name and enabled. api_response = api_instance.get_recording_crossplatform_mediaretentionpolicies(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, name=name, enabled=enabled, summary=summary, has_errors=has_errors, delete_days_threshold=delete_days_threshold) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_crossplatform_mediaretentionpolicies: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recording/crossplatform/mediaretentionpolicies Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create media retention policy. Policy does not work retroactively,"```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.RecordingApi(); body = PureCloudPlatformClientV2.CrossPlatformPolicyCreate() # CrossPlatformPolicyCreate | Policy try: # Create media retention policy api_response = api_instance.post_recording_crossplatform_mediaretentionpolicies(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_recording_crossplatform_mediaretentionpolicies: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a media retention policy,"```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.RecordingApi(); policy_id = 'policy_id_example' # str | Policy ID try: # Delete a media retention policy api_instance.delete_recording_crossplatform_mediaretentionpolicy(policy_id) except ApiException as e: print(""Exception when calling RecordingApi->delete_recording_crossplatform_mediaretentionpolicy: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a media retention policy,"```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.RecordingApi(); policy_id = 'policy_id_example' # str | Policy ID try: # Get a media retention policy api_response = api_instance.get_recording_crossplatform_mediaretentionpolicy(policy_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_crossplatform_mediaretentionpolicy: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch a media retention policy,"```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.RecordingApi(); policy_id = 'policy_id_example' # str | Policy ID body = PureCloudPlatformClientV2.CrossPlatformPolicyUpdate() # CrossPlatformPolicyUpdate | Policy try: # Patch a media retention policy api_response = api_instance.patch_recording_crossplatform_mediaretentionpolicy(policy_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->patch_recording_crossplatform_mediaretentionpolicy: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/recording/crossplatform/mediaretentionpolicies/{policyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a media retention policy. Policy does not work retroactively,"```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.RecordingApi(); policy_id = 'policy_id_example' # str | Policy ID body = PureCloudPlatformClientV2.CrossPlatformPolicy() # CrossPlatformPolicy | Policy try: # Update a media retention policy api_response = api_instance.put_recording_crossplatform_mediaretentionpolicy(policy_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->put_recording_crossplatform_mediaretentionpolicy: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the status of all jobs within the user's organization,"```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.RecordingApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''userId'' # str | Sort by (optional) (default to 'userId') state = 'state_example' # str | Filter by state (optional) show_only_my_jobs = True # bool | Show only my jobs (optional) job_type = 'job_type_example' # str | Job Type (Can be left empty for both) (optional) include_total = True # bool | If false, cursor will be used to locate the page instead of pageNumber. (optional) cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional) try: # Get the status of all jobs within the user's organization api_response = api_instance.get_recording_jobs(page_size=page_size, page_number=page_number, sort_by=sort_by, state=state, show_only_my_jobs=show_only_my_jobs, job_type=job_type, include_total=include_total, cursor=cursor) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_jobs: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recording/jobs Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Create a recording bulk job. Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state. Furthermore, the recording:recording:viewSensitiveData permission is required to access recordings with PCI DSS and/or PII data when redaction is enabled for their organization. If the requester does not have that permission and includeRecordingsWithSensitiveData is set to true, then their request will be rejected.","```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.RecordingApi(); body = PureCloudPlatformClientV2.RecordingJobsQuery() # RecordingJobsQuery | query try: # Create a recording bulk job. api_response = api_instance.post_recording_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_recording_jobs: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/recording/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete the recording bulk 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.RecordingApi(); job_id = 'job_id_example' # str | jobId try: # Delete the recording bulk job api_instance.delete_recording_job(job_id) except ApiException as e: print(""Exception when calling RecordingApi->delete_recording_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the status of the job associated with the job 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.RecordingApi(); job_id = 'job_id_example' # str | jobId try: # Get the status of the job associated with the job id. api_response = api_instance.get_recording_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_job: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/recording/jobs/{jobId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Execute the recording bulk job. A job must be executed by the same user whom originally created the job. In addition, the user must have permission to update the recording's retention.","```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.RecordingApi(); job_id = 'job_id_example' # str | jobId body = PureCloudPlatformClientV2.ExecuteRecordingJobsQuery() # ExecuteRecordingJobsQuery | query try: # Execute the recording bulk job. api_response = api_instance.put_recording_job(job_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->put_recording_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/jobs/{jobId}/failedrecordings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get IDs of recordings that the bulk job failed for,"```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.RecordingApi(); job_id = 'job_id_example' # str | jobId page_size = 25 # int | Page size. Maximum is 100. (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) include_total = True # bool | If false, cursor will be used to locate the page instead of pageNumber. (optional) cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional) try: # Get IDs of recordings that the bulk job failed for api_response = api_instance.get_recording_job_failedrecordings(job_id, page_size=page_size, page_number=page_number, include_total=include_total, cursor=cursor) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_job_failedrecordings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/keyconfigurations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of key configurations data,"```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.RecordingApi(); try: # Get a list of key configurations data api_response = api_instance.get_recording_keyconfigurations() pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_keyconfigurations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recording/keyconfigurations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Setup configurations for encryption key creation,"```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.RecordingApi(); body = PureCloudPlatformClientV2.RecordingEncryptionConfiguration() # RecordingEncryptionConfiguration | Encryption Configuration try: # Setup configurations for encryption key creation api_response = api_instance.post_recording_keyconfigurations(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_recording_keyconfigurations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recording/keyconfigurations/validate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Validate encryption key configurations without saving it,"```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.RecordingApi(); body = PureCloudPlatformClientV2.RecordingEncryptionConfiguration() # RecordingEncryptionConfiguration | Encryption Configuration try: # Validate encryption key configurations without saving it api_response = api_instance.post_recording_keyconfigurations_validate(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_recording_keyconfigurations_validate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/keyconfigurations/{keyConfigurationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the encryption key configurations,"```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.RecordingApi(); key_configuration_id = 'key_configuration_id_example' # str | Key Configurations Id try: # Get the encryption key configurations api_response = api_instance.get_recording_keyconfiguration(key_configuration_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_keyconfiguration: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/recording/keyconfigurations/{keyConfigurationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the encryption key configurations,"```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.RecordingApi(); key_configuration_id = 'key_configuration_id_example' # str | Key Configurations Id body = PureCloudPlatformClientV2.RecordingEncryptionConfiguration() # RecordingEncryptionConfiguration | Encryption key configuration metadata try: # Update the encryption key configurations api_response = api_instance.put_recording_keyconfiguration(key_configuration_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->put_recording_keyconfiguration: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recording/localkeys Genesys Cloud Python SDK.,Genesys describes this as an API used to: create a local key management recording key,"```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.RecordingApi(); body = PureCloudPlatformClientV2.LocalEncryptionKeyRequest() # LocalEncryptionKeyRequest | Local Encryption body try: # create a local key management recording key api_response = api_instance.post_recording_localkeys(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_recording_localkeys: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/recording/mediaretentionpolicies Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Delete media retention policies. Bulk delete of media retention policies, this will only delete the polices that match the ids specified in the 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.RecordingApi(); ids = 'ids_example' # str | try: # Delete media retention policies api_instance.delete_recording_mediaretentionpolicies(ids) except ApiException as e: print(""Exception when calling RecordingApi->delete_recording_mediaretentionpolicies: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/mediaretentionpolicies Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Gets media retention policy list with query options to filter on name and enabled. for a less verbose response, add summary=true to this endpoint","```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.RecordingApi(); 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) name = 'name_example' # str | the policy name - used for filtering results in searches. (optional) enabled = True # bool | checks to see if policy is enabled - use enabled = true or enabled = false (optional) summary = False # bool | provides a less verbose response of policy lists. (optional) (default to False) has_errors = True # bool | provides a way to fetch all policies with errors or policies that do not have errors (optional) delete_days_threshold = 56 # int | provides a way to fetch all policies with any actions having deleteDays exceeding the provided value (optional) try: # Gets media retention policy list with query options to filter on name and enabled. api_response = api_instance.get_recording_mediaretentionpolicies(page_size=page_size, page_number=page_number, sort_by=sort_by, expand=expand, next_page=next_page, previous_page=previous_page, name=name, enabled=enabled, summary=summary, has_errors=has_errors, delete_days_threshold=delete_days_threshold) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_mediaretentionpolicies: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recording/mediaretentionpolicies Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create media retention policy. Policy does not work retroactively,"```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.RecordingApi(); body = PureCloudPlatformClientV2.PolicyCreate() # PolicyCreate | Policy try: # Create media retention policy api_response = api_instance.post_recording_mediaretentionpolicies(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_recording_mediaretentionpolicies: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/recording/mediaretentionpolicies/{policyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a media retention policy,"```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.RecordingApi(); policy_id = 'policy_id_example' # str | Policy ID try: # Delete a media retention policy api_instance.delete_recording_mediaretentionpolicy(policy_id) except ApiException as e: print(""Exception when calling RecordingApi->delete_recording_mediaretentionpolicy: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/mediaretentionpolicies/{policyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a media retention policy,"```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.RecordingApi(); policy_id = 'policy_id_example' # str | Policy ID try: # Get a media retention policy api_response = api_instance.get_recording_mediaretentionpolicy(policy_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_mediaretentionpolicy: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/recording/mediaretentionpolicies/{policyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch a media retention policy,"```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.RecordingApi(); policy_id = 'policy_id_example' # str | Policy ID body = PureCloudPlatformClientV2.PolicyUpdate() # PolicyUpdate | Policy try: # Patch a media retention policy api_response = api_instance.patch_recording_mediaretentionpolicy(policy_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->patch_recording_mediaretentionpolicy: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/recording/mediaretentionpolicies/{policyId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a media retention policy. Policy does not work retroactively,"```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.RecordingApi(); policy_id = 'policy_id_example' # str | Policy ID body = PureCloudPlatformClientV2.Policy() # Policy | Policy try: # Update a media retention policy api_response = api_instance.put_recording_mediaretentionpolicy(policy_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->put_recording_mediaretentionpolicy: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/recordingkeys Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get encryption key list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.RecordingApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get encryption key list api_response = api_instance.get_recording_recordingkeys(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_recordingkeys: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recording/recordingkeys Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create encryption key,"```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.RecordingApi(); try: # Create encryption key api_response = api_instance.post_recording_recordingkeys() pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_recording_recordingkeys: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/recordingkeys/rotationschedule Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get key rotation schedule,"```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.RecordingApi(); try: # Get key rotation schedule api_response = api_instance.get_recording_recordingkeys_rotationschedule() pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_recordingkeys_rotationschedule: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/recording/recordingkeys/rotationschedule Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update key rotation schedule,"```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.RecordingApi(); body = PureCloudPlatformClientV2.KeyRotationSchedule() # KeyRotationSchedule | KeyRotationSchedule try: # Update key rotation schedule api_response = api_instance.put_recording_recordingkeys_rotationschedule(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->put_recording_recordingkeys_rotationschedule: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the Recording Settings for the Organization,"```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.RecordingApi(); create_default = False # bool | If no settings are found, a new one is created with default values (optional) (default to False) try: # Get the Recording Settings for the Organization api_response = api_instance.get_recording_settings(create_default=create_default) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/recording/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the Recording Settings for the Organization,"```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.RecordingApi(); body = PureCloudPlatformClientV2.RecordingSettings() # RecordingSettings | Recording settings try: # Update the Recording Settings for the Organization api_response = api_instance.put_recording_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->put_recording_settings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recording/uploads/reports Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a recording upload status report,"```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.RecordingApi(); body = PureCloudPlatformClientV2.RecordingUploadReportRequest() # RecordingUploadReportRequest | Report parameters try: # Creates a recording upload status report api_response = api_instance.post_recording_uploads_reports(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_recording_uploads_reports: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recording/uploads/reports/{reportId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the status of a recording upload status report,"```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.RecordingApi(); report_id = 'report_id_example' # str | reportId try: # Get the status of a recording upload status report api_response = api_instance.get_recording_uploads_report(report_id) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recording_uploads_report: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recordings/deletionprotection Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of conversations with protected recordings,"```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.RecordingApi(); body = PureCloudPlatformClientV2.ConversationDeletionProtectionQuery() # ConversationDeletionProtectionQuery | conversationIds try: # Get a list of conversations with protected recordings api_response = api_instance.post_recordings_deletionprotection(body) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->post_recordings_deletionprotection: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/recordings/deletionprotection Genesys Cloud Python SDK.,Genesys describes this as an API used to: Apply or revoke recording protection for conversations,"```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.RecordingApi(); protect = True # bool | Check for apply, uncheck for revoke (each action requires the respective permission) (optional) (default to True) body = PureCloudPlatformClientV2.ConversationDeletionProtectionQuery() # ConversationDeletionProtectionQuery | (optional) try: # Apply or revoke recording protection for conversations api_instance.put_recordings_deletionprotection(protect=protect, body=body) except ApiException as e: print(""Exception when calling RecordingApi->put_recordings_deletionprotection: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recordings/retention/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for recording retention data,"```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.RecordingApi(); retention_threshold_days = 56 # int | Fetch retention data for recordings retained for more days than the provided value. cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional) page_size = 25 # int | Page size. Maximum is 500. (optional) (default to 25) try: # Query for recording retention data api_response = api_instance.get_recordings_retention_query(retention_threshold_days, cursor=cursor, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recordings_retention_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recordings/screensessions/acknowledge Genesys Cloud Python SDK.,Genesys describes this as an API used to: Acknowledge a screen recording.,"```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.RecordingApi(); body = PureCloudPlatformClientV2.AcknowledgeScreenRecordingRequest() # AcknowledgeScreenRecordingRequest | AcknowledgeScreenRecordingRequest try: # Acknowledge a screen recording. api_instance.post_recordings_screensessions_acknowledge(body) except ApiException as e: print(""Exception when calling RecordingApi->post_recordings_screensessions_acknowledge: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/recordings/screensessions/details Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves an object containing the total number of concurrent active screen recordings,"```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.RecordingApi(); try: # Retrieves an object containing the total number of concurrent active screen recordings api_response = api_instance.get_recordings_screensessions_details() pprint(api_response) except ApiException as e: print(""Exception when calling RecordingApi->get_recordings_screensessions_details: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/recordings/screensessions/metadata Genesys Cloud Python SDK.,Genesys describes this as an API used to: Provide meta-data a screen recording.,"```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.RecordingApi(); body = PureCloudPlatformClientV2.ScreenRecordingMetaDataRequest() # ScreenRecordingMetaDataRequest | ScreenRecordingMetaDataRequest try: # Provide meta-data a screen recording. api_instance.post_recordings_screensessions_metadata(body) except ApiException as e: print(""Exception when calling RecordingApi->post_recordings_screensessions_metadata: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/responsemanagement/libraries Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a list of existing response libraries.,"```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.ResponseManagementApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) messaging_template_filter = 'messaging_template_filter_example' # str | Returns a list of libraries that contain responses with at least one messaging template defined for a specific message channel (optional) library_prefix = 'library_prefix_example' # str | Returns a list of libraries that contain the prefix provided (optional) try: # Gets a list of existing response libraries. api_response = api_instance.get_responsemanagement_libraries(page_number=page_number, page_size=page_size, messaging_template_filter=messaging_template_filter, library_prefix=library_prefix) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->get_responsemanagement_libraries: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/responsemanagement/libraries Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a response library.,"```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.ResponseManagementApi(); body = PureCloudPlatformClientV2.Library() # Library | Library try: # Create a response library. api_response = api_instance.post_responsemanagement_libraries(body) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->post_responsemanagement_libraries: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/responsemanagement/libraries/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get response libraries.,"```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.ResponseManagementApi(); body = PureCloudPlatformClientV2.LibraryBatchRequest() # LibraryBatchRequest | LibraryIDs (max allowed 50) try: # Get response libraries. api_response = api_instance.post_responsemanagement_libraries_bulk(body) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->post_responsemanagement_libraries_bulk: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/responsemanagement/libraries/{libraryId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an existing response library. This will remove any responses associated with the library.,"```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.ResponseManagementApi(); library_id = 'library_id_example' # str | Library ID try: # Delete an existing response library. api_instance.delete_responsemanagement_library(library_id) except ApiException as e: print(""Exception when calling ResponseManagementApi->delete_responsemanagement_library: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/responsemanagement/libraries/{libraryId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get details about an existing response library.,"```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.ResponseManagementApi(); library_id = 'library_id_example' # str | Library ID try: # Get details about an existing response library. api_response = api_instance.get_responsemanagement_library(library_id) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->get_responsemanagement_library: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/responsemanagement/libraries/{libraryId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an existing response library. Fields that can be updated: name. The most recent version is required for updates.,"```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.ResponseManagementApi(); library_id = 'library_id_example' # str | Library ID body = PureCloudPlatformClientV2.Library() # Library | Library try: # Update an existing response library. api_response = api_instance.put_responsemanagement_library(library_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->put_responsemanagement_library: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/responsemanagement/responseassets/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search response assets,"```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.ResponseManagementApi(); body = PureCloudPlatformClientV2.ResponseAssetSearchRequest() # ResponseAssetSearchRequest | request expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) try: # Search response assets api_response = api_instance.post_responsemanagement_responseassets_search(body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->post_responsemanagement_responseassets_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/responsemanagement/responseassets/status/{statusId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get response asset upload status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.ResponseManagementApi(); status_id = 'status_id_example' # str | Status Id try: # Get response asset upload status api_response = api_instance.get_responsemanagement_responseassets_status_status_id(status_id) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->get_responsemanagement_responseassets_status_status_id: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/responsemanagement/responseassets/uploads Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates pre-signed url for uploading response asset,"```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.ResponseManagementApi(); body = PureCloudPlatformClientV2.CreateResponseAssetRequest() # CreateResponseAssetRequest | request try: # Creates pre-signed url for uploading response asset api_response = api_instance.post_responsemanagement_responseassets_uploads(body) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->post_responsemanagement_responseassets_uploads: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/responsemanagement/responseassets/{responseAssetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete response asset,"```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.ResponseManagementApi(); response_asset_id = 'response_asset_id_example' # str | Asset Id try: # Delete response asset api_instance.delete_responsemanagement_responseasset(response_asset_id) except ApiException as e: print(""Exception when calling ResponseManagementApi->delete_responsemanagement_responseasset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/responsemanagement/responseassets/{responseAssetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get response asset information,"```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.ResponseManagementApi(); response_asset_id = 'response_asset_id_example' # str | Asset Id try: # Get response asset information api_response = api_instance.get_responsemanagement_responseasset(response_asset_id) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->get_responsemanagement_responseasset: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/responsemanagement/responseassets/{responseAssetId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update response asset,"```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.ResponseManagementApi(); response_asset_id = 'response_asset_id_example' # str | Asset Id body = PureCloudPlatformClientV2.ResponseAssetRequest() # ResponseAssetRequest | request try: # Update response asset api_response = api_instance.put_responsemanagement_responseasset(response_asset_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->put_responsemanagement_responseasset: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/responsemanagement/responses Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a list of existing responses.,"```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.ResponseManagementApi(); library_id = 'library_id_example' # str | Library ID page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) expand = 'expand_example' # str | Expand instructions for the return value. (optional) try: # Gets a list of existing responses. api_response = api_instance.get_responsemanagement_responses(library_id, page_number=page_number, page_size=page_size, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->get_responsemanagement_responses: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/responsemanagement/responses Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a response.,"```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.ResponseManagementApi(); body = PureCloudPlatformClientV2.Response() # Response | Response expand = 'expand_example' # str | Expand instructions for the return value. (optional) try: # Create a response. api_response = api_instance.post_responsemanagement_responses(body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->post_responsemanagement_responses: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/responsemanagement/responses/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query responses,"```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.ResponseManagementApi(); body = PureCloudPlatformClientV2.ResponseQueryRequest() # ResponseQueryRequest | Response try: # Query responses api_response = api_instance.post_responsemanagement_responses_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->post_responsemanagement_responses_query: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/responsemanagement/responses/{responseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an existing response. This will remove the response from any libraries associated with it.,"```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.ResponseManagementApi(); response_id = 'response_id_example' # str | Response ID try: # Delete an existing response. api_instance.delete_responsemanagement_response(response_id) except ApiException as e: print(""Exception when calling ResponseManagementApi->delete_responsemanagement_response: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/responsemanagement/responses/{responseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get details about an existing response.,"```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.ResponseManagementApi(); response_id = 'response_id_example' # str | Response ID expand = 'expand_example' # str | Expand instructions for the return value. (optional) try: # Get details about an existing response. api_response = api_instance.get_responsemanagement_response(response_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->get_responsemanagement_response: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/responsemanagement/responses/{responseId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Update an existing response. Fields that can be updated: name, libraries, and texts. The most recent version is required for updates.","```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.ResponseManagementApi(); response_id = 'response_id_example' # str | Response ID body = PureCloudPlatformClientV2.Response() # Response | Response expand = 'expand_example' # str | Expand instructions for the return value. (optional) try: # Update an existing response. api_response = api_instance.put_responsemanagement_response(response_id, body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling ResponseManagementApi->put_responsemanagement_response: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/queues/observations/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for queue observations,"```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.RoutingApi(); body = PureCloudPlatformClientV2.QueueObservationQuery() # QueueObservationQuery | query try: # Query for queue observations api_response = api_instance.post_analytics_queues_observations_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_analytics_queues_observations_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/routing/activity/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user activity observations,"```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.RoutingApi(); body = PureCloudPlatformClientV2.RoutingActivityQuery() # RoutingActivityQuery | query page_size = 56 # int | The desired page size (optional) page_number = 56 # int | The desired page number (optional) try: # Query for user activity observations api_response = api_instance.post_analytics_routing_activity_query(body, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_analytics_routing_activity_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/assessments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve all benefit assessments.,"```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.RoutingApi(); before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) limit = 'limit_example' # str | Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) queue_id = ['queue_id_example'] # list[str] | Queue ID(s) to filter assessments by. (optional) try: # Retrieve all benefit assessments. api_response = api_instance.get_routing_assessments(before=before, after=after, limit=limit, page_size=page_size, queue_id=queue_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_assessments: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/assessments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a benefit assessment.,"```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.RoutingApi(); body = PureCloudPlatformClientV2.CreateBenefitAssessmentRequest() # CreateBenefitAssessmentRequest | (optional) try: # Create a benefit assessment. api_response = api_instance.post_routing_assessments(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_assessments: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/assessments/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve all benefit assessment jobs.,"```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.RoutingApi(); division_id = ['division_id_example'] # list[str] | Division ID(s) to filter assessment jobs by. (optional) try: # Retrieve all benefit assessment jobs. api_response = api_instance.get_routing_assessments_jobs(division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_assessments_jobs: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/assessments/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a benefit assessment 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.RoutingApi(); body = PureCloudPlatformClientV2.CreateBenefitAssessmentJobRequest() # CreateBenefitAssessmentJobRequest | (optional) try: # Create a benefit assessment job. api_response = api_instance.post_routing_assessments_jobs(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_assessments_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/assessments/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a single benefit assessments 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.RoutingApi(); job_id = 'job_id_example' # str | Benefit Assessment Job ID try: # Retrieve a single benefit assessments job. api_response = api_instance.get_routing_assessments_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_assessments_job: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/assessments/{assessmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete single benefit assessment.,"```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.RoutingApi(); assessment_id = 'assessment_id_example' # str | Benefit Assessment ID try: # Delete single benefit assessment. api_instance.delete_routing_assessment(assessment_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_assessment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/assessments/{assessmentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a single benefit assessment.,"```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.RoutingApi(); assessment_id = 'assessment_id_example' # str | Benefit Assessment ID try: # Retrieve a single benefit assessment. api_response = api_instance.get_routing_assessment(assessment_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_assessment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/availablemediatypes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get available media 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.RoutingApi(); try: # Get available media types api_response = api_instance.get_routing_availablemediatypes() pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_availablemediatypes: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/routing/conversations/{conversationId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Update attributes of an in-queue conversation. Returns an object indicating the updated values of all settable attributes. Supported attributes: skillIds, languageId, and priority.","```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.RoutingApi(); conversation_id = 'conversation_id_example' # str | Conversation ID body = PureCloudPlatformClientV2.RoutingConversationAttributesRequest() # RoutingConversationAttributesRequest | Conversation Attributes try: # Update attributes of an in-queue conversation api_response = api_instance.patch_routing_conversation(conversation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->patch_routing_conversation: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/directroutingbackup/settings/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.,"```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.UsersApi(); try: # Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default. api_instance.delete_routing_directroutingbackup_settings_me() except ApiException as e: print(""Exception when calling UsersApi->delete_routing_directroutingbackup_settings_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/directroutingbackup/settings/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the user's Direct Routing Backup settings.,"```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.UsersApi(); try: # Get the user's Direct Routing Backup settings. api_response = api_instance.get_routing_directroutingbackup_settings_me() pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_routing_directroutingbackup_settings_me: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/directroutingbackup/settings/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the user's Direct Routing Backup settings.,"```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.UsersApi(); body = PureCloudPlatformClientV2.AgentDirectRoutingBackupSettings() # AgentDirectRoutingBackupSettings | directRoutingBackup try: # Update the user's Direct Routing Backup settings. api_response = api_instance.put_routing_directroutingbackup_settings_me(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_routing_directroutingbackup_settings_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/email/domains Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get domains,"```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.RoutingApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) exclude_status = False # bool | Exclude MX record data (optional) (default to False) filter = 'filter_example' # str | Optional search filter (optional) try: # Get domains api_response = api_instance.get_routing_email_domains(page_size=page_size, page_number=page_number, exclude_status=exclude_status, filter=filter) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_email_domains: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/email/domains Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a domain,"```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.RoutingApi(); body = PureCloudPlatformClientV2.InboundDomain() # InboundDomain | Domain try: # Create a domain api_response = api_instance.post_routing_email_domains(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_email_domains: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/email/domains/{domainId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a domain,"```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.RoutingApi(); domain_id = 'domain_id_example' # str | domain ID try: # Delete a domain api_instance.delete_routing_email_domain(domain_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_email_domain: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/email/domains/{domainId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get domain,"```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.RoutingApi(); domain_id = 'domain_id_example' # str | domain ID try: # Get domain api_response = api_instance.get_routing_email_domain(domain_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_email_domain: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/routing/email/domains/{domainId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update domain settings,"```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.RoutingApi(); domain_id = 'domain_id_example' # str | domain ID body = PureCloudPlatformClientV2.InboundDomainPatchRequest() # InboundDomainPatchRequest | Domain settings try: # Update domain settings api_response = api_instance.patch_routing_email_domain(domain_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->patch_routing_email_domain: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/email/domains/{domainId}/testconnection Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Tests the custom SMTP server integration connection set on this domain. The request body is optional. If omitted, this endpoint will just test the connection of the Custom SMTP Server. If the body is specified, there will be an attempt to send an email message to the server.","```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.RoutingApi(); domain_id = 'domain_id_example' # str | domain ID body = PureCloudPlatformClientV2.TestMessage() # TestMessage | TestMessage (optional) try: # Tests the custom SMTP server integration connection set on this domain api_response = api_instance.post_routing_email_domain_testconnection(domain_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_email_domain_testconnection: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/routing/email/domains/{domainId}/validate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Validate domain settings,"```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.RoutingApi(); domain_id = 'domain_id_example' # str | domain ID body = PureCloudPlatformClientV2.InboundDomainPatchRequest() # InboundDomainPatchRequest | Domain settings try: # Validate domain settings api_response = api_instance.patch_routing_email_domain_validate(domain_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->patch_routing_email_domain_validate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/email/domains/{domainName}/routes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get routes,"```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.RoutingApi(); domain_name = 'domain_name_example' # str | email domain page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) pattern = 'pattern_example' # str | Filter routes by the route's pattern property (optional) try: # Get routes api_response = api_instance.get_routing_email_domain_routes(domain_name, page_size=page_size, page_number=page_number, pattern=pattern) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_email_domain_routes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/email/domains/{domainName}/routes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a route,"```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.RoutingApi(); domain_name = 'domain_name_example' # str | email domain body = PureCloudPlatformClientV2.InboundRoute() # InboundRoute | Route try: # Create a route api_response = api_instance.post_routing_email_domain_routes(domain_name, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_email_domain_routes: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/email/domains/{domainName}/routes/{routeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a route,"```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.RoutingApi(); domain_name = 'domain_name_example' # str | email domain route_id = 'route_id_example' # str | route ID try: # Delete a route api_instance.delete_routing_email_domain_route(domain_name, route_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_email_domain_route: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/email/domains/{domainName}/routes/{routeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a route,"```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.RoutingApi(); domain_name = 'domain_name_example' # str | email domain route_id = 'route_id_example' # str | route ID try: # Get a route api_response = api_instance.get_routing_email_domain_route(domain_name, route_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_email_domain_route: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/email/domains/{domainName}/routes/{routeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a route,"```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.RoutingApi(); domain_name = 'domain_name_example' # str | email domain route_id = 'route_id_example' # str | route ID body = PureCloudPlatformClientV2.InboundRoute() # InboundRoute | Route try: # Update a route api_response = api_instance.put_routing_email_domain_route(domain_name, route_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->put_routing_email_domain_route: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/email/outbound/domains Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get outbound domains,"```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.RoutingApi(); filter = 'filter_example' # str | Optional search filter (optional) try: # Get outbound domains api_response = api_instance.get_routing_email_outbound_domains(filter=filter) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_email_outbound_domains: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/email/outbound/domains Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a domain,"```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.RoutingApi(); body = PureCloudPlatformClientV2.OutboundDomain() # OutboundDomain | Domain try: # Create a domain api_response = api_instance.post_routing_email_outbound_domains(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_email_outbound_domains: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/email/outbound/domains/simulated Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a simulated domain,"```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.RoutingApi(); body = PureCloudPlatformClientV2.OutboundDomain() # OutboundDomain | Domain try: # Create a simulated domain api_response = api_instance.post_routing_email_outbound_domains_simulated(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_email_outbound_domains_simulated: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/email/outbound/domains/{domainId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an outbound domain,"```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.RoutingApi(); domain_id = 'domain_id_example' # str | domain ID try: # Delete an outbound domain api_instance.delete_routing_email_outbound_domain(domain_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_email_outbound_domain: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/email/outbound/domains/{domainId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get domain,"```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.RoutingApi(); domain_id = 'domain_id_example' # str | domain ID try: # Get domain api_response = api_instance.get_routing_email_outbound_domain(domain_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_email_outbound_domain: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/email/outbound/domains/{domainId}/activation Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get activation status (cname + dkim) of an outbound domain,"```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.RoutingApi(); domain_id = 'domain_id_example' # str | domain ID try: # Get activation status (cname + dkim) of an outbound domain api_response = api_instance.get_routing_email_outbound_domain_activation(domain_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_email_outbound_domain_activation: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/email/outbound/domains/{domainId}/activation Genesys Cloud Python SDK.,Genesys describes this as an API used to: Request an activation status (cname + dkim) update of an outbound domain,"```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.RoutingApi(); domain_id = 'domain_id_example' # str | domain ID try: # Request an activation status (cname + dkim) update of an outbound domain api_response = api_instance.put_routing_email_outbound_domain_activation(domain_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->put_routing_email_outbound_domain_activation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/email/outbound/domains/{domainId}/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search a domain across organizations,"```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.RoutingApi(); domain_id = 'domain_id_example' # str | domain ID try: # Search a domain across organizations api_response = api_instance.get_routing_email_outbound_domain_search(domain_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_email_outbound_domain_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/email/setup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get email setup,"```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.RoutingApi(); try: # Get email setup api_response = api_instance.get_routing_email_setup() pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_email_setup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/languages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of supported languages.,"```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.RoutingApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''ASC'' # str | Ascending or descending sort order (optional) (default to 'ASC') name = 'name_example' # str | Name (optional) id = ['id_example'] # list[str] | id (optional) try: # Get the list of supported languages. api_response = api_instance.get_routing_languages(page_size=page_size, page_number=page_number, sort_order=sort_order, name=name, id=id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_languages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/languages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create Language,"```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.RoutingApi(); body = PureCloudPlatformClientV2.Language() # Language | Language try: # Create Language api_response = api_instance.post_routing_languages(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_languages: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/languages/{languageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a routing language,"```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.RoutingApi(); language_id = 'language_id_example' # str | Language ID try: # Delete a routing language api_instance.delete_routing_language(language_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_language: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/languages/{languageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a routing language,"```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.RoutingApi(); language_id = 'language_id_example' # str | Language ID try: # Get a routing language api_response = api_instance.get_routing_language(language_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_language: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/message/recipients Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get recipients,"```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.RoutingApi(); messenger_type = 'messenger_type_example' # str | Messenger Type (optional) name = 'name_example' # str | Recipient Name (optional) page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get recipients api_response = api_instance.get_routing_message_recipients(messenger_type=messenger_type, name=name, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_message_recipients: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/message/recipients/{recipientId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a recipient,"```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.RoutingApi(); recipient_id = 'recipient_id_example' # str | Recipient ID try: # Get a recipient api_response = api_instance.get_routing_message_recipient(recipient_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_message_recipient: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/message/recipients/{recipientId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a recipient,"```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.RoutingApi(); recipient_id = 'recipient_id_example' # str | Recipient ID body = PureCloudPlatformClientV2.RecipientRequest() # RecipientRequest | Recipient try: # Update a recipient api_response = api_instance.put_routing_message_recipient(recipient_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->put_routing_message_recipient: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/predictors Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve all predictors.,"```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.RoutingApi(); before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) limit = 'limit_example' # str | Number of entities to return. Maximum of 200. Deprecated in favour of pageSize (optional) page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional) queue_id = ['queue_id_example'] # list[str] | Comma-separated list of queue Ids to filter by. (optional) try: # Retrieve all predictors. api_response = api_instance.get_routing_predictors(before=before, after=after, limit=limit, page_size=page_size, queue_id=queue_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_predictors: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/predictors Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a predictor.,"```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.RoutingApi(); body = PureCloudPlatformClientV2.CreatePredictorRequest() # CreatePredictorRequest | (optional) try: # Create a predictor. api_response = api_instance.post_routing_predictors(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_predictors: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/predictors/keyperformanceindicators Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Key Performance Indicators,"```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.RoutingApi(); kpi_group = 'kpi_group_example' # str | The Group of Key Performance Indicators to return (optional) expand = ['expand_example'] # list[str] | Parameter to request additional data to return in KPI payload (optional) try: # Get a list of Key Performance Indicators api_response = api_instance.get_routing_predictors_keyperformanceindicators(kpi_group=kpi_group, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_predictors_keyperformanceindicators: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/predictors/{predictorId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete single predictor.,"```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.RoutingApi(); predictor_id = 'predictor_id_example' # str | Predictor ID try: # Delete single predictor. api_instance.delete_routing_predictor(predictor_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_predictor: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/predictors/{predictorId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a single predictor.,"```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.RoutingApi(); predictor_id = 'predictor_id_example' # str | Predictor ID try: # Retrieve a single predictor. api_response = api_instance.get_routing_predictor(predictor_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_predictor: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/routing/predictors/{predictorId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update single predictor.,"```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.RoutingApi(); predictor_id = 'predictor_id_example' # str | Predictor ID body = PureCloudPlatformClientV2.PatchPredictorRequest() # PatchPredictorRequest | (optional) try: # Update single predictor. api_response = api_instance.patch_routing_predictor(predictor_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->patch_routing_predictor: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/predictors/{predictorId}/models Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve Predictor Models and Top Features.,"```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.RoutingApi(); predictor_id = 'predictor_id_example' # str | Predictor ID try: # Retrieve Predictor Models and Top Features. api_response = api_instance.get_routing_predictor_models(predictor_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_predictor_models: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/predictors/{predictorId}/models/{modelId}/features Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve Predictor Model Features.,"```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.RoutingApi(); predictor_id = 'predictor_id_example' # str | Predictor ID model_id = 'model_id_example' # str | Model ID try: # Retrieve Predictor Model Features. api_response = api_instance.get_routing_predictor_model_features(predictor_id, model_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_predictor_model_features: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of queues.,"```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.RoutingApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_order = ''asc'' # str | Note: results are sorted by name. (optional) (default to 'asc') name = 'name_example' # str | Include only queues with the given name (leading and trailing asterisks allowed) (optional) id = ['id_example'] # list[str] | Include only queues with the specified ID(s) (optional) division_id = ['division_id_example'] # list[str] | Include only queues in the specified division ID(s) (optional) peer_id = ['peer_id_example'] # list[str] | Include only queues with the specified peer ID(s) (optional) canned_response_library_id = 'canned_response_library_id_example' # str | Include only queues explicitly associated with the specified canned response library ID (optional) has_peer = True # bool | Include only queues with a peer ID (optional) try: # Get list of queues. api_response = api_instance.get_routing_queues(page_number=page_number, page_size=page_size, sort_order=sort_order, name=name, id=id, division_id=division_id, peer_id=peer_id, canned_response_library_id=canned_response_library_id, has_peer=has_peer) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queues: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/queues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a queue,"```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.RoutingApi(); body = PureCloudPlatformClientV2.CreateQueueRequest() # CreateQueueRequest | Queue try: # Create a queue api_response = api_instance.post_routing_queues(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_queues: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s).","```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.RoutingApi(); page_size = 25 # int | Page size [max value is 100] (optional) (default to 25) page_number = 1 # int | Page number [max value is 5] (optional) (default to 1) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') name = 'name_example' # str | Name (optional) id = ['id_example'] # list[str] | Queue ID(s) (optional) division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) try: # Get a paged listing of simplified queue objects, filterable by name, queue ID(s), or division ID(s). api_response = api_instance.get_routing_queues_divisionviews(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, name=name, id=id, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queues_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/divisionviews/all Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization.","```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.RoutingApi(); page_size = 25 # int | Page size [max value is 500] (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''asc'' # str | Sort order (optional) (default to 'asc') try: # Get a paged listing of simplified queue objects, sorted by name. Can be used to get a digest of all queues in an organization. api_response = api_instance.get_routing_queues_divisionviews_all(page_size=page_size, page_number=page_number, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queues_divisionviews_all: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a paged listing of queues the user is a member of.,"```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.RoutingApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) joined = True # bool | Filter by joined status. (optional) sort_order = ''asc'' # str | Note: results are sorted by name. (optional) (default to 'asc') try: # Get a paged listing of queues the user is a member of. api_response = api_instance.get_routing_queues_me(page_number=page_number, page_size=page_size, joined=joined, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queues_me: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/queues/{queueId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a queue,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID force_delete = True # bool | forceDelete (optional) try: # Delete a queue api_instance.delete_routing_queue(queue_id, force_delete=force_delete) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_queue: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/{queueId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get details about this queue.,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID try: # Get details about this queue. api_response = api_instance.get_routing_queue(queue_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queue: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/queues/{queueId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a queue,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID body = PureCloudPlatformClientV2.QueueRequest() # QueueRequest | Queue try: # Update a queue api_response = api_instance.put_routing_queue(queue_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->put_routing_queue: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/{queueId}/assistant Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an assistant associated with a queue.,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID expand = 'expand_example' # str | Which fields, if any, to expand. (optional) try: # Get an assistant associated with a queue. api_response = api_instance.get_routing_queue_assistant(queue_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queue_assistant: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/{queueId}/comparisonperiods Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of comparison periods,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue id try: # Get list of comparison periods api_response = api_instance.get_routing_queue_comparisonperiods(queue_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queue_comparisonperiods: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/{queueId}/comparisonperiods/{comparisonPeriodId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Comparison Period.,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue id comparison_period_id = 'comparison_period_id_example' # str | ComparisonPeriod id try: # Get a Comparison Period. api_response = api_instance.get_routing_queue_comparisonperiod(queue_id, comparison_period_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queue_comparisonperiod: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/{queueId}/estimatedwaittime Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Estimated Wait Time,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | queueId conversation_id = 'conversation_id_example' # str | conversationId (optional) try: # Get Estimated Wait Time api_response = api_instance.get_routing_queue_estimatedwaittime(queue_id, conversation_id=conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queue_estimatedwaittime: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Estimated Wait Time,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | queueId media_type = 'media_type_example' # str | mediaType try: # Get Estimated Wait Time api_response = api_instance.get_routing_queue_mediatype_estimatedwaittime(queue_id, media_type) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queue_mediatype_estimatedwaittime: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/{queueId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the members of this queue.,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID page_number = 1 # int | (optional) (default to 1) page_size = 25 # int | Max value is 100 (optional) (default to 25) sort_order = ''asc'' # str | Note: results are sorted by name. (optional) (default to 'asc') expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) name = 'name_example' # str | Filter by queue member name (contains-style search) (optional) profile_skills = ['profile_skills_example'] # list[str] | Filter by profile skill (contains-style search) (optional) skills = ['skills_example'] # list[str] | Filter by skill (contains-style search) (optional) languages = ['languages_example'] # list[str] | Filter by language (contains-style search) (optional) routing_status = ['routing_status_example'] # list[str] | Filter by routing status (optional) presence = ['presence_example'] # list[str] | Filter by presence (optional) member_by = 'member_by_example' # str | Filter by member type (optional) joined = True # bool | Filter by joined status (optional) try: # Get the members of this queue. api_response = api_instance.get_routing_queue_members(queue_id, page_number=page_number, page_size=page_size, sort_order=sort_order, expand=expand, name=name, profile_skills=profile_skills, skills=skills, languages=languages, routing_status=routing_status, presence=presence, member_by=member_by, joined=joined) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queue_members: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/routing/queues/{queueId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Join or unjoin a set of users for a queue,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID body = [PureCloudPlatformClientV2.QueueMember()] # list[QueueMember] | Queue Members try: # Join or unjoin a set of users for a queue api_response = api_instance.patch_routing_queue_members(queue_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->patch_routing_queue_members: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/queues/{queueId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk add or delete up to 100 queue members,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID body = [PureCloudPlatformClientV2.WritableEntity()] # list[WritableEntity] | Queue Members delete = False # bool | True to delete queue members (optional) (default to False) try: # Bulk add or delete up to 100 queue members api_instance.post_routing_queue_members(queue_id, body, delete=delete) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_queue_members: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/queues/{queueId}/members/{memberId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a queue member.,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID member_id = 'member_id_example' # str | Member ID try: # Delete a queue member. api_instance.delete_routing_queue_member(queue_id, member_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_queue_member: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/routing/queues/{queueId}/members/{memberId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the ring number OR joined status for a queue member.,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID member_id = 'member_id_example' # str | Member ID body = PureCloudPlatformClientV2.QueueMember() # QueueMember | Queue Member try: # Update the ring number OR joined status for a queue member. api_instance.patch_routing_queue_member(queue_id, member_id, body) except ApiException as e: print(""Exception when calling RoutingApi->patch_routing_queue_member: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/queues/{queueId}/wrapupcodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the wrap-up codes for a queue,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get the wrap-up codes for a queue api_response = api_instance.get_routing_queue_wrapupcodes(queue_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_queue_wrapupcodes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/queues/{queueId}/wrapupcodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add up to 100 wrap-up codes to a queue,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID body = [PureCloudPlatformClientV2.WrapUpCodeReference()] # list[WrapUpCodeReference] | List of wrapup codes try: # Add up to 100 wrap-up codes to a queue api_response = api_instance.post_routing_queue_wrapupcodes(queue_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_queue_wrapupcodes: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/queues/{queueId}/wrapupcodes/{codeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a wrap-up code from a queue,"```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.RoutingApi(); queue_id = 'queue_id_example' # str | Queue ID code_id = 'code_id_example' # str | Code ID try: # Delete a wrap-up code from a queue api_instance.delete_routing_queue_wrapupcode(queue_id, code_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_queue_wrapupcode: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an organization's routing settings,"```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.RoutingApi(); try: # Delete an organization's routing settings api_instance.delete_routing_settings() except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an organization's routing settings,"```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.RoutingApi(); try: # Get an organization's routing settings api_response = api_instance.get_routing_settings() pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an organization's routing settings,"```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.RoutingApi(); body = PureCloudPlatformClientV2.RoutingSettings() # RoutingSettings | Organization Settings try: # Update an organization's routing settings api_response = api_instance.put_routing_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->put_routing_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/settings/contactcenter Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Contact Center Settings,"```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.RoutingApi(); try: # Get Contact Center Settings api_response = api_instance.get_routing_settings_contactcenter() pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_settings_contactcenter: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/routing/settings/contactcenter Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Contact Center Settings,"```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.RoutingApi(); body = PureCloudPlatformClientV2.ContactCenterSettings() # ContactCenterSettings | Contact Center Settings try: # Update Contact Center Settings api_instance.patch_routing_settings_contactcenter(body) except ApiException as e: print(""Exception when calling RoutingApi->patch_routing_settings_contactcenter: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/settings/transcription Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Transcription Settings,"```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.RoutingApi(); try: # Get Transcription Settings api_response = api_instance.get_routing_settings_transcription() pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_settings_transcription: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/routing/settings/transcription Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch Transcription Settings,"```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.RoutingApi(); body = PureCloudPlatformClientV2.TranscriptionSettings() # TranscriptionSettings | Organization Settings try: # Patch Transcription Settings api_response = api_instance.patch_routing_settings_transcription(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->patch_routing_settings_transcription: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/settings/transcription Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Transcription Settings,"```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.RoutingApi(); body = PureCloudPlatformClientV2.TranscriptionSettings() # TranscriptionSettings | Organization Settings try: # Update Transcription Settings api_response = api_instance.put_routing_settings_transcription(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->put_routing_settings_transcription: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/skillgroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get skill group listing,"```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.RoutingApi(); page_size = 25 # int | Page size (optional) (default to 25) name = 'name_example' # str | Return only skill group names whose names start with this value (case-insensitive matching) (optional) after = 'after_example' # str | The cursor that points to the next item (optional) before = 'before_example' # str | The cursor that points to the previous item (optional) try: # Get skill group listing api_response = api_instance.get_routing_skillgroups(page_size=page_size, name=name, after=after, before=before) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_skillgroups: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/skillgroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a skill group,"```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.RoutingApi(); body = PureCloudPlatformClientV2.SkillGroupWithMemberDivisions() # SkillGroupWithMemberDivisions | Create skill group try: # Create a skill group api_response = api_instance.post_routing_skillgroups(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_skillgroups: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/skillgroups/{skillGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove skill group definition,"```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.RoutingApi(); skill_group_id = 'skill_group_id_example' # str | Skill Group ID try: # Remove skill group definition api_instance.delete_routing_skillgroup(skill_group_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_skillgroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/skillgroups/{skillGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get skill group,"```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.RoutingApi(); skill_group_id = 'skill_group_id_example' # str | Skill Group ID try: # Get skill group api_response = api_instance.get_routing_skillgroup(skill_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_skillgroup: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/routing/skillgroups/{skillGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update skill group definition,"```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.RoutingApi(); skill_group_id = 'skill_group_id_example' # str | Skill Group ID body = PureCloudPlatformClientV2.SkillGroup() # SkillGroup | Update skill groups try: # Update skill group definition api_response = api_instance.patch_routing_skillgroup(skill_group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->patch_routing_skillgroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/skillgroups/{skillGroupId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get skill group members,"```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.RoutingApi(); skill_group_id = 'skill_group_id_example' # str | Skill Group ID page_size = 25 # int | Page size (optional) (default to 25) after = 'after_example' # str | The cursor that points to the next item (optional) before = 'before_example' # str | The cursor that points to the previous item (optional) expand = 'expand_example' # str | Expand the name on each user (optional) try: # Get skill group members api_response = api_instance.get_routing_skillgroup_members(skill_group_id, page_size=page_size, after=after, before=before, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_skillgroup_members: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/skillgroups/{skillGroupId}/members/divisions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of member divisions for this skill group.,"```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.RoutingApi(); skill_group_id = 'skill_group_id_example' # str | Skill Group ID expand = 'expand_example' # str | Expand the name on each user (optional) try: # Get list of member divisions for this skill group. api_response = api_instance.get_routing_skillgroup_members_divisions(skill_group_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_skillgroup_members_divisions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/skillgroups/{skillGroupId}/members/divisions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add or remove member divisions for this skill group.,"```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.RoutingApi(); skill_group_id = 'skill_group_id_example' # str | Skill Group ID body = PureCloudPlatformClientV2.SkillGroupMemberDivisions() # SkillGroupMemberDivisions | (optional) try: # Add or remove member divisions for this skill group. api_instance.post_routing_skillgroup_members_divisions(skill_group_id, body=body) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_skillgroup_members_divisions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/skills Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of routing skills.,"```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.RoutingApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) name = 'name_example' # str | Filter for results that start with this value (optional) id = ['id_example'] # list[str] | id (optional) try: # Get the list of routing skills. api_response = api_instance.get_routing_skills(page_size=page_size, page_number=page_number, name=name, id=id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_skills: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/skills Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create Skill,"```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.RoutingApi(); body = PureCloudPlatformClientV2.RoutingSkill() # RoutingSkill | Skill try: # Create Skill api_response = api_instance.post_routing_skills(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_skills: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/skills/{skillId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Routing Skill,"```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.RoutingApi(); skill_id = 'skill_id_example' # str | Skill ID try: # Delete Routing Skill api_instance.delete_routing_skill(skill_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_skill: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/skills/{skillId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Routing Skill,"```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.RoutingApi(); skill_id = 'skill_id_example' # str | Skill ID try: # Get Routing Skill api_response = api_instance.get_routing_skill(skill_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_skill: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/sms/addresses Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Addresses for SMS,"```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.RoutingApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of Addresses for SMS api_response = api_instance.get_routing_sms_addresses(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_sms_addresses: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/sms/addresses Genesys Cloud Python SDK.,Genesys describes this as an API used to: Provision an Address for SMS,"```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.RoutingApi(); body = PureCloudPlatformClientV2.SmsAddressProvision() # SmsAddressProvision | SmsAddress try: # Provision an Address for SMS api_response = api_instance.post_routing_sms_addresses(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_sms_addresses: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/sms/addresses/{addressId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an Address by Id for SMS,"```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.RoutingApi(); address_id = 'address_id_example' # str | Address ID try: # Delete an Address by Id for SMS api_instance.delete_routing_sms_address(address_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_sms_address: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/sms/addresses/{addressId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an Address by Id for SMS,"```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.RoutingApi(); address_id = 'address_id_example' # str | Address ID try: # Get an Address by Id for SMS api_response = api_instance.get_routing_sms_address(address_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_sms_address: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/sms/availablephonenumbers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of available phone numbers for SMS provisioning. This request will return up to 30 random phone numbers matching the criteria specified. To get additional phone numbers repeat the request.,"```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.RoutingApi(); country_code = 'country_code_example' # str | The ISO 3166-1 alpha-2 country code of the county for which available phone numbers should be returned phone_number_type = 'phone_number_type_example' # str | Type of available phone numbers searched region = 'region_example' # str | Region/province/state that can be used to restrict the numbers returned (optional) city = 'city_example' # str | City that can be used to restrict the numbers returned (optional) area_code = 'area_code_example' # str | Area code that can be used to restrict the numbers returned (optional) pattern = 'pattern_example' # str | A pattern to match phone numbers. Valid characters are '*' and [0-9a-zA-Z]. The '*' character will match any single digit. (optional) address_requirement = 'address_requirement_example' # str | This indicates whether the phone number requires to have an Address registered. (optional) try: # Get a list of available phone numbers for SMS provisioning. api_response = api_instance.get_routing_sms_availablephonenumbers(country_code, phone_number_type, region=region, city=city, area_code=area_code, pattern=pattern, address_requirement=address_requirement) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_sms_availablephonenumbers: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/sms/phonenumbers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of provisioned phone numbers.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.RoutingApi(); phone_number = 'phone_number_example' # str | Filter on phone number address. Allowable characters are the digits '0-9' and the wild card character '\\*'. If just digits are present, a contains search is done on the address pattern. For example, '317' could be matched anywhere in the address. An '\\*' will match multiple digits. For example, to match a specific area code within the US a pattern like '1317*' could be used. (optional) phone_number_type = ['phone_number_type_example'] # list[str] | Filter on phone number type (optional) phone_number_status = ['phone_number_status_example'] # list[str] | Filter on phone number status (optional) country_code = ['country_code_example'] # list[str] | Filter on country code (optional) page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = 'sort_by_example' # str | Optional field to sort results (optional) sort_order = 'sort_order_example' # str | Sort order (optional) language = ''en-US'' # str | A language tag (which is sometimes referred to as a \""locale identifier\"") to use to localize country field and sort operations (optional) (default to 'en-US') integration_id = 'integration_id_example' # str | Filter on the Genesys Cloud integration id to which the phone number belongs to (optional) supported_content_id = 'supported_content_id_example' # str | Filter based on the supported content ID (optional) try: # Get a list of provisioned phone numbers. api_response = api_instance.get_routing_sms_phonenumbers(phone_number=phone_number, phone_number_type=phone_number_type, phone_number_status=phone_number_status, country_code=country_code, page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, language=language, integration_id=integration_id, supported_content_id=supported_content_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_sms_phonenumbers: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/sms/phonenumbers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Provision a phone number for SMS,"```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.RoutingApi(); body = PureCloudPlatformClientV2.SmsPhoneNumberProvision() # SmsPhoneNumberProvision | SmsPhoneNumber try: # Provision a phone number for SMS api_response = api_instance.post_routing_sms_phonenumbers(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_sms_phonenumbers: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/sms/phonenumbers/import Genesys Cloud Python SDK.,Genesys describes this as an API used to: Imports a phone number for SMS,"```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.RoutingApi(); body = PureCloudPlatformClientV2.SmsPhoneNumberImport() # SmsPhoneNumberImport | SmsPhoneNumber try: # Imports a phone number for SMS api_response = api_instance.post_routing_sms_phonenumbers_import(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_sms_phonenumbers_import: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/sms/phonenumbers/{addressId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a phone number provisioned for SMS.,"```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.RoutingApi(); address_id = 'address_id_example' # str | Address ID try: # Delete a phone number provisioned for SMS. api_instance.delete_routing_sms_phonenumber(address_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_sms_phonenumber: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/sms/phonenumbers/{addressId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a phone number provisioned for SMS.,"```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.RoutingApi(); address_id = 'address_id_example' # str | Address ID expand = 'expand_example' # str | Expand response with additional information (optional) try: # Get a phone number provisioned for SMS. api_response = api_instance.get_routing_sms_phonenumber(address_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_sms_phonenumber: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/sms/phonenumbers/{addressId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a phone number provisioned for SMS.,"```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.RoutingApi(); address_id = 'address_id_example' # str | Address ID body = PureCloudPlatformClientV2.SmsPhoneNumber() # SmsPhoneNumber | SmsPhoneNumber try: # Update a phone number provisioned for SMS. api_response = api_instance.put_routing_sms_phonenumber(address_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->put_routing_sms_phonenumber: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/users/{userId}/directroutingbackup/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default. api_instance.delete_routing_user_directroutingbackup_settings(user_id) except ApiException as e: print(""Exception when calling UsersApi->delete_routing_user_directroutingbackup_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/users/{userId}/directroutingbackup/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the user's Direct Routing Backup settings.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Get the user's Direct Routing Backup settings. api_response = api_instance.get_routing_user_directroutingbackup_settings(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_routing_user_directroutingbackup_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/users/{userId}/directroutingbackup/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the user's Direct Routing Backup settings.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.AgentDirectRoutingBackupSettings() # AgentDirectRoutingBackupSettings | directRoutingBackup try: # Update the user's Direct Routing Backup settings. api_response = api_instance.put_routing_user_directroutingbackup_settings(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_routing_user_directroutingbackup_settings: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/users/{userId}/utilization Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete the user's max utilization settings and revert to the organization-wide default.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Delete the user's max utilization settings and revert to the organization-wide default. api_instance.delete_routing_user_utilization(user_id) except ApiException as e: print(""Exception when calling UsersApi->delete_routing_user_utilization: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/users/{userId}/utilization Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the user's max utilization settings. If not configured, the organization-wide default is 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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Get the user's max utilization settings. If not configured, the organization-wide default is returned. api_response = api_instance.get_routing_user_utilization(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_routing_user_utilization: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/users/{userId}/utilization Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the user's max utilization settings. Include only those media types requiring custom 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UtilizationRequest() # UtilizationRequest | utilization try: # Update the user's max utilization settings. Include only those media types requiring custom configuration. api_response = api_instance.put_routing_user_utilization(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_routing_user_utilization: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/utilization Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete the organization-wide max utilization settings and revert to the system default.,"```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.RoutingApi(); try: # Delete the organization-wide max utilization settings and revert to the system default. api_instance.delete_routing_utilization() except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_utilization: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/utilization Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the organization-wide max utilization settings.,"```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.RoutingApi(); try: # Get the organization-wide max utilization settings. api_response = api_instance.get_routing_utilization() pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_utilization: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/utilization Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the organization-wide max utilization settings. Include only those media types requiring custom 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.RoutingApi(); body = PureCloudPlatformClientV2.UtilizationRequest() # UtilizationRequest | utilization try: # Update the organization-wide max utilization settings. Include only those media types requiring custom configuration. api_response = api_instance.put_routing_utilization(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->put_routing_utilization: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/utilization/labels Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of utilization labels,"```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.RoutingApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''ascending'' # str | Sort order by name (optional) (default to 'ascending') name = 'name_example' # str | Utilization label's name (Wildcard is supported, e.g., 'label1*', '*label*' (optional) try: # Get list of utilization labels api_response = api_instance.get_routing_utilization_labels(page_size=page_size, page_number=page_number, sort_order=sort_order, name=name) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_utilization_labels: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/utilization/labels Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a utilization label,"```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.RoutingApi(); body = PureCloudPlatformClientV2.CreateUtilizationLabelRequest() # CreateUtilizationLabelRequest | UtilizationLabel try: # Create a utilization label api_response = api_instance.post_routing_utilization_labels(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_utilization_labels: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/utilization/labels/{labelId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a utilization label,"```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.RoutingApi(); label_id = 'label_id_example' # str | Utilization Label ID force_delete = False # bool | Remove all label usages (if found) without warning (optional) (default to False) try: # Delete a utilization label api_instance.delete_routing_utilization_label(label_id, force_delete=force_delete) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_utilization_label: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/utilization/labels/{labelId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get details about this utilization label,"```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.RoutingApi(); label_id = 'label_id_example' # str | Utilization Label ID try: # Get details about this utilization label api_response = api_instance.get_routing_utilization_label(label_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_utilization_label: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/utilization/labels/{labelId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a utilization label,"```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.RoutingApi(); label_id = 'label_id_example' # str | Utilization Label ID body = PureCloudPlatformClientV2.UpdateUtilizationLabelRequest() # UpdateUtilizationLabelRequest | UtilizationLabel try: # Update a utilization label api_response = api_instance.put_routing_utilization_label(label_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->put_routing_utilization_label: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/utilization/labels/{labelId}/agents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of agent ids associated with a utilization label,"```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.RoutingApi(); label_id = 'label_id_example' # str | Utilization Label ID try: # Get list of agent ids associated with a utilization label api_response = api_instance.get_routing_utilization_label_agents(label_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_utilization_label_agents: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/wrapupcodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of wrapup codes.,"```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.RoutingApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending') name = 'name_example' # str | Wrapup code's name ('Sort by' param is ignored unless this field is provided) (optional) id = ['id_example'] # list[str] | Filter by wrapup code ID(s) (optional) division_id = ['division_id_example'] # list[str] | Filter by division ID(s) (optional) try: # Get list of wrapup codes. api_response = api_instance.get_routing_wrapupcodes(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, name=name, id=id, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_wrapupcodes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/routing/wrapupcodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a wrap-up code,"```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.RoutingApi(); body = PureCloudPlatformClientV2.WrapupCodeRequest() # WrapupCodeRequest | WrapupCode try: # Create a wrap-up code api_response = api_instance.post_routing_wrapupcodes(body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->post_routing_wrapupcodes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/wrapupcodes/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). Specifying both name and ID parameters is not supported.","```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.RoutingApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) name = 'name_example' # str | Name (trailing asterisks allowed) (optional) id = ['id_example'] # list[str] | Wrapup code ID(s) (optional) division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) include_state = 'include_state_example' # str | Wrapup code state(s) to include (optional) try: # Get a paged listing of simplified wrapup code objects, filterable by name, wrapup code ID(s), or division ID(s). api_response = api_instance.get_routing_wrapupcodes_divisionviews(page_size=page_size, page_number=page_number, name=name, id=id, division_id=division_id, include_state=include_state) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_wrapupcodes_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/wrapupcodes/divisionviews/{codeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a simplified wrap-up code.,"```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.RoutingApi(); code_id = 'code_id_example' # str | Wrapup Code ID try: # Get a simplified wrap-up code. api_response = api_instance.get_routing_wrapupcodes_divisionview(code_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_wrapupcodes_divisionview: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/wrapupcodes/{codeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete wrap-up code,"```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.RoutingApi(); code_id = 'code_id_example' # str | Wrapup Code ID try: # Delete wrap-up code api_instance.delete_routing_wrapupcode(code_id) except ApiException as e: print(""Exception when calling RoutingApi->delete_routing_wrapupcode: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/wrapupcodes/{codeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get details about this wrap-up code.,"```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.RoutingApi(); code_id = 'code_id_example' # str | Wrapup Code ID try: # Get details about this wrap-up code. api_response = api_instance.get_routing_wrapupcode(code_id) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->get_routing_wrapupcode: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/wrapupcodes/{codeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update wrap-up code,"```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.RoutingApi(); code_id = 'code_id_example' # str | Wrapup Code ID body = PureCloudPlatformClientV2.WrapupCodeRequest() # WrapupCodeRequest | WrapupCode try: # Update wrap-up code api_response = api_instance.put_routing_wrapupcode(code_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling RoutingApi->put_routing_wrapupcode: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/queues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get queues for 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.UsersApi(); user_id = 'user_id_example' # str | User ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) joined = True # bool | Is joined to the queue (optional) (default to True) division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) try: # Get queues for user api_response = api_instance.get_user_queues(user_id, page_size=page_size, page_number=page_number, joined=joined, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_queues: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/queues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Join or unjoin a set of queues for a 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = [PureCloudPlatformClientV2.UserQueue()] # list[UserQueue] | User Queues division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) try: # Join or unjoin a set of queues for a user api_response = api_instance.patch_user_queues(user_id, body, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_queues: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/queues/{queueId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Join or unjoin a queue for a 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.UsersApi(); queue_id = 'queue_id_example' # str | Queue ID user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UserQueue() # UserQueue | Queue Member try: # Join or unjoin a queue for a user api_response = api_instance.patch_user_queue(queue_id, user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_queue: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/routinglanguages Genesys Cloud Python SDK.,Genesys describes this as an API used to: List routing language for 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.UsersApi(); user_id = 'user_id_example' # str | User ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''ASC'' # str | Ascending or descending sort order (optional) (default to 'ASC') try: # List routing language for user api_response = api_instance.get_user_routinglanguages(user_id, page_size=page_size, page_number=page_number, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_routinglanguages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/{userId}/routinglanguages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add routing language to 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UserRoutingLanguagePost() # UserRoutingLanguagePost | Language try: # Add routing language to user api_response = api_instance.post_user_routinglanguages(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_user_routinglanguages: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/routinglanguages/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add bulk routing language to user. Max limit 50 languages,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID body = [PureCloudPlatformClientV2.UserRoutingLanguagePost()] # list[UserRoutingLanguagePost] | Language try: # Add bulk routing language to user. Max limit 50 languages api_response = api_instance.patch_user_routinglanguages_bulk(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_routinglanguages_bulk: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/users/{userId}/routinglanguages/{languageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove routing language from 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.UsersApi(); user_id = 'user_id_example' # str | User ID language_id = 'language_id_example' # str | languageId try: # Remove routing language from user api_instance.delete_user_routinglanguage(user_id, language_id) except ApiException as e: print(""Exception when calling UsersApi->delete_user_routinglanguage: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/routinglanguages/{languageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update routing language proficiency or state.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.UsersApi(); user_id = 'user_id_example' # str | User ID language_id = 'language_id_example' # str | languageId body = PureCloudPlatformClientV2.UserRoutingLanguage() # UserRoutingLanguage | Language try: # Update routing language proficiency or state. api_response = api_instance.patch_user_routinglanguage(user_id, language_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_routinglanguage: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/routingskills Genesys Cloud Python SDK.,Genesys describes this as an API used to: List routing skills for 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.UsersApi(); user_id = 'user_id_example' # str | User ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''ASC'' # str | Ascending or descending sort order (optional) (default to 'ASC') try: # List routing skills for user api_response = api_instance.get_user_routingskills(user_id, page_size=page_size, page_number=page_number, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_routingskills: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/{userId}/routingskills Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add routing skill to 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UserRoutingSkillPost() # UserRoutingSkillPost | Skill try: # Add routing skill to user api_response = api_instance.post_user_routingskills(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_user_routingskills: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/routingskills/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk add routing skills to 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = [PureCloudPlatformClientV2.UserRoutingSkillPost()] # list[UserRoutingSkillPost] | Skill try: # Bulk add routing skills to user api_response = api_instance.patch_user_routingskills_bulk(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_routingskills_bulk: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/routingskills/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace all routing skills assigned to a 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = [PureCloudPlatformClientV2.UserRoutingSkillPost()] # list[UserRoutingSkillPost] | Skill try: # Replace all routing skills assigned to a user api_response = api_instance.put_user_routingskills_bulk(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_routingskills_bulk: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/users/{userId}/routingskills/{skillId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove routing skill from 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.UsersApi(); user_id = 'user_id_example' # str | User ID skill_id = 'skill_id_example' # str | skillId try: # Remove routing skill from user api_instance.delete_user_routingskill(user_id, skill_id) except ApiException as e: print(""Exception when calling UsersApi->delete_user_routingskill: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/routingskills/{skillId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update routing skill proficiency or state.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.UsersApi(); user_id = 'user_id_example' # str | User ID skill_id = 'skill_id_example' # str | skillId body = PureCloudPlatformClientV2.UserRoutingSkill() # UserRoutingSkill | Skill try: # Update routing skill proficiency or state. api_response = api_instance.put_user_routingskill(user_id, skill_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_routingskill: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/skillgroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get skill groups for a 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.UsersApi(); user_id = 'user_id_example' # str | User ID page_size = 25 # int | Page size (optional) (default to 25) after = 'after_example' # str | The cursor that points to the next page (optional) before = 'before_example' # str | The cursor that points to the previous page (optional) try: # Get skill groups for a user api_response = api_instance.get_user_skillgroups(user_id, page_size=page_size, after=after, before=before) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_skillgroups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/groups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of groups,"```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.SCIMApi(); start_index = 1 # int | The 1-based index of the first query result. (optional) (default to 1) count = 25 # int | The requested number of items per page. A value of 0 returns \""totalResults\"". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \""excludedAttributes\"" or \""attributes\"" query parameters to exclude or only include secondary lookup values such as \""externalId\"", \""roles\"", \""urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\"", or \""urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\"". (optional) (default to 25) attributes = ['attributes_example'] # list[str] | Indicates which attributes to include. Returns these attributes and the \""id\"", \""active\"", and \""meta\"" attributes. Use \""attributes\"" to avoid expensive secondary calls for the default attributes. (optional) excluded_attributes = ['excluded_attributes_example'] # list[str] | Indicates which attributes to exclude. Returns the default attributes minus \""excludedAttributes\"". Always returns \""id\"", \""active\"", and \""meta\"" attributes. Use \""excludedAttributes\"" to avoid expensive secondary calls for the default attributes. (optional) filter = 'displayName eq groupName' # str | Filters results. If nothing is specified, returns all groups. Examples of valid values: \""id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\"", \""displayname eq Sales\"". (optional) try: # Get a list of groups api_response = api_instance.get_scim_groups(start_index=start_index, count=count, attributes=attributes, excluded_attributes=excluded_attributes, filter=filter) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_groups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/groups/{groupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a group,"```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.SCIMApi(); group_id = 'group_id_example' # str | The ID of a group. Returned with GET /api/v2/scim/groups. attributes = ['attributes_example'] # list[str] | Indicates which attributes to include. Returns these attributes and the \""id\"", \""active\"", and \""meta\"" attributes. Use \""attributes\"" to avoid expensive secondary calls for the default attributes. (optional) excluded_attributes = ['excluded_attributes_example'] # list[str] | Indicates which attributes to exclude. Returns the default attributes minus \""excludedAttributes\"". Always returns \""id\"", \""active\"", and \""meta\"" attributes. Use \""excludedAttributes\"" to avoid expensive secondary calls for the default attributes. (optional) if_none_match = 'if_none_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \""42\"". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional) try: # Get a group api_response = api_instance.get_scim_group(group_id, attributes=attributes, excluded_attributes=excluded_attributes, if_none_match=if_none_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_group: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/scim/groups/{groupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Modify a group,"```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.SCIMApi(); group_id = 'group_id_example' # str | The ID of a group. Returned with GET /api/v2/scim/groups. body = PureCloudPlatformClientV2.ScimV2PatchRequest() # ScimV2PatchRequest | The information used to modify a group. if_match = 'if_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \""42\"". If the ETag is different from the version on the server, returns 400 with a \""scimType\"" of \""invalidVers\"". (optional) try: # Modify a group api_response = api_instance.patch_scim_group(group_id, body, if_match=if_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->patch_scim_group: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/scim/groups/{groupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace a group,"```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.SCIMApi(); group_id = 'group_id_example' # str | The ID of a group. Returned with GET /api/v2/scim/groups. body = PureCloudPlatformClientV2.ScimV2Group() # ScimV2Group | The information used to replace a group. if_match = 'if_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \""42\"". If the ETag is different from the version on the server, returns 400 with a \""scimType\"" of \""invalidVers\"". (optional) try: # Replace a group api_response = api_instance.put_scim_group(group_id, body, if_match=if_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->put_scim_group: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/resourcetypes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of resource 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.SCIMApi(); try: # Get a list of resource types api_response = api_instance.get_scim_resourcetypes() pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_resourcetypes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/resourcetypes/{resourceType} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a resource 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.SCIMApi(); resource_type = 'resource_type_example' # str | The type of resource. Returned with GET /api/v2/scim/resourcetypes. try: # Get a resource type api_response = api_instance.get_scim_resourcetype(resource_type) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_resourcetype: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/schemas Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of SCIM schemas,"```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.SCIMApi(); filter = 'displayName eq groupName' # str | Filtered results are invalid and return 403 Unauthorized. (optional) try: # Get a list of SCIM schemas api_response = api_instance.get_scim_schemas(filter=filter) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_schemas: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/schemas/{schemaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a SCIM schema,"```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.SCIMApi(); schema_id = 'schema_id_example' # str | The ID of a schema. Returned with GET /api/v2/scim/schemas. try: # Get a SCIM schema api_response = api_instance.get_scim_schema(schema_id) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_schema: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/serviceproviderconfig Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a service provider's 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.SCIMApi(); if_none_match = 'if_none_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: \""42\"". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional) try: # Get a service provider's configuration api_response = api_instance.get_scim_serviceproviderconfig(if_none_match=if_none_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_serviceproviderconfig: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/users Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a list of users. To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to ""active eq false"". By default, returns SCIM attributes ""externalId"", ""enterprise-user:manager"", and ""roles"". To exclude these attributes, set the attributes parameter to ""id,active"" or the excludeAttributes parameter to ""externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"".","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.SCIMApi(); start_index = 1 # int | The 1-based index of the first query result. (optional) (default to 1) count = 25 # int | The requested number of items per page. A value of 0 returns \""totalResults\"". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \""excludedAttributes\"" or \""attributes\"" query parameters to exclude or only include secondary lookup values such as \""externalId\"", \""roles\"", \""urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\"", or \""urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\"". (optional) (default to 25) attributes = ['attributes_example'] # list[str] | Indicates which attributes to include. Returns these attributes and the \""id\"", \""userName\"", \""active\"", and \""meta\"" attributes. Use \""attributes\"" to avoid expensive secondary calls for the default attributes. (optional) excluded_attributes = ['excluded_attributes_example'] # list[str] | Indicates which attributes to exclude. Returns the default attributes minus \""excludedAttributes\"". Always returns the \""id\"", \""userName\"", \""active\"", and \""meta\"" attributes. Use \""excludedAttributes\"" to avoid expensive secondary calls for the default attributes. (optional) filter = 'filter_example' # str | Filters results. If nothing is specified, returns all active users. Examples of valid values: \""id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\"", \""userName eq search@sample.org\"", \""manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\"", \""email eq search@sample.org\"", \""division eq divisionName\"", \""externalId eq 167844\"", \""active eq false\"", \""employeeNumber eq 9876543210\"". (optional) try: # Get a list of users api_response = api_instance.get_scim_users(start_index=start_index, count=count, attributes=attributes, excluded_attributes=excluded_attributes, filter=filter) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_users: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/scim/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a 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.SCIMApi(); body = PureCloudPlatformClientV2.ScimV2CreateUser() # ScimV2CreateUser | The information used to create a user. try: # Create a user api_response = api_instance.post_scim_users(body) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->post_scim_users: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/scim/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a 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.SCIMApi(); user_id = 'user_id_example' # str | The ID of a user. Returned with GET /api/v2/scim/users. if_match = 'if_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \""42\"". If the ETag is different from the version on the server, returns 400 with a \""scimType\"" of \""invalidVers\"". (optional) try: # Delete a user api_response = api_instance.delete_scim_user(user_id, if_match=if_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->delete_scim_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a 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.SCIMApi(); user_id = 'user_id_example' # str | The ID of a user. Returned with GET /api/v2/scim/users. attributes = ['attributes_example'] # list[str] | Indicates which attributes to include. Returns these attributes and the \""id\"", \""userName\"", \""active\"", and \""meta\"" attributes. Use \""attributes\"" to avoid expensive secondary calls for the default attributes. (optional) excluded_attributes = ['excluded_attributes_example'] # list[str] | Indicates which attributes to exclude. Returns the default attributes minus \""excludedAttributes\"". Always returns the \""id\"", \""userName\"", \""active\"", and \""meta\"" attributes. Use \""excludedAttributes\"" to avoid expensive secondary calls for the default attributes. (optional) if_none_match = 'if_none_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \""42\"". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional) try: # Get a user api_response = api_instance.get_scim_user(user_id, attributes=attributes, excluded_attributes=excluded_attributes, if_none_match=if_none_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_user: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/scim/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Modify a 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.SCIMApi(); user_id = 'user_id_example' # str | The ID of a user. Returned with GET /api/v2/scim/users. body = PureCloudPlatformClientV2.ScimV2PatchRequest() # ScimV2PatchRequest | The information used to modify a user. if_match = 'if_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \""42\"". If the ETag is different from the version on the server, returns 400 with a \""scimType\"" of \""invalidVers\"". (optional) try: # Modify a user api_response = api_instance.patch_scim_user(user_id, body, if_match=if_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->patch_scim_user: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/scim/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace a 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.SCIMApi(); user_id = 'user_id_example' # str | The ID of a user. Returned with GET /api/v2/scim/users. body = PureCloudPlatformClientV2.ScimV2User() # ScimV2User | The information used to replace a user. if_match = 'if_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \""42\"". If the ETag is different from the version on the server, returns 400 with a \""scimType\"" of \""invalidVers\"". (optional) try: # Replace a user api_response = api_instance.put_scim_user(user_id, body, if_match=if_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->put_scim_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/v2/groups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of groups,"```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.SCIMApi(); filter = 'displayName eq groupName' # str | Filters results. If nothing is specified, returns all groups. Examples of valid values: \""id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\"", \""displayname eq Sales\"". start_index = 1 # int | The 1-based index of the first query result. (optional) (default to 1) count = 25 # int | The requested number of items per page. A value of 0 returns \""totalResults\"". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \""excludedAttributes\"" or \""attributes\"" query parameters to exclude or only include secondary lookup values such as \""externalId\"", \""roles\"", \""urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\"", or \""urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\"". (optional) (default to 25) attributes = ['attributes_example'] # list[str] | Indicates which attributes to include. Returns these attributes and the \""id\"", \""active\"", and \""meta\"" attributes. Use \""attributes\"" to avoid expensive secondary calls for the default attributes. (optional) excluded_attributes = ['excluded_attributes_example'] # list[str] | Indicates which attributes to exclude. Returns the default attributes minus \""excludedAttributes\"". Always returns \""id\"", \""active\"", and \""meta\"" attributes. Use \""excludedAttributes\"" to avoid expensive secondary calls for the default attributes. (optional) try: # Get a list of groups api_response = api_instance.get_scim_v2_groups(filter, start_index=start_index, count=count, attributes=attributes, excluded_attributes=excluded_attributes) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_v2_groups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/v2/groups/{groupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a group,"```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.SCIMApi(); group_id = 'group_id_example' # str | The ID of a group. Returned with GET /api/v2/scim/v2/groups. attributes = ['attributes_example'] # list[str] | Indicates which attributes to include. Returns these attributes and the \""id\"", \""active\"", and \""meta\"" attributes. Use \""attributes\"" to avoid expensive secondary calls for the default attributes. (optional) excluded_attributes = ['excluded_attributes_example'] # list[str] | Indicates which attributes to exclude. Returns the default attributes minus \""excludedAttributes\"". Always returns \""id\"", \""active\"", and \""meta\"" attributes. Use \""excludedAttributes\"" to avoid expensive secondary calls for the default attributes. (optional) if_none_match = 'if_none_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \""42\"". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional) try: # Get a group api_response = api_instance.get_scim_v2_group(group_id, attributes=attributes, excluded_attributes=excluded_attributes, if_none_match=if_none_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_v2_group: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/scim/v2/groups/{groupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Modify a group,"```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.SCIMApi(); group_id = 'group_id_example' # str | The ID of a group. Returned with GET /api/v2/scim/v2/groups. body = PureCloudPlatformClientV2.ScimV2PatchRequest() # ScimV2PatchRequest | The information used to modify a group. if_match = 'if_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \""42\"". If the ETag is different from the version on the server, returns 400 with a \""scimType\"" of \""invalidVers\"". (optional) try: # Modify a group api_response = api_instance.patch_scim_v2_group(group_id, body, if_match=if_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->patch_scim_v2_group: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/scim/v2/groups/{groupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace a group,"```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.SCIMApi(); group_id = 'group_id_example' # str | The ID of a group. Returned with GET /api/v2/scim/v2/groups. body = PureCloudPlatformClientV2.ScimV2Group() # ScimV2Group | The information used to replace a group. if_match = 'if_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \""42\"". If the ETag is different from the version on the server, returns 400 with a \""scimType\"" of \""invalidVers\"". (optional) try: # Replace a group api_response = api_instance.put_scim_v2_group(group_id, body, if_match=if_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->put_scim_v2_group: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/v2/resourcetypes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of resource 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.SCIMApi(); try: # Get a list of resource types api_response = api_instance.get_scim_v2_resourcetypes() pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_v2_resourcetypes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/v2/resourcetypes/{resourceType} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a resource 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.SCIMApi(); resource_type = 'resource_type_example' # str | The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes. try: # Get a resource type api_response = api_instance.get_scim_v2_resourcetype(resource_type) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_v2_resourcetype: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/v2/schemas Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of SCIM schemas,"```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.SCIMApi(); filter = 'displayName eq groupName' # str | Filtered results are invalid and return 403 Unauthorized. (optional) try: # Get a list of SCIM schemas api_response = api_instance.get_scim_v2_schemas(filter=filter) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_v2_schemas: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/v2/schemas/{schemaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a SCIM schema,"```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.SCIMApi(); schema_id = 'schema_id_example' # str | The ID of a schema. Returned with GET /api/v2/scim/v2/schemas. try: # Get a SCIM schema api_response = api_instance.get_scim_v2_schema(schema_id) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_v2_schema: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/v2/serviceproviderconfig Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a service provider's 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.SCIMApi(); if_none_match = 'if_none_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example: \""42\"". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional) try: # Get a service provider's configuration api_response = api_instance.get_scim_v2_serviceproviderconfig(if_none_match=if_none_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_v2_serviceproviderconfig: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/v2/users Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a list of users. To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to ""active eq false"". By default, returns SCIM attributes ""externalId"", ""enterprise-user:manager"", and ""roles"". To exclude these attributes, set the attributes parameter to ""id,active"" or the excludeAttributes parameter to ""externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division"".","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.SCIMApi(); start_index = 1 # int | The 1-based index of the first query result. (optional) (default to 1) count = 25 # int | The requested number of items per page. A value of 0 returns \""totalResults\"". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \""excludedAttributes\"" or \""attributes\"" query parameters to exclude or only include secondary lookup values such as \""externalId\"", \""roles\"", \""urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\"", or \""urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\"". (optional) (default to 25) attributes = ['attributes_example'] # list[str] | Indicates which attributes to include. Returns these attributes and the \""id\"", \""userName\"", \""active\"", and \""meta\"" attributes. Use \""attributes\"" to avoid expensive secondary calls for the default attributes. (optional) excluded_attributes = ['excluded_attributes_example'] # list[str] | Indicates which attributes to exclude. Returns the default attributes minus \""excludedAttributes\"". Always returns the \""id\"", \""userName\"", \""active\"", and \""meta\"" attributes. Use \""excludedAttributes\"" to avoid expensive secondary calls for the default attributes. (optional) filter = 'filter_example' # str | Filters results. If nothing is specified, returns all active users. Examples of valid values: \""id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\"", \""userName eq search@sample.org\"", \""manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\"", \""email eq search@sample.org\"", \""division eq divisionName\"", \""externalId eq 167844\"", \""active eq false\"", \""employeeNumber eq 9876543210\"". (optional) try: # Get a list of users api_response = api_instance.get_scim_v2_users(start_index=start_index, count=count, attributes=attributes, excluded_attributes=excluded_attributes, filter=filter) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_v2_users: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/scim/v2/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a 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.SCIMApi(); body = PureCloudPlatformClientV2.ScimV2CreateUser() # ScimV2CreateUser | The information used to create a user. try: # Create a user api_response = api_instance.post_scim_v2_users(body) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->post_scim_v2_users: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/scim/v2/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a 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.SCIMApi(); user_id = 'user_id_example' # str | The ID of a user. Returned with GET /api/v2/scim/v2/users. if_match = 'if_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \""42\"". If the ETag is different from the version on the server, returns 400 with a \""scimType\"" of \""invalidVers\"". (optional) try: # Delete a user api_response = api_instance.delete_scim_v2_user(user_id, if_match=if_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->delete_scim_v2_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scim/v2/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a 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.SCIMApi(); user_id = 'user_id_example' # str | The ID of a user. Returned with GET /api/v2/scim/v2/users. attributes = ['attributes_example'] # list[str] | Indicates which attributes to include. Returns these attributes and the \""id\"", \""userName\"", \""active\"", and \""meta\"" attributes. Use \""attributes\"" to avoid expensive secondary calls for the default attributes. (optional) excluded_attributes = ['excluded_attributes_example'] # list[str] | Indicates which attributes to exclude. Returns the default attributes minus \""excludedAttributes\"". Always returns the \""id\"", \""userName\"", \""active\"", and \""meta\"" attributes. Use \""excludedAttributes\"" to avoid expensive secondary calls for the default attributes. (optional) if_none_match = 'if_none_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \""42\"". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional) try: # Get a user api_response = api_instance.get_scim_v2_user(user_id, attributes=attributes, excluded_attributes=excluded_attributes, if_none_match=if_none_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->get_scim_v2_user: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/scim/v2/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Modify a 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.SCIMApi(); user_id = 'user_id_example' # str | The ID of a user. Returned with GET /api/v2/scim/v2/users. body = PureCloudPlatformClientV2.ScimV2PatchRequest() # ScimV2PatchRequest | The information used to modify a user. if_match = 'if_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \""42\"". If the ETag is different from the version on the server, returns 400 with a \""scimType\"" of \""invalidVers\"". (optional) try: # Modify a user api_response = api_instance.patch_scim_v2_user(user_id, body, if_match=if_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->patch_scim_v2_user: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/scim/v2/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace a 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.SCIMApi(); user_id = 'user_id_example' # str | The ID of a user. Returned with GET /api/v2/scim/v2/users. body = PureCloudPlatformClientV2.ScimV2User() # ScimV2User | The information used to replace a user. if_match = 'if_match_example' # str | The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \""42\"". If the ETag is different from the version on the server, returns 400 with a \""scimType\"" of \""invalidVers\"". (optional) try: # Replace a user api_response = api_instance.put_scim_v2_user(user_id, body, if_match=if_match) pprint(api_response) except ApiException as e: print(""Exception when calling SCIMApi->put_scim_v2_user: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/screenrecording/token Genesys Cloud Python SDK.,Genesys describes this as an API used to: Sign identifying information for screen recording,"```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.ScreenRecordingApi(); body = PureCloudPlatformClientV2.ScreenRecordingUserAuthenticatedInfo() # ScreenRecordingUserAuthenticatedInfo | (optional) try: # Sign identifying information for screen recording api_response = api_instance.post_screenrecording_token(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ScreenRecordingApi->post_screenrecording_token: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of scripts,"```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.ScriptsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = 'expand_example' # str | Expand (optional) name = 'name_example' # str | Name filter (optional) feature = 'feature_example' # str | Feature filter (optional) flow_id = 'flow_id_example' # str | Secure flow id filter (optional) sort_by = 'sort_by_example' # str | SortBy (optional) sort_order = 'sort_order_example' # str | SortOrder (optional) script_data_version = 'script_data_version_example' # str | Advanced usage - controls the data version of the script (optional) division_ids = 'division_ids_example' # str | Filters scripts to requested divisionIds (optional) try: # Get the list of scripts api_response = api_instance.get_scripts(page_size=page_size, page_number=page_number, expand=expand, name=name, feature=feature, flow_id=flow_id, sort_by=sort_by, sort_order=sort_order, script_data_version=script_data_version, division_ids=division_ids) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_scripts: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts/divisionviews Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the metadata for a list of scripts,"```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.ScriptsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = 'expand_example' # str | Expand (optional) name = 'name_example' # str | Name filter (optional) feature = 'feature_example' # str | Feature filter (optional) flow_id = 'flow_id_example' # str | Secure flow id filter (optional) sort_by = 'sort_by_example' # str | SortBy (optional) sort_order = 'sort_order_example' # str | SortOrder (optional) script_data_version = 'script_data_version_example' # str | Advanced usage - controls the data version of the script (optional) division_ids = 'division_ids_example' # str | Filters scripts to requested divisionIds (optional) try: # Get the metadata for a list of scripts api_response = api_instance.get_scripts_divisionviews(page_size=page_size, page_number=page_number, expand=expand, name=name, feature=feature, flow_id=flow_id, sort_by=sort_by, sort_order=sort_order, script_data_version=script_data_version, division_ids=division_ids) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_scripts_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts/published Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the published scripts.,"```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.ScriptsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = 'expand_example' # str | Expand (optional) name = 'name_example' # str | Name filter (optional) feature = 'feature_example' # str | Feature filter (optional) flow_id = 'flow_id_example' # str | Secure flow id filter (optional) script_data_version = 'script_data_version_example' # str | Advanced usage - controls the data version of the script (optional) division_ids = 'division_ids_example' # str | Filters scripts to requested divisionIds (optional) try: # Get the published scripts. api_response = api_instance.get_scripts_published(page_size=page_size, page_number=page_number, expand=expand, name=name, feature=feature, flow_id=flow_id, script_data_version=script_data_version, division_ids=division_ids) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_scripts_published: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/scripts/published Genesys Cloud Python SDK.,Genesys describes this as an API used to: Publish a script.,"```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.ScriptsApi(); script_data_version = 'script_data_version_example' # str | Advanced usage - controls the data version of the script (optional) body = PureCloudPlatformClientV2.PublishScriptRequestData() # PublishScriptRequestData | body (optional) try: # Publish a script. api_response = api_instance.post_scripts_published(script_data_version=script_data_version, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->post_scripts_published: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts/published/divisionviews Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the published scripts metadata.,"```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.ScriptsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = 'expand_example' # str | Expand (optional) name = 'name_example' # str | Name filter (optional) feature = 'feature_example' # str | Feature filter (optional) flow_id = 'flow_id_example' # str | Secure flow id filter (optional) script_data_version = 'script_data_version_example' # str | Advanced usage - controls the data version of the script (optional) division_ids = 'division_ids_example' # str | Filters scripts to requested divisionIds (optional) try: # Get the published scripts metadata. api_response = api_instance.get_scripts_published_divisionviews(page_size=page_size, page_number=page_number, expand=expand, name=name, feature=feature, flow_id=flow_id, script_data_version=script_data_version, division_ids=division_ids) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_scripts_published_divisionviews: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts/published/{scriptId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the published script.,"```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.ScriptsApi(); script_id = 'script_id_example' # str | Script ID script_data_version = 'script_data_version_example' # str | Advanced usage - controls the data version of the script (optional) try: # Get the list of published pages api_response = api_instance.get_scripts_published_script_id_pages(script_id, script_data_version=script_data_version) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_scripts_published_script_id_pages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts/published/{scriptId}/pages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of published pages,"```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.ScriptsApi(); script_id = 'script_id_example' # str | Script ID page_id = 'page_id_example' # str | Page ID script_data_version = 'script_data_version_example' # str | Advanced usage - controls the data version of the script (optional) try: # Get the published page. api_response = api_instance.get_scripts_published_script_id_page(script_id, page_id, script_data_version=script_data_version) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_scripts_published_script_id_page: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts/published/{scriptId}/pages/{pageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the published page.,"```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.ScriptsApi(); script_id = 'script_id_example' # str | Script ID input = 'input_example' # str | input (optional) output = 'output_example' # str | output (optional) type = 'type_example' # str | type (optional) script_data_version = 'script_data_version_example' # str | Advanced usage - controls the data version of the script (optional) try: # Get the published variables api_response = api_instance.get_scripts_published_script_id_variables(script_id, input=input, output=output, type=type, script_data_version=script_data_version) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_scripts_published_script_id_variables: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts/published/{scriptId}/variables Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the published variables,"```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.ScriptsApi(); upload_id = 'upload_id_example' # str | Upload ID long_poll = False # bool | Enable longPolling endpoint (optional) (default to False) try: # Get the upload status of an imported script api_response = api_instance.get_scripts_upload_status(upload_id, long_poll=long_poll) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_scripts_upload_status: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts/uploads/{uploadId}/status Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the upload status of an imported script,"```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.ScriptsApi(); script_id = 'script_id_example' # str | Script ID try: # Get a script api_response = api_instance.get_script(script_id) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_script: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts/{scriptId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a script,"```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.ScriptsApi(); script_id = 'script_id_example' # str | Script ID body = PureCloudPlatformClientV2.ExportScriptRequest() # ExportScriptRequest | (optional) try: # Export a script via download service. api_response = api_instance.post_script_export(script_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->post_script_export: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/scripts/{scriptId}/export Genesys Cloud Python SDK.,Genesys describes this as an API used to: Export a script via download service.,"```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.ScriptsApi(); script_id = 'script_id_example' # str | Script ID script_data_version = 'script_data_version_example' # str | Advanced usage - controls the data version of the script (optional) try: # Get the list of pages api_response = api_instance.get_script_pages(script_id, script_data_version=script_data_version) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_script_pages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/scripts/{scriptId}/pages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of pages,"```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.ScriptsApi(); script_id = 'script_id_example' # str | Script ID page_id = 'page_id_example' # str | Page ID script_data_version = 'script_data_version_example' # str | Advanced usage - controls the data version of the script (optional) try: # Get a page api_response = api_instance.get_script_page(script_id, page_id, script_data_version=script_data_version) pprint(api_response) except ApiException as e: print(""Exception when calling ScriptsApi->get_script_page: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/conversations/transcripts/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search resources.,"```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.SearchApi(); body = PureCloudPlatformClientV2.TranscriptConversationDetailSearchRequest() # TranscriptConversationDetailSearchRequest | Search request options try: # Search resources. api_response = api_instance.post_analytics_conversations_transcripts_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->post_analytics_conversations_transcripts_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/conversations/participants/attributes/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search conversations,"```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.SearchApi(); body = PureCloudPlatformClientV2.ConversationParticipantSearchRequest() # ConversationParticipantSearchRequest | Search request options try: # Search conversations api_response = api_instance.post_conversations_participants_attributes_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->post_conversations_participants_attributes_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/documentation/gkn/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search gkn documentation using the q64 value returned from a previous search,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.SearchApi(); q64 = 'q64_example' # str | q64 try: # Search gkn documentation using the q64 value returned from a previous search api_response = api_instance.get_documentation_gkn_search(q64) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->get_documentation_gkn_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/documentation/gkn/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search gkn documentation,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.SearchApi(); body = PureCloudPlatformClientV2.GKNDocumentationSearchRequest() # GKNDocumentationSearchRequest | Search request options try: # Search gkn documentation api_response = api_instance.post_documentation_gkn_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->post_documentation_gkn_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/documentation/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search documentation using the q64 value returned from a previous search,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.SearchApi(); q64 = 'q64_example' # str | q64 try: # Search documentation using the q64 value returned from a previous search api_response = api_instance.get_documentation_search(q64) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->get_documentation_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/documentation/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search documentation,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.SearchApi(); body = PureCloudPlatformClientV2.DocumentationSearchRequest() # DocumentationSearchRequest | Search request options try: # Search documentation api_response = api_instance.post_documentation_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->post_documentation_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/groups/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search groups using the q64 value returned from a previous search,"```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.SearchApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | expand (optional) try: # Search groups using the q64 value returned from a previous search api_response = api_instance.get_groups_search(q64, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->get_groups_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/groups/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search groups,"```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.SearchApi(); body = PureCloudPlatformClientV2.GroupSearchRequest() # GroupSearchRequest | Search request options try: # Search groups api_response = api_instance.post_groups_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->post_groups_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/locations/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search locations using the q64 value returned from a previous search,"```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.SearchApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | Provides more details about a specified resource (optional) try: # Search locations using the q64 value returned from a previous search api_response = api_instance.get_locations_search(q64, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->get_locations_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/locations/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search locations,"```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.SearchApi(); body = PureCloudPlatformClientV2.LocationSearchRequest() # LocationSearchRequest | Search request options try: # Search locations api_response = api_instance.post_locations_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling SearchApi->post_locations_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search using the q64 value returned from a previous search.,"```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.SuggestApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) profile = True # bool | profile (optional) (default to True) try: # Search using the q64 value returned from a previous search. api_response = api_instance.get_search(q64, expand=expand, profile=profile) pprint(api_response) except ApiException as e: print(""Exception when calling SuggestApi->get_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search resources.,"```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.SuggestApi(); body = PureCloudPlatformClientV2.SearchRequest() # SearchRequest | Search request options profile = True # bool | profile (optional) (default to True) try: # Search resources. api_response = api_instance.post_search(body, profile=profile) pprint(api_response) except ApiException as e: print(""Exception when calling SuggestApi->post_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/search/suggest Genesys Cloud Python SDK.,Genesys describes this as an API used to: Suggest resources using the q64 value returned from a previous suggest query.,"```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.SuggestApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) profile = True # bool | profile (optional) (default to True) try: # Suggest resources using the q64 value returned from a previous suggest query. api_response = api_instance.get_search_suggest(q64, expand=expand, profile=profile) pprint(api_response) except ApiException as e: print(""Exception when calling SuggestApi->get_search_suggest: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/search/suggest Genesys Cloud Python SDK.,Genesys describes this as an API used to: Suggest resources.,"```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.SuggestApi(); body = PureCloudPlatformClientV2.SuggestSearchRequest() # SuggestSearchRequest | Search request options profile = True # bool | profile (optional) (default to True) try: # Suggest resources. api_response = api_instance.post_search_suggest(body, profile=profile) pprint(api_response) except ApiException as e: print(""Exception when calling SuggestApi->post_search_suggest: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/speechandtextanalytics/transcripts/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search resources.,"```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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.TranscriptSearchRequest() # TranscriptSearchRequest | Search request options try: # Search resources. api_response = api_instance.post_speechandtextanalytics_transcripts_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_transcripts_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/teams/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search resources.,"```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.TeamsApi(); body = PureCloudPlatformClientV2.TeamSearchRequest() # TeamSearchRequest | Search request options try: # Search resources. api_response = api_instance.post_teams_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling TeamsApi->post_teams_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search users using the q64 value returned from a previous search,"```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.UsersApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | expand (optional) integration_presence_source = 'integration_presence_source_example' # str | integrationPresenceSource (optional) try: # Search users using the q64 value returned from a previous search api_response = api_instance.get_users_search(q64, expand=expand, integration_presence_source=integration_presence_source) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_users_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search users,"```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.UsersApi(); body = PureCloudPlatformClientV2.UserSearchRequest() # UserSearchRequest | Search request options try: # Search users api_response = api_instance.post_users_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_users_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/search/teams/assign Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search users assigned to teams,"```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.UsersApi(); body = PureCloudPlatformClientV2.UserSearchRequest() # UserSearchRequest | Search request options try: # Search users assigned to teams api_response = api_instance.post_users_search_teams_assign(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_users_search_teams_assign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search voicemails using the q64 value returned from a previous search,"```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.VoicemailApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | expand (optional) try: # Search voicemails using the q64 value returned from a previous search api_response = api_instance.get_voicemail_search(q64, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/voicemail/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search voicemails,"```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.VoicemailApi(); body = PureCloudPlatformClientV2.VoicemailSearchRequest() # VoicemailSearchRequest | Search request options try: # Search voicemails api_response = api_instance.post_voicemail_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->post_voicemail_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/emails/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get email Contact Center settings,"```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.SettingsApi(); try: # Get email Contact Center settings api_response = api_instance.get_emails_settings() pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->get_emails_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/emails/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch email Contact Center settings,"```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.SettingsApi(); body = PureCloudPlatformClientV2.EmailSettings() # EmailSettings | (optional) try: # Patch email Contact Center settings api_response = api_instance.patch_emails_settings(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->patch_emails_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/settings/executiondata Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the execution history enabled setting. Get the execution history enabled setting.,"```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.SettingsApi(); try: # Get the execution history enabled setting. api_response = api_instance.get_settings_executiondata() pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->get_settings_executiondata: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/settings/executiondata Genesys Cloud Python SDK.,Genesys describes this as an API used to: Edit the execution history on off setting. Edit the execution history on off setting.,"```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.SettingsApi(); body = PureCloudPlatformClientV2.ExecutionDataSettingsRequest() # ExecutionDataSettingsRequest | New Execution Data Setting try: # Edit the execution history on off setting. api_response = api_instance.patch_settings_executiondata(body) pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->patch_settings_executiondata: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete agent auto answer settings,"```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.SettingsApi(); agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to try: # Delete agent auto answer settings api_instance.delete_users_agentui_agents_autoanswer_agent_id_settings(agent_id) except ApiException as e: print(""Exception when calling SettingsApi->delete_users_agentui_agents_autoanswer_agent_id_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get agent auto answer settings,"```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.SettingsApi(); agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to try: # Get agent auto answer settings api_response = api_instance.get_users_agentui_agents_autoanswer_agent_id_settings(agent_id) pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->get_users_agentui_agents_autoanswer_agent_id_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update agent auto answer settings,"```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.SettingsApi(); agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to body = PureCloudPlatformClientV2.AutoAnswerSettings() # AutoAnswerSettings | AutoAnswerSettings try: # Update agent auto answer settings api_response = api_instance.patch_users_agentui_agents_autoanswer_agent_id_settings(agent_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->patch_users_agentui_agents_autoanswer_agent_id_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set agent auto answer settings,"```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.SettingsApi(); agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to body = PureCloudPlatformClientV2.AutoAnswerSettings() # AutoAnswerSettings | AutoAnswerSettings try: # Set agent auto answer settings api_response = api_instance.put_users_agentui_agents_autoanswer_agent_id_settings(agent_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling SettingsApi->put_users_agentui_agents_autoanswer_agent_id_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/categories Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of Speech and Text Analytics categories,"```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.SpeechTextAnalyticsApi(); page_size = 25 # int | The page size for the listing. The max that will be returned is 50. (optional) (default to 25) page_number = 1 # int | The page number for the listing (optional) (default to 1) name = 'name_example' # str | The category name filter applied to the listing (optional) sort_order = ''asc'' # str | The sort order for the listing (optional) (default to 'asc') sort_by = ''name'' # str | The field to sort by for the listing (optional) (default to 'name') ids = ['ids_example'] # list[str] | Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. (optional) try: # Get the list of Speech and Text Analytics categories api_response = api_instance.get_speechandtextanalytics_categories(page_size=page_size, page_number=page_number, name=name, sort_order=sort_order, sort_by=sort_by, ids=ids) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_categories: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/speechandtextanalytics/categories Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create new Speech & Text Analytics category,"```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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.CategoryRequest() # CategoryRequest | The category to create try: # Create new Speech & Text Analytics category api_response = api_instance.post_speechandtextanalytics_categories(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_categories: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/categories/{categoryId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Speech & Text Analytics category by 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.SpeechTextAnalyticsApi(); category_id = 'category_id_example' # str | The id of the category try: # Delete a Speech & Text Analytics category by ID api_instance.delete_speechandtextanalytics_category(category_id) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_category: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/categories/{categoryId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Speech & Text Analytics Category by 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.SpeechTextAnalyticsApi(); category_id = 'category_id_example' # str | The id of the category try: # Get a Speech & Text Analytics Category by ID api_response = api_instance.get_speechandtextanalytics_category(category_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_category: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/categories/{categoryId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Speech & Text Analytics category by 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.SpeechTextAnalyticsApi(); category_id = 'category_id_example' # str | The id of the category body = PureCloudPlatformClientV2.CategoryRequest() # CategoryRequest | The updated category try: # Update a Speech & Text Analytics category by ID api_response = api_instance.put_speechandtextanalytics_category(category_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_category: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/conversations/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Speech and Text Analytics for a specific conversation,"```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.SpeechTextAnalyticsApi(); conversation_id = 'conversation_id_example' # str | Conversation Id try: # Get Speech and Text Analytics for a specific conversation api_response = api_instance.get_speechandtextanalytics_conversation(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/conversations/{conversationId}/categories Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of detected Speech and Text Analytics categories of conversation,"```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.SpeechTextAnalyticsApi(); conversation_id = 'conversation_id_example' # str | The id of the conversation page_size = 25 # int | The page size for the listing. The max that will be returned is 50. (optional) (default to 25) page_number = 1 # int | The page number for the listing (optional) (default to 1) try: # Get the list of detected Speech and Text Analytics categories of conversation api_response = api_instance.get_speechandtextanalytics_conversation_categories(conversation_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation_categories: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the pre-signed S3 URL for the transcript of a specific communication of a conversation,"```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.SpeechTextAnalyticsApi(); conversation_id = 'conversation_id_example' # str | Conversation ID communication_id = 'communication_id_example' # str | Communication ID try: # Get the pre-signed S3 URL for the transcript of a specific communication of a conversation api_response = api_instance.get_speechandtextanalytics_conversation_communication_transcripturl(conversation_id, communication_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation_communication_transcripturl: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation,"```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.SpeechTextAnalyticsApi(); conversation_id = 'conversation_id_example' # str | Conversation ID communication_id = 'communication_id_example' # str | Communication ID try: # Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation api_response = api_instance.get_speechandtextanalytics_conversation_communication_transcripturls(conversation_id, communication_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation_communication_transcripturls: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/dictionaryfeedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of Speech & Text Analytics dictionary feedbacks,"```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.SpeechTextAnalyticsApi(); dialect = 'en-US' # str | The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard (optional) next_page = 'next_page_example' # str | The key for listing the next page (optional) page_size = 500 # int | The page size for the listing (optional) (default to 500) try: # Get the list of Speech & Text Analytics dictionary feedbacks api_response = api_instance.get_speechandtextanalytics_dictionaryfeedback(dialect=dialect, next_page=next_page, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_dictionaryfeedback: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/speechandtextanalytics/dictionaryfeedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Speech & Text Analytics DictionaryFeedback,"```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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.DictionaryFeedback() # DictionaryFeedback | The DictionaryFeedback to create try: # Create a Speech & Text Analytics DictionaryFeedback api_response = api_instance.post_speechandtextanalytics_dictionaryfeedback(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_dictionaryfeedback: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Speech & Text Analytics DictionaryFeedback by 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.SpeechTextAnalyticsApi(); dictionary_feedback_id = 'dictionary_feedback_id_example' # str | The Id of the Dictionary Feedback try: # Delete a Speech & Text Analytics DictionaryFeedback by Id api_instance.delete_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id(dictionary_feedback_id) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Speech & Text Analytics dictionary feedback by 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.SpeechTextAnalyticsApi(); dictionary_feedback_id = 'dictionary_feedback_id_example' # str | The Id of the Dictionary Feedback try: # Get a Speech & Text Analytics dictionary feedback by id api_response = api_instance.get_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id(dictionary_feedback_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update existing Speech & Text Analytics dictionary feedback by 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.SpeechTextAnalyticsApi(); dictionary_feedback_id = 'dictionary_feedback_id_example' # str | The Id of the Dictionary Feedback body = PureCloudPlatformClientV2.DictionaryFeedback() # DictionaryFeedback | (optional) try: # Update existing Speech & Text Analytics dictionary feedback by id api_response = api_instance.put_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id(dictionary_feedback_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of Speech & Text Analytics programs,"```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.SpeechTextAnalyticsApi(); next_page = 'next_page_example' # str | The key for listing the next page (optional) page_size = 20 # int | The page size for the listing (optional) (default to 20) state = 'state_example' # str | Program state. Defaults to Latest (optional) try: # Get the list of Speech & Text Analytics programs api_response = api_instance.get_speechandtextanalytics_programs(next_page=next_page, page_size=page_size, state=state) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/speechandtextanalytics/programs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create new Speech & Text Analytics program,"```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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.ProgramRequest() # ProgramRequest | The program to create try: # Create new Speech & Text Analytics program api_response = api_instance.post_speechandtextanalytics_programs(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_programs: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/speechandtextanalytics/programs/general/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create new Speech & Text Analytics general program 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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.GeneralProgramJobRequest() # GeneralProgramJobRequest | The general programs job to create try: # Create new Speech & Text Analytics general program job api_response = api_instance.post_speechandtextanalytics_programs_general_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_programs_general_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/general/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Speech & Text Analytics general program job by 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.SpeechTextAnalyticsApi(); job_id = 'job_id_example' # str | The id of the publish programs job try: # Get a Speech & Text Analytics general program job by id api_response = api_instance.get_speechandtextanalytics_programs_general_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs_general_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/mappings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of Speech & Text Analytics programs mappings to queues and flows,"```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.SpeechTextAnalyticsApi(); next_page = 'next_page_example' # str | The key for listing the next page (optional) page_size = 20 # int | The page size for the listing (optional) (default to 20) try: # Get the list of Speech & Text Analytics programs mappings to queues and flows api_response = api_instance.get_speechandtextanalytics_programs_mappings(next_page=next_page, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs_mappings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/speechandtextanalytics/programs/publishjobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create new Speech & Text Analytics publish programs 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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.ProgramJobRequest() # ProgramJobRequest | The publish programs job to create try: # Create new Speech & Text Analytics publish programs job api_response = api_instance.post_speechandtextanalytics_programs_publishjobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_programs_publishjobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/publishjobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Speech & Text Analytics publish programs job by 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.SpeechTextAnalyticsApi(); job_id = 'job_id_example' # str | The id of the publish programs job try: # Get a Speech & Text Analytics publish programs job by id api_response = api_instance.get_speechandtextanalytics_programs_publishjob(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs_publishjob: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/transcriptionengines/dialects Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get supported dialects for each transcription 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.SpeechTextAnalyticsApi(); try: # Get supported dialects for each transcription engine api_response = api_instance.get_speechandtextanalytics_programs_transcriptionengines_dialects() pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs_transcriptionengines_dialects: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/unpublished Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of Speech & Text Analytics unpublished programs,"```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.SpeechTextAnalyticsApi(); next_page = 'next_page_example' # str | The key for listing the next page (optional) page_size = 20 # int | The page size for the listing (optional) (default to 20) try: # Get the list of Speech & Text Analytics unpublished programs api_response = api_instance.get_speechandtextanalytics_programs_unpublished(next_page=next_page, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs_unpublished: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/programs/{programId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Speech & Text Analytics program by 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.SpeechTextAnalyticsApi(); program_id = 'program_id_example' # str | The id of the program force_delete = False # bool | Indicates whether the program is forced to be deleted or not. Required when the program to delete is the default program. (optional) (default to False) try: # Delete a Speech & Text Analytics program by id api_response = api_instance.delete_speechandtextanalytics_program(program_id, force_delete=force_delete) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_program: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/{programId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Speech & Text Analytics program by 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.SpeechTextAnalyticsApi(); program_id = 'program_id_example' # str | The id of the program try: # Get a Speech & Text Analytics program by id api_response = api_instance.get_speechandtextanalytics_program(program_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_program: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/programs/{programId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update existing Speech & Text Analytics program,"```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.SpeechTextAnalyticsApi(); program_id = 'program_id_example' # str | The id of the program body = PureCloudPlatformClientV2.ProgramRequest() # ProgramRequest | The program to update try: # Update existing Speech & Text Analytics program api_response = api_instance.put_speechandtextanalytics_program(program_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_program: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/{programId}/mappings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Speech & Text Analytics program mappings to queues and flows by 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.SpeechTextAnalyticsApi(); program_id = 'program_id_example' # str | The id of the program try: # Get Speech & Text Analytics program mappings to queues and flows by id api_response = api_instance.get_speechandtextanalytics_program_mappings(program_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_program_mappings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/programs/{programId}/mappings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set Speech & Text Analytics program mappings to queues and flows,"```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.SpeechTextAnalyticsApi(); program_id = 'program_id_example' # str | The id of the program body = PureCloudPlatformClientV2.ProgramMappingsRequest() # ProgramMappingsRequest | The program to set mappings for try: # Set Speech & Text Analytics program mappings to queues and flows api_response = api_instance.put_speechandtextanalytics_program_mappings(program_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_program_mappings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get transcription engine settings of a program,"```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.SpeechTextAnalyticsApi(); program_id = 'program_id_example' # str | The id of the program try: # Get transcription engine settings of a program api_response = api_instance.get_speechandtextanalytics_program_transcriptionengines(program_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_program_transcriptionengines: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update transcription engine settings of a program,"```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.SpeechTextAnalyticsApi(); program_id = 'program_id_example' # str | The id of the program body = PureCloudPlatformClientV2.TranscriptionEnginesRequest() # TranscriptionEnginesRequest | Program transcription engine setting try: # Update transcription engine settings of a program api_response = api_instance.put_speechandtextanalytics_program_transcriptionengines(program_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_program_transcriptionengines: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/sentiment/dialects Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of Speech & Text Analytics sentiment supported dialects,"```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.SpeechTextAnalyticsApi(); try: # Get the list of Speech & Text Analytics sentiment supported dialects api_response = api_instance.get_speechandtextanalytics_sentiment_dialects() pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_sentiment_dialects: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/sentimentfeedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete All Speech & Text Analytics SentimentFeedback,"```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.SpeechTextAnalyticsApi(); try: # Delete All Speech & Text Analytics SentimentFeedback api_instance.delete_speechandtextanalytics_sentimentfeedback() except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_sentimentfeedback: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/sentimentfeedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of Speech & Text Analytics SentimentFeedback,"```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.SpeechTextAnalyticsApi(); dialect = 'en-US' # str | The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard (optional) try: # Get the list of Speech & Text Analytics SentimentFeedback api_response = api_instance.get_speechandtextanalytics_sentimentfeedback(dialect=dialect) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_sentimentfeedback: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/speechandtextanalytics/sentimentfeedback Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Speech & Text Analytics SentimentFeedback,"```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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.SentimentFeedback() # SentimentFeedback | The SentimentFeedback to create try: # Create a Speech & Text Analytics SentimentFeedback api_response = api_instance.post_speechandtextanalytics_sentimentfeedback(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_sentimentfeedback: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Speech & Text Analytics SentimentFeedback by 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.SpeechTextAnalyticsApi(); sentiment_feedback_id = 'sentiment_feedback_id_example' # str | The Id of the SentimentFeedback try: # Delete a Speech & Text Analytics SentimentFeedback by Id api_instance.delete_speechandtextanalytics_sentimentfeedback_sentiment_feedback_id(sentiment_feedback_id) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_sentimentfeedback_sentiment_feedback_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Speech And Text Analytics Settings,"```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.SpeechTextAnalyticsApi(); try: # Get Speech And Text Analytics Settings api_response = api_instance.get_speechandtextanalytics_settings() pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/speechandtextanalytics/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch Speech And Text Analytics Settings,"```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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.SpeechTextAnalyticsSettingsRequest() # SpeechTextAnalyticsSettingsRequest | Speech And Text Analytics Settings try: # Patch Speech And Text Analytics Settings api_response = api_instance.patch_speechandtextanalytics_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->patch_speechandtextanalytics_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update Speech And Text Analytics Settings,"```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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.SpeechTextAnalyticsSettingsRequest() # SpeechTextAnalyticsSettingsRequest | Speech And Text Analytics Settings try: # Update Speech And Text Analytics Settings api_response = api_instance.put_speechandtextanalytics_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of Speech & Text Analytics topics,"```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.SpeechTextAnalyticsApi(); next_page = 'next_page_example' # str | The key for listing the next page (optional) page_size = 20 # int | The page size for the listing. The max that will be returned is 500. (optional) (default to 20) state = 'state_example' # str | Topic state. Defaults to latest (optional) name = 'name_example' # str | Case insensitive partial name to filter by (optional) ids = ['ids_example'] # list[str] | Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. (optional) dialects = ['dialects_example'] # list[str] | Comma separated dialect strings to filter by. Maximum of 15 dialects allowed. (optional) sort_by = 'sort_by_example' # str | Sort results by. Defaults to name (optional) sort_order = 'sort_order_example' # str | Sort order. Defaults to asc (optional) try: # Get the list of Speech & Text Analytics topics api_response = api_instance.get_speechandtextanalytics_topics(next_page=next_page, page_size=page_size, state=state, name=name, ids=ids, dialects=dialects, sort_by=sort_by, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topics: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/speechandtextanalytics/topics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create new Speech & Text Analytics topic,"```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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.TopicRequest() # TopicRequest | The topic to create try: # Create new Speech & Text Analytics topic api_response = api_instance.post_speechandtextanalytics_topics(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_topics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics/dialects Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of supported Speech & Text Analytics topics dialects,"```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.SpeechTextAnalyticsApi(); try: # Get list of supported Speech & Text Analytics topics dialects api_response = api_instance.get_speechandtextanalytics_topics_dialects() pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topics_dialects: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics/general Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the Speech & Text Analytics general topics for a given dialect,"```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.SpeechTextAnalyticsApi(); dialect = 'dialect_example' # str | The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard (optional) try: # Get the Speech & Text Analytics general topics for a given dialect api_response = api_instance.get_speechandtextanalytics_topics_general(dialect=dialect) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topics_general: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics/general/status Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of general topics from the org and the system with their current status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi(); dialect = 'dialect_example' # str | The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard (optional) try: # Get the list of general topics from the org and the system with their current status api_response = api_instance.get_speechandtextanalytics_topics_general_status(dialect=dialect) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topics_general_status: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/speechandtextanalytics/topics/publishjobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create new Speech & Text Analytics publish topics 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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.TopicJobRequest() # TopicJobRequest | The publish topics job to create try: # Create new Speech & Text Analytics publish topics job api_response = api_instance.post_speechandtextanalytics_topics_publishjobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_topics_publishjobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics/publishjobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Speech & Text Analytics publish topics job by 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.SpeechTextAnalyticsApi(); job_id = 'job_id_example' # str | The id of the publish topics job try: # Get a Speech & Text Analytics publish topics job by id api_response = api_instance.get_speechandtextanalytics_topics_publishjob(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topics_publishjob: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/topics/{topicId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Speech & Text Analytics topic by 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.SpeechTextAnalyticsApi(); topic_id = 'topic_id_example' # str | The id of the topic try: # Delete a Speech & Text Analytics topic by id api_instance.delete_speechandtextanalytics_topic(topic_id) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_topic: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics/{topicId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Speech & Text Analytics topic by 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.SpeechTextAnalyticsApi(); topic_id = 'topic_id_example' # str | The id of the topic try: # Get a Speech & Text Analytics topic by id api_response = api_instance.get_speechandtextanalytics_topic(topic_id) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topic: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/topics/{topicId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update existing Speech & Text Analytics topic,"```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.SpeechTextAnalyticsApi(); topic_id = 'topic_id_example' # str | The id of the topic body = PureCloudPlatformClientV2.TopicRequest() # TopicRequest | The topic to update try: # Update existing Speech & Text Analytics topic api_response = api_instance.put_speechandtextanalytics_topic(topic_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_topic: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/speechandtextanalytics/transcripts/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search resources.,"```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.SpeechTextAnalyticsApi(); body = PureCloudPlatformClientV2.TranscriptSearchRequest() # TranscriptSearchRequest | Search request options try: # Search resources. api_response = api_instance.post_speechandtextanalytics_transcripts_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_transcripts_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/stations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of available stations.,"```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.StationsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''name'' # str | Sort by (optional) (default to 'name') name = 'name_example' # str | Name (optional) user_selectable = 'user_selectable_example' # str | True for stations that the user can select otherwise false (optional) web_rtc_user_id = 'web_rtc_user_id_example' # str | Filter for the webRtc station of the webRtcUserId (optional) id = 'id_example' # str | Comma separated list of stationIds (optional) line_appearance_id = 'line_appearance_id_example' # str | lineAppearanceId (optional) try: # Get the list of available stations. api_response = api_instance.get_stations(page_size=page_size, page_number=page_number, sort_by=sort_by, name=name, user_selectable=user_selectable, web_rtc_user_id=web_rtc_user_id, id=id, line_appearance_id=line_appearance_id) pprint(api_response) except ApiException as e: print(""Exception when calling StationsApi->get_stations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/stations/{stationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get station.,"```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.StationsApi(); station_id = 'station_id_example' # str | Station ID try: # Get station. api_response = api_instance.get_station(station_id) pprint(api_response) except ApiException as e: print(""Exception when calling StationsApi->get_station: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/stations/{stationId}/associateduser Genesys Cloud Python SDK.,Genesys describes this as an API used to: Unassigns the user assigned to this station,"```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.StationsApi(); station_id = 'station_id_example' # str | Station ID try: # Unassigns the user assigned to this station api_instance.delete_station_associateduser(station_id) except ApiException as e: print(""Exception when calling StationsApi->delete_station_associateduser: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search using the q64 value returned from a previous search.,"```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.SuggestApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) profile = True # bool | profile (optional) (default to True) try: # Search using the q64 value returned from a previous search. api_response = api_instance.get_search(q64, expand=expand, profile=profile) pprint(api_response) except ApiException as e: print(""Exception when calling SuggestApi->get_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search resources.,"```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.SuggestApi(); body = PureCloudPlatformClientV2.SearchRequest() # SearchRequest | Search request options profile = True # bool | profile (optional) (default to True) try: # Search resources. api_response = api_instance.post_search(body, profile=profile) pprint(api_response) except ApiException as e: print(""Exception when calling SuggestApi->post_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/search/suggest Genesys Cloud Python SDK.,Genesys describes this as an API used to: Suggest resources using the q64 value returned from a previous suggest query.,"```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.SuggestApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) profile = True # bool | profile (optional) (default to True) try: # Suggest resources using the q64 value returned from a previous suggest query. api_response = api_instance.get_search_suggest(q64, expand=expand, profile=profile) pprint(api_response) except ApiException as e: print(""Exception when calling SuggestApi->get_search_suggest: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/search/suggest Genesys Cloud Python SDK.,Genesys describes this as an API used to: Suggest resources.,"```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.SuggestApi(); body = PureCloudPlatformClientV2.SuggestSearchRequest() # SuggestSearchRequest | Search request options profile = True # bool | profile (optional) (default to True) try: # Suggest resources. api_response = api_instance.post_search_suggest(body, profile=profile) pprint(api_response) except ApiException as e: print(""Exception when calling SuggestApi->post_search_suggest: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/workbins Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a workbin,"```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.TaskManagementApi(); body = PureCloudPlatformClientV2.WorkbinCreate() # WorkbinCreate | Workbin try: # Create a workbin api_response = api_instance.post_taskmanagement_workbins(body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_workbins: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/workbins/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for workbins,"```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.TaskManagementApi(); body = PureCloudPlatformClientV2.WorkbinQueryRequest() # WorkbinQueryRequest | QueryPostRequest try: # Query for workbins api_response = api_instance.post_taskmanagement_workbins_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_workbins_query: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/taskmanagement/workbins/{workbinId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a workbin,"```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.TaskManagementApi(); workbin_id = 'workbin_id_example' # str | Workbin ID try: # Delete a workbin api_instance.delete_taskmanagement_workbin(workbin_id) except ApiException as e: print(""Exception when calling TaskManagementApi->delete_taskmanagement_workbin: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/workbins/{workbinId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a workbin,"```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.TaskManagementApi(); workbin_id = 'workbin_id_example' # str | Workbin ID try: # Get a workbin api_response = api_instance.get_taskmanagement_workbin(workbin_id) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_workbin: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/taskmanagement/workbins/{workbinId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the attributes of a workbin,"```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.TaskManagementApi(); workbin_id = 'workbin_id_example' # str | Workbin ID body = PureCloudPlatformClientV2.WorkbinUpdate() # WorkbinUpdate | Json with attributes and their new values: {\""description\"":\""new description\"", \""name\"":\""new name\""}. try: # Update the attributes of a workbin api_response = api_instance.patch_taskmanagement_workbin(workbin_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->patch_taskmanagement_workbin: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/workitems Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a workitem,"```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.TaskManagementApi(); body = PureCloudPlatformClientV2.WorkitemCreate() # WorkitemCreate | Workitem try: # Create a workitem api_response = api_instance.post_taskmanagement_workitems(body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_workitems: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/workitems/query/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a workitem query 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.TaskManagementApi(); body = PureCloudPlatformClientV2.WorkitemQueryJobCreate() # WorkitemQueryJobCreate | WorkitemQueryJobCreate try: # Create a workitem query job api_response = api_instance.post_taskmanagement_workitems_query_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_workitems_query_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/query/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the workitem query job associated with the job 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.TaskManagementApi(); job_id = 'job_id_example' # str | jobId try: # Get the workitem query job associated with the job id. api_response = api_instance.get_taskmanagement_workitems_query_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_workitems_query_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/query/jobs/{jobId}/results Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get results from for workitem query 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.TaskManagementApi(); job_id = 'job_id_example' # str | jobId try: # Get results from for workitem query job api_response = api_instance.get_taskmanagement_workitems_query_job_results(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_workitems_query_job_results: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/schemas Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of schemas.,"```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.TaskManagementApi(); try: # Get a list of schemas. api_response = api_instance.get_taskmanagement_workitems_schemas() pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_workitems_schemas: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/workitems/schemas Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a schema,"```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.TaskManagementApi(); body = PureCloudPlatformClientV2.DataSchema() # DataSchema | Schema try: # Create a schema api_response = api_instance.post_taskmanagement_workitems_schemas(body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_workitems_schemas: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/taskmanagement/workitems/schemas/{schemaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a schema,"```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.TaskManagementApi(); schema_id = 'schema_id_example' # str | Schema ID try: # Delete a schema api_instance.delete_taskmanagement_workitems_schema(schema_id) except ApiException as e: print(""Exception when calling TaskManagementApi->delete_taskmanagement_workitems_schema: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/schemas/{schemaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a schema,"```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.TaskManagementApi(); schema_id = 'schema_id_example' # str | Schema ID try: # Get a schema api_response = api_instance.get_taskmanagement_workitems_schema(schema_id) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_workitems_schema: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/taskmanagement/workitems/schemas/{schemaId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a schema,"```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.TaskManagementApi(); schema_id = 'schema_id_example' # str | Schema ID body = PureCloudPlatformClientV2.DataSchema() # DataSchema | Data Schema try: # Update a schema api_response = api_instance.put_taskmanagement_workitems_schema(schema_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->put_taskmanagement_workitems_schema: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/schemas/{schemaId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all versions of a schema,"```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.TaskManagementApi(); schema_id = 'schema_id_example' # str | Schema ID try: # Get all versions of a schema api_response = api_instance.get_taskmanagement_workitems_schema_versions(schema_id) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_workitems_schema_versions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a specific version of a schema,"```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.TaskManagementApi(); schema_id = 'schema_id_example' # str | Schema ID version_id = 'version_id_example' # str | Schema version try: # Get a specific version of a schema api_response = api_instance.get_taskmanagement_workitems_schema_version(schema_id, version_id) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_workitems_schema_version: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/taskmanagement/workitems/{workitemId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a workitem,"```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | Workitem ID try: # Delete a workitem api_instance.delete_taskmanagement_workitem(workitem_id) except ApiException as e: print(""Exception when calling TaskManagementApi->delete_taskmanagement_workitem: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/{workitemId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a workitem,"```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | Workitem ID expands = 'expands_example' # str | Which fields to expand. Comma separated if more than one. (optional) try: # Get a workitem api_response = api_instance.get_taskmanagement_workitem(workitem_id, expands=expands) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_workitem: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/taskmanagement/workitems/{workitemId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the attributes of a workitem,"```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | Workitem ID body = PureCloudPlatformClientV2.WorkitemUpdate() # WorkitemUpdate | Workitem try: # Update the attributes of a workitem api_response = api_instance.patch_taskmanagement_workitem(workitem_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->patch_taskmanagement_workitem: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/workitems/{workitemId}/acd/cancel Genesys Cloud Python SDK.,Genesys describes this as an API used to: Cancel the assignment process for a workitem that is currently queued for assignment through ACD.,"```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | Workitem ID try: # Cancel the assignment process for a workitem that is currently queued for assignment through ACD. api_response = api_instance.post_taskmanagement_workitem_acd_cancel(workitem_id) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_workitem_acd_cancel: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/taskmanagement/workitems/{workitemId}/assignment Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages.","```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | Workitem ID body = PureCloudPlatformClientV2.WorkitemManualAssign() # WorkitemManualAssign | Targeted user try: # Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages. api_instance.patch_taskmanagement_workitem_assignment(workitem_id, body) except ApiException as e: print(""Exception when calling TaskManagementApi->patch_taskmanagement_workitem_assignment: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/workitems/{workitemId}/disconnect Genesys Cloud Python SDK.,Genesys describes this as an API used to: Disconnect the assignee of the workitem,"```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | Workitem ID try: # Disconnect the assignee of the workitem api_response = api_instance.post_taskmanagement_workitem_disconnect(workitem_id) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_workitem_disconnect: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/workitems/{workitemId}/terminate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Terminate a workitem,"```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | Workitem ID body = PureCloudPlatformClientV2.WorkitemTerminate() # WorkitemTerminate | Terminated request (optional) try: # Terminate a workitem api_response = api_instance.post_taskmanagement_workitem_terminate(workitem_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_workitem_terminate: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/taskmanagement/workitems/{workitemId}/users/me/wrapups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add/Remove a wrapup code for the current user in a workitem.,"```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | The ID of the Workitem. body = PureCloudPlatformClientV2.WorkitemWrapupUpdate() # WorkitemWrapupUpdate | Request body to add/remove the wrapup code for workitem try: # Add/Remove a wrapup code for the current user in a workitem. api_response = api_instance.patch_taskmanagement_workitem_users_me_wrapups(workitem_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->patch_taskmanagement_workitem_users_me_wrapups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all wrapup codes added for the given user for a workitem.,"```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | The ID of the Workitem. user_id = 'user_id_example' # str | The ID of the user expands = 'expands_example' # str | Which fields, if any, to expand. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 25 # int | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. (optional) (default to 25) sort_order = ''descending'' # str | Ascending or descending sort order (optional) (default to 'descending') try: # Get all wrapup codes added for the given user for a workitem. api_response = api_instance.get_taskmanagement_workitem_user_wrapups(workitem_id, user_id, expands=expands, after=after, page_size=page_size, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_workitem_user_wrapups: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/taskmanagement/workitems/{workitemId}/users/{userId}/wrapups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add/Remove a wrapup code for a given user in a workitem.,"```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | The ID of the Workitem. user_id = 'user_id_example' # str | The ID of the user body = PureCloudPlatformClientV2.WorkitemWrapupUpdate() # WorkitemWrapupUpdate | Request body to add/remove a wrapup code for a workitem try: # Add/Remove a wrapup code for a given user in a workitem. api_response = api_instance.patch_taskmanagement_workitem_user_wrapups(workitem_id, user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->patch_taskmanagement_workitem_user_wrapups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/{workitemId}/wrapups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all wrapup codes added for all users for a workitem.,"```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.TaskManagementApi(); workitem_id = 'workitem_id_example' # str | The ID of the Workitem. expands = 'expands_example' # str | Which fields, if any, to expand. (optional) after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional) page_size = 25 # int | Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. (optional) (default to 25) sort_order = ''descending'' # str | Ascending or descending sort order (optional) (default to 'descending') try: # Get all wrapup codes added for all users for a workitem. api_response = api_instance.get_taskmanagement_workitem_wrapups(workitem_id, expands=expands, after=after, page_size=page_size, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_workitem_wrapups: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/worktypes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a worktype,"```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.TaskManagementApi(); body = PureCloudPlatformClientV2.WorktypeCreate() # WorktypeCreate | Worktype try: # Create a worktype api_response = api_instance.post_taskmanagement_worktypes(body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_worktypes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/worktypes/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for worktypes,"```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.TaskManagementApi(); body = PureCloudPlatformClientV2.WorktypeQueryRequest() # WorktypeQueryRequest | QueryPostRequest try: # Query for worktypes api_response = api_instance.post_taskmanagement_worktypes_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_worktypes_query: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/taskmanagement/worktypes/{worktypeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a worktype,"```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.TaskManagementApi(); worktype_id = 'worktype_id_example' # str | Worktype id try: # Delete a worktype api_instance.delete_taskmanagement_worktype(worktype_id) except ApiException as e: print(""Exception when calling TaskManagementApi->delete_taskmanagement_worktype: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/worktypes/{worktypeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a worktype,"```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.TaskManagementApi(); worktype_id = 'worktype_id_example' # str | Worktype id expands = ['expands_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get a worktype api_response = api_instance.get_taskmanagement_worktype(worktype_id, expands=expands) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_worktype: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/taskmanagement/worktypes/{worktypeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the attributes of a worktype,"```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.TaskManagementApi(); worktype_id = 'worktype_id_example' # str | Worktype id body = PureCloudPlatformClientV2.WorktypeUpdate() # WorktypeUpdate | Worktype try: # Update the attributes of a worktype api_response = api_instance.patch_taskmanagement_worktype(worktype_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->patch_taskmanagement_worktype: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/worktypes/{worktypeId}/statuses Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of statuses for this worktype.,"```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.TaskManagementApi(); worktype_id = 'worktype_id_example' # str | Worktype id try: # Get list of statuses for this worktype. api_response = api_instance.get_taskmanagement_worktype_statuses(worktype_id) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_worktype_statuses: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/taskmanagement/worktypes/{worktypeId}/statuses Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a status to a worktype,"```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.TaskManagementApi(); worktype_id = 'worktype_id_example' # str | Worktype id body = PureCloudPlatformClientV2.WorkitemStatusCreate() # WorkitemStatusCreate | Status try: # Add a status to a worktype api_response = api_instance.post_taskmanagement_worktype_statuses(worktype_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->post_taskmanagement_worktype_statuses: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.TaskManagementApi(); worktype_id = 'worktype_id_example' # str | Worktype id status_id = 'status_id_example' # str | Status id try: # Delete a status api_instance.delete_taskmanagement_worktype_status(worktype_id, status_id) except ApiException as e: print(""Exception when calling TaskManagementApi->delete_taskmanagement_worktype_status: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.TaskManagementApi(); worktype_id = 'worktype_id_example' # str | Worktype id status_id = 'status_id_example' # str | Status id try: # Get a status api_response = api_instance.get_taskmanagement_worktype_status(worktype_id, status_id) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->get_taskmanagement_worktype_status: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the attributes of a status,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.TaskManagementApi(); worktype_id = 'worktype_id_example' # str | Worktype id status_id = 'status_id_example' # str | Status id body = PureCloudPlatformClientV2.WorkitemStatusUpdate() # WorkitemStatusUpdate | Status try: # Update the attributes of a status api_response = api_instance.patch_taskmanagement_worktype_status(worktype_id, status_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TaskManagementApi->patch_taskmanagement_worktype_status: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/teams/activity/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for team activity observations,"```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.TeamsApi(); body = PureCloudPlatformClientV2.TeamActivityQuery() # TeamActivityQuery | query page_size = 56 # int | The desired page size (optional) page_number = 56 # int | The desired page number (optional) try: # Query for team activity observations api_response = api_instance.post_analytics_teams_activity_query(body, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling TeamsApi->post_analytics_teams_activity_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/teams Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Team listing,"```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.TeamsApi(); page_size = 25 # int | Page size (optional) (default to 25) name = 'name_example' # str | Return only teams whose names start with this value (case-insensitive matching) (optional) after = 'after_example' # str | The cursor that points to the next item in the complete list of teams (optional) before = 'before_example' # str | The cursor that points to the previous item in the complete list of teams (optional) expand = 'expand_example' # str | Expand the name on each user (optional) try: # Get Team listing api_response = api_instance.get_teams(page_size=page_size, name=name, after=after, before=before, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling TeamsApi->get_teams: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/teams Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a team,"```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.TeamsApi(); body = PureCloudPlatformClientV2.Team() # Team | Team try: # Create a team api_response = api_instance.post_teams(body) pprint(api_response) except ApiException as e: print(""Exception when calling TeamsApi->post_teams: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/teams/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search resources.,"```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.TeamsApi(); body = PureCloudPlatformClientV2.TeamSearchRequest() # TeamSearchRequest | Search request options try: # Search resources. api_response = api_instance.post_teams_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling TeamsApi->post_teams_search: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/teams/{teamId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete team,"```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.TeamsApi(); team_id = 'team_id_example' # str | Team ID try: # Delete team api_instance.delete_team(team_id) except ApiException as e: print(""Exception when calling TeamsApi->delete_team: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/teams/{teamId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get team,"```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.TeamsApi(); team_id = 'team_id_example' # str | Team ID try: # Get team api_response = api_instance.get_team(team_id) pprint(api_response) except ApiException as e: print(""Exception when calling TeamsApi->get_team: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/teams/{teamId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update team,"```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.TeamsApi(); team_id = 'team_id_example' # str | Team ID body = PureCloudPlatformClientV2.Team() # Team | Team try: # Update team api_response = api_instance.patch_team(team_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TeamsApi->patch_team: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/teams/{teamId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete team members,"```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.TeamsApi(); team_id = 'team_id_example' # str | Team ID id = 'id_example' # str | Comma separated list of member ids to remove try: # Delete team members api_instance.delete_team_members(team_id, id) except ApiException as e: print(""Exception when calling TeamsApi->delete_team_members: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/teams/{teamId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get team membership,"```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.TeamsApi(); team_id = 'team_id_example' # str | Team ID page_size = 25 # int | Page size (optional) (default to 25) before = 'before_example' # str | The cursor that points to the previous item in the complete list of teams (optional) after = 'after_example' # str | The cursor that points to the next item in the complete list of teams (optional) expand = 'expand_example' # str | Expand the name on each user (optional) try: # Get team membership api_response = api_instance.get_team_members(team_id, page_size=page_size, before=before, after=after, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling TeamsApi->get_team_members: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/teams/{teamId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add team members,"```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.TeamsApi(); team_id = 'team_id_example' # str | Team ID body = PureCloudPlatformClientV2.TeamMembers() # TeamMembers | TeamMembers try: # Add team members api_response = api_instance.post_team_members(team_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TeamsApi->post_team_members: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/mediaregions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve the list of AWS regions media can stream through.,"```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.TelephonyApi(); try: # Retrieve the list of AWS regions media can stream through. api_response = api_instance.get_telephony_mediaregions() pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyApi->get_telephony_mediaregions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/sipmessages/conversations/{conversationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a SIP message. Get the raw form of the SIP message,"```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.TelephonyApi(); conversation_id = 'conversation_id_example' # str | Conversation id try: # Get a SIP message. api_response = api_instance.get_telephony_sipmessages_conversation(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyApi->get_telephony_sipmessages_conversation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/sipmessages/conversations/{conversationId}/headers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get SIP headers. Get parsed SIP headers. Returns specific headers if key query parameters are added.,"```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.TelephonyApi(); conversation_id = 'conversation_id_example' # str | Conversation id keys = ['keys_example'] # list[str] | comma-separated list of header identifiers to query. e.g. ruri,to,from (optional) try: # Get SIP headers. api_response = api_instance.get_telephony_sipmessages_conversation_headers(conversation_id, keys=keys) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyApi->get_telephony_sipmessages_conversation_headers: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/siptraces Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Fetch SIP metadata. Fetch SIP metadata that matches a given parameter. If exactMatch is passed as a parameter only sip records that have exactly that value will be returned. For example, some records contain conversationId but not all relevant records for that call may contain the conversationId so only a partial view of the call will be reflected","```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.TelephonyApi(); date_start = '2013-10-20T19:20:30+01:00' # datetime | Start date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z date_end = '2013-10-20T19:20:30+01:00' # datetime | End date of the search. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z call_id = 'call_id_example' # str | unique identification of the placed call (optional) to_user = 'to_user_example' # str | User to who the call was placed (optional) from_user = 'from_user_example' # str | user who placed the call (optional) conversation_id = 'conversation_id_example' # str | Unique identification of the conversation (optional) try: # Fetch SIP metadata api_response = api_instance.get_telephony_siptraces(date_start, date_end, call_id=call_id, to_user=to_user, from_user=from_user, conversation_id=conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyApi->get_telephony_siptraces: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/siptraces/download Genesys Cloud Python SDK.,Genesys describes this as an API used to: Request a download of a pcap file to S3,"```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.TelephonyApi(); sip_search_public_request = PureCloudPlatformClientV2.SIPSearchPublicRequest() # SIPSearchPublicRequest | try: # Request a download of a pcap file to S3 api_response = api_instance.post_telephony_siptraces_download(sip_search_public_request) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyApi->post_telephony_siptraces_download: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/siptraces/download/{downloadId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get signed S3 URL for a pcap download,"```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.TelephonyApi(); download_id = 'download_id_example' # str | unique id for the downloaded file in S3 try: # Get signed S3 URL for a pcap download api_response = api_instance.get_telephony_siptraces_download_download_id(download_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyApi->get_telephony_siptraces_download_download_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of edges.,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) name = 'name_example' # str | Name (optional) site_id = 'site_id_example' # str | Filter by site.id (optional) edge_group_id = 'edge_group_id_example' # str | Filter by edgeGroup.id (optional) sort_by = ''name'' # str | Sort by (optional) (default to 'name') managed = True # bool | Filter by managed (optional) show_cloud_media = True # bool | True to show the cloud media devices in the result. (optional) (default to True) try: # Get the list of edges. api_response = api_instance.get_telephony_providers_edges(page_size=page_size, page_number=page_number, name=name, site_id=site_id, edge_group_id=edge_group_id, sort_by=sort_by, managed=managed, show_cloud_media=show_cloud_media) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an edge.,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.Edge() # Edge | Edge try: # Create an edge. api_response = api_instance.post_telephony_providers_edges(body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/addressvalidation Genesys Cloud Python SDK.,Genesys describes this as an API used to: Validates a street address,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.ValidateAddressRequest() # ValidateAddressRequest | Address try: # Validates a street address api_response = api_instance.post_telephony_providers_edges_addressvalidation(body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_addressvalidation: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/alertablepresences Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes alertable presences overrides.,"```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.TelephonyProvidersEdgeApi(); try: # Deletes alertable presences overrides. api_instance.delete_telephony_providers_edges_alertablepresences() except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_alertablepresences: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/alertablepresences Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the list alertable presences. The 'type' query parameter can be used to If there are any overrides, this is the list of overrides; if there are no overrides, it is the default list.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.TelephonyProvidersEdgeApi(); type = 'type_example' # str | (optional) try: # Get the list alertable presences. The 'type' query parameter can be used to If there are any overrides, this is the list of overrides; if there are no overrides, it is the default list. api_response = api_instance.get_telephony_providers_edges_alertablepresences(type=type) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_alertablepresences: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/alertablepresences Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates or updates alertable presences overrides.,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.AlertablePresences() # AlertablePresences | Alertable Presences Overrides try: # Creates or updates alertable presences overrides. api_instance.put_telephony_providers_edges_alertablepresences(body) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_alertablepresences: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/certificateauthorities Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of certificate authorities.,"```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.TelephonyProvidersEdgeApi(); try: # Get the list of certificate authorities. api_response = api_instance.get_telephony_providers_edges_certificateauthorities() pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_certificateauthorities: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/certificateauthorities Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a certificate authority.,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.DomainCertificateAuthority() # DomainCertificateAuthority | CertificateAuthority try: # Create a certificate authority. api_response = api_instance.post_telephony_providers_edges_certificateauthorities(body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_certificateauthorities: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a certificate authority.,"```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.TelephonyProvidersEdgeApi(); certificate_id = 'certificate_id_example' # str | Certificate ID try: # Delete a certificate authority. api_instance.delete_telephony_providers_edges_certificateauthority(certificate_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_certificateauthority: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a certificate authority.,"```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.TelephonyProvidersEdgeApi(); certificate_id = 'certificate_id_example' # str | Certificate ID try: # Get a certificate authority. api_response = api_instance.get_telephony_providers_edges_certificateauthority(certificate_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_certificateauthority: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/certificateauthorities/{certificateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a certificate authority.,"```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.TelephonyProvidersEdgeApi(); certificate_id = 'certificate_id_example' # str | Certificate ID body = PureCloudPlatformClientV2.DomainCertificateAuthority() # DomainCertificateAuthority | Certificate authority try: # Update a certificate authority. api_response = api_instance.put_telephony_providers_edges_certificateauthority(certificate_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_certificateauthority: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/didpools Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a listing of DID Pools,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''number'' # str | Sort by (optional) (default to 'number') id = ['id_example'] # list[str] | Filter by a specific list of ID's (optional) try: # Get a listing of DID Pools api_response = api_instance.get_telephony_providers_edges_didpools(page_size=page_size, page_number=page_number, sort_by=sort_by, id=id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_didpools: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/didpools Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new DID pool,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.DIDPool() # DIDPool | DID pool try: # Create a new DID pool api_response = api_instance.post_telephony_providers_edges_didpools(body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_didpools: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/didpools/dids Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a listing of unassigned and/or assigned numbers in a set of DID Pools.,"```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.TelephonyProvidersEdgeApi(); type = 'type_example' # str | The type of numbers to return. id = ['id_example'] # list[str] | Filter by a specific list of DID Pools. If this is not provided, numbers from all DID Pools will be returned. (optional) number_match = 'number_match_example' # str | A number to filter the results by. (optional) page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending') try: # Get a listing of unassigned and/or assigned numbers in a set of DID Pools. api_response = api_instance.get_telephony_providers_edges_didpools_dids(type, id=id, number_match=number_match, page_size=page_size, page_number=page_number, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_didpools_dids: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/didpools/{didPoolId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a DID Pool by 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.TelephonyProvidersEdgeApi(); did_pool_id = 'did_pool_id_example' # str | DID pool ID try: # Delete a DID Pool by ID. api_instance.delete_telephony_providers_edges_didpool(did_pool_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_didpool: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/didpools/{didPoolId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a DID Pool by 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.TelephonyProvidersEdgeApi(); did_pool_id = 'did_pool_id_example' # str | DID pool ID try: # Get a DID Pool by ID. api_response = api_instance.get_telephony_providers_edges_didpool(did_pool_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_didpool: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/didpools/{didPoolId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a DID Pool by 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.TelephonyProvidersEdgeApi(); did_pool_id = 'did_pool_id_example' # str | DID pool ID body = PureCloudPlatformClientV2.DIDPool() # DIDPool | DID pool try: # Update a DID Pool by ID. api_response = api_instance.put_telephony_providers_edges_didpool(did_pool_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_didpool: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/dids Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a listing of DIDs,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''number'' # str | Sort by (optional) (default to 'number') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') phone_number = 'phone_number_example' # str | Filter by phoneNumber (optional) owner_id = 'owner_id_example' # str | Filter by the owner of a phone number (optional) did_pool_id = 'did_pool_id_example' # str | Filter by the DID Pool assignment (optional) id = ['id_example'] # list[str] | Filter by a specific list of ID's (optional) try: # Get a listing of DIDs api_response = api_instance.get_telephony_providers_edges_dids(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, phone_number=phone_number, owner_id=owner_id, did_pool_id=did_pool_id, id=id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_dids: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/dids/{didId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a DID by 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.TelephonyProvidersEdgeApi(); did_id = 'did_id_example' # str | DID ID try: # Get a DID by ID. api_response = api_instance.get_telephony_providers_edges_did(did_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_did: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/edgegroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of edge groups.,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) name = 'name_example' # str | Name (optional) sort_by = ''name'' # str | Sort by (optional) (default to 'name') managed = True # bool | Filter by managed (optional) try: # Get the list of edge groups. api_response = api_instance.get_telephony_providers_edges_edgegroups(page_size=page_size, page_number=page_number, name=name, sort_by=sort_by, managed=managed) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_edgegroups: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/edgegroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an edge group.,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.EdgeGroup() # EdgeGroup | EdgeGroup try: # Create an edge group. api_response = api_instance.post_telephony_providers_edges_edgegroups(body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_edgegroups: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an edge group.,"```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.TelephonyProvidersEdgeApi(); edge_group_id = 'edge_group_id_example' # str | Edge group ID try: # Delete an edge group. api_instance.delete_telephony_providers_edges_edgegroup(edge_group_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_edgegroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get edge group.,"```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.TelephonyProvidersEdgeApi(); edge_group_id = 'edge_group_id_example' # str | Edge group ID expand = ['expand_example'] # list[str] | Fields to expand in the response (optional) try: # Get edge group. api_response = api_instance.get_telephony_providers_edges_edgegroup(edge_group_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_edgegroup: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/edgegroups/{edgeGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an edge group.,"```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.TelephonyProvidersEdgeApi(); edge_group_id = 'edge_group_id_example' # str | Edge group ID body = PureCloudPlatformClientV2.EdgeGroup() # EdgeGroup | EdgeGroup try: # Update an edge group. api_response = api_instance.put_telephony_providers_edges_edgegroup(edge_group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_edgegroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets the edge trunk base associated with the edge group,"```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.TelephonyProvidersEdgeApi(); edgegroup_id = 'edgegroup_id_example' # str | Edge Group ID edgetrunkbase_id = 'edgetrunkbase_id_example' # str | Edge Trunk Base ID try: # Gets the edge trunk base associated with the edge group api_response = api_instance.get_telephony_providers_edges_edgegroup_edgetrunkbase(edgegroup_id, edgetrunkbase_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_edgegroup_edgetrunkbase: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/edgegroups/{edgegroupId}/edgetrunkbases/{edgetrunkbaseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the edge trunk base associated with the edge group,"```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.TelephonyProvidersEdgeApi(); edgegroup_id = 'edgegroup_id_example' # str | Edge Group ID edgetrunkbase_id = 'edgetrunkbase_id_example' # str | Edge Trunk Base ID body = PureCloudPlatformClientV2.EdgeTrunkBase() # EdgeTrunkBase | EdgeTrunkBase try: # Update the edge trunk base associated with the edge group api_response = api_instance.put_telephony_providers_edges_edgegroup_edgetrunkbase(edgegroup_id, edgetrunkbase_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_edgegroup_edgetrunkbase: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/edgeversionreport Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the edge version report. The report will not have consistent data about the edge version(s) until all edges have been reset.,"```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.TelephonyProvidersEdgeApi(); try: # Get the edge version report. api_response = api_instance.get_telephony_providers_edges_edgeversionreport() pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_edgeversionreport: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/expired Genesys Cloud Python SDK.,Genesys describes this as an API used to: List of edges more than 4 edge versions behind the latest software.,"```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.TelephonyProvidersEdgeApi(); try: # List of edges more than 4 edge versions behind the latest software. api_response = api_instance.get_telephony_providers_edges_expired() pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_expired: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/extensionpools Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a listing of extension pools,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = 'sort_by_example' # str | Sort by (optional) number = 'number_example' # str | Deprecated, filtering by number not supported (optional) try: # Get a listing of extension pools api_response = api_instance.get_telephony_providers_edges_extensionpools(page_size=page_size, page_number=page_number, sort_by=sort_by, number=number) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_extensionpools: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/extensionpools Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new extension pool,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.ExtensionPool() # ExtensionPool | ExtensionPool try: # Create a new extension pool api_response = api_instance.post_telephony_providers_edges_extensionpools(body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_extensionpools: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/extensionpools/divisionviews Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a pageable list of basic extension pool objects filterable by query parameters. This returns extension pools consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.","```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.TelephonyProvidersEdgeApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') id = ['id_example'] # list[str] | ID of the Extension Pools to filter by. (optional) name = 'name_example' # str | Name of the Extension Pools to filter by. (optional) division_id = ['division_id_example'] # list[str] | List of divisionIds on which to filter. (optional) try: # Get a pageable list of basic extension pool objects filterable by query parameters. api_response = api_instance.get_telephony_providers_edges_extensionpools_divisionviews(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, id=id, name=name, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_extensionpools_divisionviews: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an extension pool by 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.TelephonyProvidersEdgeApi(); extension_pool_id = 'extension_pool_id_example' # str | Extension pool ID try: # Delete an extension pool by ID api_instance.delete_telephony_providers_edges_extensionpool(extension_pool_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_extensionpool: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an extension pool by 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.TelephonyProvidersEdgeApi(); extension_pool_id = 'extension_pool_id_example' # str | Extension pool ID try: # Get an extension pool by ID api_response = api_instance.get_telephony_providers_edges_extensionpool(extension_pool_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_extensionpool: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/extensionpools/{extensionPoolId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an extension pool by 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.TelephonyProvidersEdgeApi(); extension_pool_id = 'extension_pool_id_example' # str | Extension pool ID body = PureCloudPlatformClientV2.ExtensionPool() # ExtensionPool | ExtensionPool try: # Update an extension pool by ID api_response = api_instance.put_telephony_providers_edges_extensionpool(extension_pool_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_extensionpool: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/extensions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a listing of extensions,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''number'' # str | Sort by (optional) (default to 'number') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') number = 'number_example' # str | Filter by number (optional) try: # Get a listing of extensions api_response = api_instance.get_telephony_providers_edges_extensions(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, number=number) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_extensions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/extensions/{extensionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an extension by 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.TelephonyProvidersEdgeApi(); extension_id = 'extension_id_example' # str | Extension ID try: # Get an extension by ID. api_response = api_instance.get_telephony_providers_edges_extension(extension_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_extension: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/linebasesettings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a listing of line base settings objects,"```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.TelephonyProvidersEdgeApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Value by which to sort (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') expand = ['expand_example'] # list[str] | Fields to expand in the response, comma-separated (optional) try: # Get a listing of line base settings objects api_response = api_instance.get_telephony_providers_edges_linebasesettings(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_linebasesettings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/linebasesettings/{lineBaseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a line base settings object by 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.TelephonyProvidersEdgeApi(); line_base_id = 'line_base_id_example' # str | Line base ID try: # Get a line base settings object by ID api_response = api_instance.get_telephony_providers_edges_linebasesetting(line_base_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_linebasesetting: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/lines Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Lines,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) name = 'name_example' # str | Name (optional) sort_by = ''name'' # str | Value by which to sort (optional) (default to 'name') expand = ['expand_example'] # list[str] | Fields to expand in the response, comma-separated. The edgeGroup value is deprecated. (optional) try: # Get a list of Lines api_response = api_instance.get_telephony_providers_edges_lines(page_size=page_size, page_number=page_number, name=name, sort_by=sort_by, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_lines: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/lines/template Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance,"```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.TelephonyProvidersEdgeApi(); line_base_settings_id = 'line_base_settings_id_example' # str | The id of a Line Base Settings object upon which to base this Line try: # Get a Line instance template based on a Line Base Settings object. This object can then be modified and saved as a new Line instance api_response = api_instance.get_telephony_providers_edges_lines_template(line_base_settings_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_lines_template: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/lines/{lineId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Line by 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.TelephonyProvidersEdgeApi(); line_id = 'line_id_example' # str | Line ID try: # Get a Line by ID api_response = api_instance.get_telephony_providers_edges_line(line_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_line: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/logicalinterfaces Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get edge logical interfaces. Retrieve the configured logical interfaces for a list edges. Only 100 edges can be requested at a time.,"```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.TelephonyProvidersEdgeApi(); edge_ids = 'edge_ids_example' # str | Comma separated list of Edge Id's expand = ['expand_example'] # list[str] | Field to expand in the response (optional) try: # Get edge logical interfaces. api_response = api_instance.get_telephony_providers_edges_logicalinterfaces(edge_ids, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_logicalinterfaces: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/metrics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the metrics for a list of edges.,"```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.TelephonyProvidersEdgeApi(); edge_ids = 'edge_ids_example' # str | Comma separated list of Edge Id's. Maximum of 100 edge ids allowed. try: # Get the metrics for a list of edges. api_response = api_instance.get_telephony_providers_edges_metrics(edge_ids) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_metrics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/outboundroutes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get outbound routes,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) name = 'name_example' # str | Name (optional) site_id = 'site_id_example' # str | Filter by site.id (optional) external_trunk_bases_ids = 'external_trunk_bases_ids_example' # str | Filter by externalTrunkBases.ids (optional) sort_by = ''name'' # str | Sort by (optional) (default to 'name') try: # Get outbound routes api_response = api_instance.get_telephony_providers_edges_outboundroutes(page_size=page_size, page_number=page_number, name=name, site_id=site_id, external_trunk_bases_ids=external_trunk_bases_ids, sort_by=sort_by) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_outboundroutes: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/phonebasesettings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Phone Base Settings objects,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''name'' # str | Value by which to sort (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') expand = ['expand_example'] # list[str] | Fields to expand in the response, comma-separated (optional) name = 'name_example' # str | Name (optional) try: # Get a list of Phone Base Settings objects api_response = api_instance.get_telephony_providers_edges_phonebasesettings(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, expand=expand, name=name) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_phonebasesettings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/phonebasesettings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new Phone Base Settings object,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.PhoneBase() # PhoneBase | Phone base settings try: # Create a new Phone Base Settings object api_response = api_instance.post_telephony_providers_edges_phonebasesettings(body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_phonebasesettings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/phonebasesettings/availablemetabases Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of available makes and models to create a new Phone Base Settings,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of available makes and models to create a new Phone Base Settings api_response = api_instance.get_telephony_providers_edges_phonebasesettings_availablemetabases(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_phonebasesettings_availablemetabases: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/phonebasesettings/template Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance,"```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.TelephonyProvidersEdgeApi(); phone_metabase_id = 'phone_metabase_id_example' # str | The id of a metabase object upon which to base this Phone Base Settings try: # Get a Phone Base Settings instance template from a given make and model. This object can then be modified and saved as a new Phone Base Settings instance api_response = api_instance.get_telephony_providers_edges_phonebasesettings_template(phone_metabase_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_phonebasesettings_template: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Phone Base Settings by 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.TelephonyProvidersEdgeApi(); phone_base_id = 'phone_base_id_example' # str | Phone base ID try: # Delete a Phone Base Settings by ID api_instance.delete_telephony_providers_edges_phonebasesetting(phone_base_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_phonebasesetting: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Phone Base Settings object by 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.TelephonyProvidersEdgeApi(); phone_base_id = 'phone_base_id_example' # str | Phone base ID try: # Get a Phone Base Settings object by ID api_response = api_instance.get_telephony_providers_edges_phonebasesetting(phone_base_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_phonebasesetting: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/phonebasesettings/{phoneBaseId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Phone Base Settings by 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.TelephonyProvidersEdgeApi(); phone_base_id = 'phone_base_id_example' # str | Phone base ID body = PureCloudPlatformClientV2.PhoneBase() # PhoneBase | Phone base settings try: # Update a Phone Base Settings by ID api_response = api_instance.put_telephony_providers_edges_phonebasesetting(phone_base_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_phonebasesetting: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/phones Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values.","```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.TelephonyProvidersEdgeApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | The field to sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') site_id = 'site_id_example' # str | Filter by site.id (optional) web_rtc_user_id = 'web_rtc_user_id_example' # str | Filter by webRtcUser.id (optional) phone_base_settings_id = 'phone_base_settings_id_example' # str | Filter by phoneBaseSettings.id (optional) lines_logged_in_user_id = 'lines_logged_in_user_id_example' # str | Filter by lines.loggedInUser.id (optional) lines_default_for_user_id = 'lines_default_for_user_id_example' # str | Filter by lines.defaultForUser.id (optional) phone_hardware_id = 'phone_hardware_id_example' # str | Filter by phone_hardwareId (optional) lines_id = 'lines_id_example' # str | Filter by lines.id (optional) lines_name = 'lines_name_example' # str | Filter by lines.name (optional) name = 'name_example' # str | Name of the Phone to filter by, comma-separated (optional) status_operational_status = 'status_operational_status_example' # str | The primary status to filter by (optional) secondary_status_operational_status = 'secondary_status_operational_status_example' # str | The secondary status to filter by (optional) expand = ['expand_example'] # list[str] | Fields to expand in the response, comma-separated (optional) fields = ['fields_example'] # list[str] | Fields and properties to get, comma-separated (optional) try: # Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values. api_response = api_instance.get_telephony_providers_edges_phones(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, site_id=site_id, web_rtc_user_id=web_rtc_user_id, phone_base_settings_id=phone_base_settings_id, lines_logged_in_user_id=lines_logged_in_user_id, lines_default_for_user_id=lines_default_for_user_id, phone_hardware_id=phone_hardware_id, lines_id=lines_id, lines_name=lines_name, name=name, status_operational_status=status_operational_status, secondary_status_operational_status=secondary_status_operational_status, expand=expand, fields=fields) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_phones: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/phones Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new Phone,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.Phone() # Phone | Phone try: # Create a new Phone api_response = api_instance.post_telephony_providers_edges_phones(body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_phones: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/phones/reboot Genesys Cloud Python SDK.,Genesys describes this as an API used to: Reboot Multiple Phones,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.PhonesReboot() # PhonesReboot | Phones try: # Reboot Multiple Phones api_instance.post_telephony_providers_edges_phones_reboot(body) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_phones_reboot: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/phones/template Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance,"```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.TelephonyProvidersEdgeApi(); phone_base_settings_id = 'phone_base_settings_id_example' # str | The id of a Phone Base Settings object upon which to base this Phone try: # Get a Phone instance template based on a Phone Base Settings object. This object can then be modified and saved as a new Phone instance api_response = api_instance.get_telephony_providers_edges_phones_template(phone_base_settings_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_phones_template: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/phones/{phoneId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Phone by 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.TelephonyProvidersEdgeApi(); phone_id = 'phone_id_example' # str | Phone ID try: # Delete a Phone by ID api_instance.delete_telephony_providers_edges_phone(phone_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_phone: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/phones/{phoneId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Phone by 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.TelephonyProvidersEdgeApi(); phone_id = 'phone_id_example' # str | Phone ID try: # Get a Phone by ID api_response = api_instance.get_telephony_providers_edges_phone(phone_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_phone: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/phones/{phoneId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Phone by 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.TelephonyProvidersEdgeApi(); phone_id = 'phone_id_example' # str | Phone ID body = PureCloudPlatformClientV2.Phone() # Phone | Phone try: # Update a Phone by ID api_response = api_instance.put_telephony_providers_edges_phone(phone_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_phone: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/phones/{phoneId}/reboot Genesys Cloud Python SDK.,Genesys describes this as an API used to: Reboot a Phone,"```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.TelephonyProvidersEdgeApi(); phone_id = 'phone_id_example' # str | Phone Id try: # Reboot a Phone api_instance.post_telephony_providers_edges_phone_reboot(phone_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_phone_reboot: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/physicalinterfaces Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get physical interfaces for edges. Retrieves a list of all configured physical interfaces for a list of edges. Only 100 edges can be requested at a time.,"```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.TelephonyProvidersEdgeApi(); edge_ids = 'edge_ids_example' # str | Comma separated list of Edge Id's try: # Get physical interfaces for edges. api_response = api_instance.get_telephony_providers_edges_physicalinterfaces(edge_ids) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_physicalinterfaces: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/sites Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of Sites.,"```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.TelephonyProvidersEdgeApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_by = ''name'' # str | Sort by (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') name = 'name_example' # str | Name (optional) location_id = 'location_id_example' # str | Location Id (optional) managed = True # bool | Filter by managed (optional) expand = ['expand_example'] # list[str] | Fields to expand in the response, comma-separated (optional) try: # Get the list of Sites. api_response = api_instance.get_telephony_providers_edges_sites(page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, name=name, location_id=location_id, managed=managed, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_sites: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/sites Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Site.,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.Site() # Site | Site try: # Create a Site. api_response = api_instance.post_telephony_providers_edges_sites(body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_sites: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/sites/{siteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Site by 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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID try: # Delete a Site by ID api_instance.delete_telephony_providers_edges_site(site_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_site: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/sites/{siteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Site by 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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID try: # Get a Site by ID. api_response = api_instance.get_telephony_providers_edges_site(site_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_site: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/sites/{siteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Site by 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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID body = PureCloudPlatformClientV2.Site() # Site | Site try: # Update a Site by ID. api_response = api_instance.put_telephony_providers_edges_site(site_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_site: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of Number Plans for this Site. Only fetches the first 200 records.,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID try: # Get the list of Number Plans for this Site. Only fetches the first 200 records. api_response = api_instance.get_telephony_providers_edges_site_numberplans(site_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_site_numberplans: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/sites/{siteId}/numberplans Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the list of Number Plans. A user can update maximum 200 number plans at a time.,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID body = [PureCloudPlatformClientV2.NumberPlan()] # list[NumberPlan] | List of number plans try: # Update the list of Number Plans. A user can update maximum 200 number plans at a time. api_response = api_instance.put_telephony_providers_edges_site_numberplans(site_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_site_numberplans: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/classifications Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Classifications for this Site,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID classification = 'classification_example' # str | Classification (optional) try: # Get a list of Classifications for this Site api_response = api_instance.get_telephony_providers_edges_site_numberplans_classifications(site_id, classification=classification) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_site_numberplans_classifications: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/sites/{siteId}/numberplans/{numberPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Number Plan by 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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID number_plan_id = 'number_plan_id_example' # str | Number Plan ID try: # Get a Number Plan by ID. api_response = api_instance.get_telephony_providers_edges_site_numberplan(site_id, number_plan_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_site_numberplan: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get outbound routes,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) name = 'name_example' # str | Name (optional) external_trunk_bases_ids = 'external_trunk_bases_ids_example' # str | externalTrunkBases.ids (optional) sort_by = ''name'' # str | Sort by (optional) (default to 'name') try: # Get outbound routes api_response = api_instance.get_telephony_providers_edges_site_outboundroutes(site_id, page_size=page_size, page_number=page_number, name=name, external_trunk_bases_ids=external_trunk_bases_ids, sort_by=sort_by) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_site_outboundroutes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create outbound route,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID body = PureCloudPlatformClientV2.OutboundRouteBase() # OutboundRouteBase | OutboundRoute try: # Create outbound route api_response = api_instance.post_telephony_providers_edges_site_outboundroutes(site_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_site_outboundroutes: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete Outbound Route,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID outbound_route_id = 'outbound_route_id_example' # str | Outbound route ID try: # Delete Outbound Route api_instance.delete_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_site_outboundroute: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an outbound route,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID outbound_route_id = 'outbound_route_id_example' # str | Outbound route ID try: # Get an outbound route api_response = api_instance.get_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_site_outboundroute: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update outbound route,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID outbound_route_id = 'outbound_route_id_example' # str | Outbound route ID body = PureCloudPlatformClientV2.OutboundRouteBase() # OutboundRouteBase | OutboundRoute try: # Update outbound route api_response = api_instance.put_telephony_providers_edges_site_outboundroute(site_id, outbound_route_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_site_outboundroute: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/sites/{siteId}/siteconnections Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get site connections for a site.,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID try: # Get site connections for a site. api_response = api_instance.get_telephony_providers_edges_site_siteconnections(site_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_site_siteconnections: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/telephony/providers/edges/sites/{siteId}/siteconnections Genesys Cloud Python SDK.,Genesys describes this as an API used to: Disable site connections for a site.,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID body = PureCloudPlatformClientV2.DisableSiteConnectionsRequest() # DisableSiteConnectionsRequest | Site try: # Disable site connections for a site. api_response = api_instance.patch_telephony_providers_edges_site_siteconnections(site_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->patch_telephony_providers_edges_site_siteconnections: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/sites/{siteId}/siteconnections Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update site connections for a site.,"```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.TelephonyProvidersEdgeApi(); site_id = 'site_id_example' # str | Site ID body = PureCloudPlatformClientV2.SiteConnections() # SiteConnections | Site try: # Update site connections for a site. api_response = api_instance.put_telephony_providers_edges_site_siteconnections(site_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_site_siteconnections: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/timezones Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of Edge-compatible time zones,"```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.TelephonyProvidersEdgeApi(); page_size = 1000 # int | Page size (optional) (default to 1000) page_number = 1 # int | Page number (optional) (default to 1) try: # Get a list of Edge-compatible time zones api_response = api_instance.get_telephony_providers_edges_timezones(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_timezones: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/trunkbasesettings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Trunk Base Settings listing. Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.,"```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.TelephonyProvidersEdgeApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Value by which to sort (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') recording_enabled = True # bool | Filter trunks by recording enabled (optional) ignore_hidden = True # bool | Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only. (optional) managed = True # bool | Filter by managed (optional) expand = ['expand_example'] # list[str] | Fields to expand in the response, comma-separated (optional) name = 'name_example' # str | Name of the TrunkBase to filter by (optional) try: # Get Trunk Base Settings listing api_response = api_instance.get_telephony_providers_edges_trunkbasesettings(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, recording_enabled=recording_enabled, ignore_hidden=ignore_hidden, managed=managed, expand=expand, name=name) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_trunkbasesettings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/trunkbasesettings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a Trunk Base Settings object,"```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.TelephonyProvidersEdgeApi(); body = PureCloudPlatformClientV2.TrunkBase() # TrunkBase | Trunk base settings try: # Create a Trunk Base Settings object api_response = api_instance.post_telephony_providers_edges_trunkbasesettings(body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edges_trunkbasesettings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/trunkbasesettings/availablemetabases Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of available makes and models to create a new Trunk Base Settings,"```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.TelephonyProvidersEdgeApi(); type = 'type_example' # str | (optional) page_size = 25 # int | (optional) (default to 25) page_number = 1 # int | (optional) (default to 1) try: # Get a list of available makes and models to create a new Trunk Base Settings api_response = api_instance.get_telephony_providers_edges_trunkbasesettings_availablemetabases(type=type, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_trunkbasesettings_availablemetabases: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/trunkbasesettings/template Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance,"```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.TelephonyProvidersEdgeApi(); trunk_metabase_id = 'trunk_metabase_id_example' # str | The id of a metabase object upon which to base this Trunk Base Settings try: # Get a Trunk Base Settings instance template from a given make and model. This object can then be modified and saved as a new Trunk Base Settings instance api_response = api_instance.get_telephony_providers_edges_trunkbasesettings_template(trunk_metabase_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_trunkbasesettings_template: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Trunk Base Settings object by 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.TelephonyProvidersEdgeApi(); trunk_base_settings_id = 'trunk_base_settings_id_example' # str | Trunk Base ID try: # Delete a Trunk Base Settings object by ID api_instance.delete_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edges_trunkbasesetting: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Trunk Base Settings object by ID. Managed properties will not be returned unless the user is assigned the internal:trunk:edit permission.,"```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.TelephonyProvidersEdgeApi(); trunk_base_settings_id = 'trunk_base_settings_id_example' # str | Trunk Base ID ignore_hidden = True # bool | Set this to true to not receive trunk properties that are meant to be hidden or for internal system usage only. (optional) try: # Get a Trunk Base Settings object by ID api_response = api_instance.get_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id, ignore_hidden=ignore_hidden) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_trunkbasesetting: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/trunkbasesettings/{trunkBaseSettingsId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Trunk Base Settings object by 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.TelephonyProvidersEdgeApi(); trunk_base_settings_id = 'trunk_base_settings_id_example' # str | Trunk Base ID body = PureCloudPlatformClientV2.TrunkBase() # TrunkBase | Trunk base settings try: # Update a Trunk Base Settings object by ID api_response = api_instance.put_telephony_providers_edges_trunkbasesetting(trunk_base_settings_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edges_trunkbasesetting: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/trunks Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of available trunks. Trunks are created by assigning trunk base settings to an Edge or Edge Group.,"```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.TelephonyProvidersEdgeApi(); page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Value by which to sort (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') edge_id = 'edge_id_example' # str | Filter by Edge Ids (optional) trunk_base_id = 'trunk_base_id_example' # str | Filter by Trunk Base Ids (optional) trunk_type = 'trunk_type_example' # str | Filter by a Trunk type (optional) try: # Get the list of available trunks. api_response = api_instance.get_telephony_providers_edges_trunks(page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, edge_id=edge_id, trunk_base_id=trunk_base_id, trunk_type=trunk_type) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_trunks: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/trunks/metrics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the metrics for a list of trunks.,"```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.TelephonyProvidersEdgeApi(); trunk_ids = 'trunk_ids_example' # str | Comma separated list of Trunk Id's try: # Get the metrics for a list of trunks. api_response = api_instance.get_telephony_providers_edges_trunks_metrics(trunk_ids) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_trunks_metrics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/trunks/{trunkId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Trunk by 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.TelephonyProvidersEdgeApi(); trunk_id = 'trunk_id_example' # str | Trunk ID try: # Get a Trunk by ID api_response = api_instance.get_telephony_providers_edges_trunk(trunk_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_trunk: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/trunks/{trunkId}/metrics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the trunk metrics.,"```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.TelephonyProvidersEdgeApi(); trunk_id = 'trunk_id_example' # str | Trunk Id try: # Get the trunk metrics. api_response = api_instance.get_telephony_providers_edges_trunk_metrics(trunk_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_trunk_metrics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/trunkswithrecording Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get Counts of trunks that have recording disabled or 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.TelephonyProvidersEdgeApi(); trunk_type = 'trunk_type_example' # str | The type of this trunk base. (optional) try: # Get Counts of trunks that have recording disabled or enabled api_response = api_instance.get_telephony_providers_edges_trunkswithrecording(trunk_type=trunk_type) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edges_trunkswithrecording: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/{edgeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID try: # Delete a edge. api_instance.delete_telephony_providers_edge(edge_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edge: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID expand = ['expand_example'] # list[str] | Fields to expand in the response, comma-separated (optional) try: # Get edge. api_response = api_instance.get_telephony_providers_edge(edge_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/{edgeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID body = PureCloudPlatformClientV2.Edge() # Edge | Edge try: # Update a edge. api_response = api_instance.put_telephony_providers_edge(edge_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edge: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get networking-related information from an Edge for a target IP or host.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge Id try: # Get networking-related information from an Edge for a target IP or host. api_response = api_instance.get_telephony_providers_edge_diagnostic_nslookup(edge_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_diagnostic_nslookup: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/nslookup Genesys Cloud Python SDK.,Genesys describes this as an API used to: Nslookup request command to collect networking-related information from an Edge for a target IP or host.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge Id body = PureCloudPlatformClientV2.EdgeNetworkDiagnosticRequest() # EdgeNetworkDiagnosticRequest | request payload to get network diagnostic try: # Nslookup request command to collect networking-related information from an Edge for a target IP or host. api_response = api_instance.post_telephony_providers_edge_diagnostic_nslookup(edge_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_diagnostic_nslookup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get networking-related information from an Edge for a target IP or host.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge Id try: # Get networking-related information from an Edge for a target IP or host. api_response = api_instance.get_telephony_providers_edge_diagnostic_ping(edge_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_diagnostic_ping: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/ping Genesys Cloud Python SDK.,Genesys describes this as an API used to: Ping Request command to collect networking-related information from an Edge for a target IP or host.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge Id body = PureCloudPlatformClientV2.EdgeNetworkDiagnosticRequest() # EdgeNetworkDiagnosticRequest | request payload to get network diagnostic try: # Ping Request command to collect networking-related information from an Edge for a target IP or host. api_response = api_instance.post_telephony_providers_edge_diagnostic_ping(edge_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_diagnostic_ping: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/route Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get networking-related information from an Edge for a target IP or host.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge Id try: # Get networking-related information from an Edge for a target IP or host. api_response = api_instance.get_telephony_providers_edge_diagnostic_route(edge_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_diagnostic_route: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/route Genesys Cloud Python SDK.,Genesys describes this as an API used to: Route request command to collect networking-related information from an Edge for a target IP or host.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge Id body = PureCloudPlatformClientV2.EdgeNetworkDiagnosticRequest() # EdgeNetworkDiagnosticRequest | request payload to get network diagnostic try: # Route request command to collect networking-related information from an Edge for a target IP or host. api_response = api_instance.post_telephony_providers_edge_diagnostic_route(edge_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_diagnostic_route: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get networking-related information from an Edge for a target IP or host.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge Id try: # Get networking-related information from an Edge for a target IP or host. api_response = api_instance.get_telephony_providers_edge_diagnostic_tracepath(edge_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_diagnostic_tracepath: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/diagnostic/tracepath Genesys Cloud Python SDK.,Genesys describes this as an API used to: Tracepath request command to collect networking-related information from an Edge for a target IP or host.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge Id body = PureCloudPlatformClientV2.EdgeNetworkDiagnosticRequest() # EdgeNetworkDiagnosticRequest | request payload to get network diagnostic try: # Tracepath request command to collect networking-related information from an Edge for a target IP or host. api_response = api_instance.post_telephony_providers_edge_diagnostic_tracepath(edge_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_diagnostic_tracepath: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get edge logical interfaces. Retrieve a list of all configured logical interfaces from a specific edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID expand = ['expand_example'] # list[str] | Field to expand in the response (optional) try: # Get edge logical interfaces. api_response = api_instance.get_telephony_providers_edge_logicalinterfaces(edge_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_logicalinterfaces: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an edge logical interface. Create,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID body = PureCloudPlatformClientV2.DomainLogicalInterface() # DomainLogicalInterface | Logical interface try: # Create an edge logical interface. api_response = api_instance.post_telephony_providers_edge_logicalinterfaces(edge_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_logicalinterfaces: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete an edge logical interface,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID interface_id = 'interface_id_example' # str | Interface ID try: # Delete an edge logical interface api_instance.delete_telephony_providers_edge_logicalinterface(edge_id, interface_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edge_logicalinterface: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an edge logical interface,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID interface_id = 'interface_id_example' # str | Interface ID expand = ['expand_example'] # list[str] | Field to expand in the response (optional) try: # Get an edge logical interface api_response = api_instance.get_telephony_providers_edge_logicalinterface(edge_id, interface_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_logicalinterface: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/telephony/providers/edges/{edgeId}/logicalinterfaces/{interfaceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an edge logical interface.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID interface_id = 'interface_id_example' # str | Interface ID body = PureCloudPlatformClientV2.DomainLogicalInterface() # DomainLogicalInterface | Logical interface try: # Update an edge logical interface. api_response = api_instance.put_telephony_providers_edge_logicalinterface(edge_id, interface_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->put_telephony_providers_edge_logicalinterface: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a job to upload a list of Edge logs.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID body = PureCloudPlatformClientV2.EdgeLogsJobRequest() # EdgeLogsJobRequest | EdgeLogsJobRequest try: # Create a job to upload a list of Edge logs. api_response = api_instance.post_telephony_providers_edge_logs_jobs(edge_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_logs_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an Edge logs 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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID job_id = 'job_id_example' # str | Job ID try: # Get an Edge logs job. api_response = api_instance.get_telephony_providers_edge_logs_job(edge_id, job_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_logs_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/logs/jobs/{jobId}/upload Genesys Cloud Python SDK.,Genesys describes this as an API used to: Request that the specified fileIds be uploaded from the Edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID job_id = 'job_id_example' # str | Job ID body = PureCloudPlatformClientV2.EdgeLogsJobUploadRequest() # EdgeLogsJobUploadRequest | Log upload request try: # Request that the specified fileIds be uploaded from the Edge. api_instance.post_telephony_providers_edge_logs_job_upload(edge_id, job_id, body) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_logs_job_upload: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/metrics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the edge metrics.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge Id try: # Get the edge metrics. api_response = api_instance.get_telephony_providers_edge_metrics(edge_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_metrics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve a list of all configured physical interfaces from a specific edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID try: # Retrieve a list of all configured physical interfaces from a specific edge. api_response = api_instance.get_telephony_providers_edge_physicalinterfaces(edge_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_physicalinterfaces: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/physicalinterfaces/{interfaceId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get edge physical interface. Retrieve a physical interface from a specific edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID interface_id = 'interface_id_example' # str | Interface ID try: # Get edge physical interface. api_response = api_instance.get_telephony_providers_edge_physicalinterface(edge_id, interface_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_physicalinterface: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/reboot Genesys Cloud Python SDK.,Genesys describes this as an API used to: Reboot an Edge,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID body = PureCloudPlatformClientV2.EdgeRebootParameters() # EdgeRebootParameters | Parameters for the edge reboot (optional) try: # Reboot an Edge api_response = api_instance.post_telephony_providers_edge_reboot(edge_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_reboot: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/setuppackage Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID try: # Get the setup package for a locally deployed edge device. This is needed to complete the setup process for the virtual edge. api_response = api_instance.get_telephony_providers_edge_setuppackage(edge_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_setuppackage: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/telephony/providers/edges/{edgeId}/softwareupdate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Cancels any in-progress update for this edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID try: # Cancels any in-progress update for this edge. api_instance.delete_telephony_providers_edge_softwareupdate(edge_id) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->delete_telephony_providers_edge_softwareupdate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/softwareupdate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets software update status information about any edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID try: # Gets software update status information about any edge. api_response = api_instance.get_telephony_providers_edge_softwareupdate(edge_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_softwareupdate: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/softwareupdate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Starts a software update for this edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID body = PureCloudPlatformClientV2.DomainEdgeSoftwareUpdateDto() # DomainEdgeSoftwareUpdateDto | Software update request try: # Starts a software update for this edge. api_response = api_instance.post_telephony_providers_edge_softwareupdate(edge_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_softwareupdate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/softwareversions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets all the available software versions for this edge.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID try: # Gets all the available software versions for this edge. api_response = api_instance.get_telephony_providers_edge_softwareversions(edge_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_softwareversions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/statuscode Genesys Cloud Python SDK.,Genesys describes this as an API used to: Take an Edge in or out of service,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID body = PureCloudPlatformClientV2.EdgeServiceStateRequest() # EdgeServiceStateRequest | Edge Service State (optional) try: # Take an Edge in or out of service api_response = api_instance.post_telephony_providers_edge_statuscode(edge_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_statuscode: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/telephony/providers/edges/{edgeId}/trunks Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of available trunks for the given Edge. Trunks are created by assigning trunk base settings to an Edge or Edge Group.,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge ID page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) sort_by = ''name'' # str | Value by which to sort (optional) (default to 'name') sort_order = ''ASC'' # str | Sort order (optional) (default to 'ASC') trunk_base_id = 'trunk_base_id_example' # str | Filter by Trunk Base Ids (optional) trunk_type = 'trunk_type_example' # str | Filter by a Trunk type (optional) try: # Get the list of available trunks for the given Edge. api_response = api_instance.get_telephony_providers_edge_trunks(edge_id, page_number=page_number, page_size=page_size, sort_by=sort_by, sort_order=sort_order, trunk_base_id=trunk_base_id, trunk_type=trunk_type) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->get_telephony_providers_edge_trunks: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/telephony/providers/edges/{edgeId}/unpair Genesys Cloud Python SDK.,Genesys describes this as an API used to: Unpair an Edge,"```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.TelephonyProvidersEdgeApi(); edge_id = 'edge_id_example' # str | Edge Id try: # Unpair an Edge api_response = api_instance.post_telephony_providers_edge_unpair(edge_id) pprint(api_response) except ApiException as e: print(""Exception when calling TelephonyProvidersEdgeApi->post_telephony_providers_edge_unpair: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/textbots/botflows/sessions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an execution instance of a bot flow definition. The launch is asynchronous; use the returned instance ID to post turns to it using 'POST /api/v2/textbots/botflows/sessions/{sessionId}/turns'.,"```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.TextbotsApi(); launch_request = PureCloudPlatformClientV2.TextBotFlowLaunchRequest() # TextBotFlowLaunchRequest | try: # Create an execution instance of a bot flow definition. api_response = api_instance.post_textbots_botflows_sessions(launch_request) pprint(api_response) except ApiException as e: print(""Exception when calling TextbotsApi->post_textbots_botflows_sessions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/textbots/botflows/sessions/{sessionId}/turns Genesys Cloud Python SDK.,Genesys describes this as an API used to: Issue a bot flow turn event. Send a turn event to an executing bot flow and produce the next action to take.,"```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.TextbotsApi(); session_id = 'session_id_example' # str | The bot flow session ID, typically obtained from 'POST /api/v2/textbots/botflows/sessions' turn_request = PureCloudPlatformClientV2.TextBotFlowTurnRequest() # TextBotFlowTurnRequest | try: # Issue a bot flow turn event api_response = api_instance.post_textbots_botflows_session_turns(session_id, turn_request) pprint(api_response) except ApiException as e: print(""Exception when calling TextbotsApi->post_textbots_botflows_session_turns: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/textbots/bots/execute Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send an intent to a bot to start a dialog/interact with it via text. This will either start a bot with the given id or relay a communication to an existing bot session.,"```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.TextbotsApi(); post_text_request = PureCloudPlatformClientV2.PostTextRequest() # PostTextRequest | try: # Send an intent to a bot to start a dialog/interact with it via text api_response = api_instance.post_textbots_bots_execute(post_text_request) pprint(api_response) except ApiException as e: print(""Exception when calling TextbotsApi->post_textbots_bots_execute: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/textbots/bots/search Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Find bots using the currently configured friendly name or ID. The name does allow case-insensitive partial string matches or by IDs (up to 50), but not both at the same time. Optionally you can limit the scope of the search by providing one or more bot types. You can specify the maximum results to return, up to a limit of 100","```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.TextbotsApi(); bot_type = ['bot_type_example'] # list[str] | Bot types (optional) bot_name = 'bot_name_example' # str | Bot name (optional) bot_id = ['bot_id_example'] # list[str] | Bot IDs (optional) page_size = 25 # int | The maximum results to return (optional) (default to 25) try: # Find bots using the currently configured friendly name or ID. api_response = api_instance.get_textbots_bots_search(bot_type=bot_type, bot_name=bot_name, bot_id=bot_id, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling TextbotsApi->get_textbots_bots_search: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/tokens/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete auth token used to make the request.,"```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.TokensApi(); try: # Delete auth token used to make the request. api_instance.delete_tokens_me() except ApiException as e: print(""Exception when calling TokensApi->delete_tokens_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/tokens/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch information about the current token,"```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.TokensApi(); preserve_idle_ttl = True # bool | preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset. (optional) try: # Fetch information about the current token api_response = api_instance.get_tokens_me(preserve_idle_ttl=preserve_idle_ttl) pprint(api_response) except ApiException as e: print(""Exception when calling TokensApi->get_tokens_me: %s\n"" % e)```" Provide a Python example that uses the HEAD /api/v2/tokens/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Verify user token,"```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.TokensApi(); try: # Verify user token api_instance.head_tokens_me() except ApiException as e: print(""Exception when calling TokensApi->head_tokens_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/tokens/timeout Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the current Idle Token Timeout 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.TokensApi(); try: # Get the current Idle Token Timeout Value api_response = api_instance.get_tokens_timeout() pprint(api_response) except ApiException as e: print(""Exception when calling TokensApi->get_tokens_timeout: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/tokens/timeout Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update or Enable/Disable the Idle Token Timeout,"```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.TokensApi(); body = PureCloudPlatformClientV2.IdleTokenTimeout() # IdleTokenTimeout | (optional) try: # Update or Enable/Disable the Idle Token Timeout api_response = api_instance.put_tokens_timeout(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling TokensApi->put_tokens_timeout: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/tokens/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete all auth tokens for the specified 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.TokensApi(); user_id = 'user_id_example' # str | User ID try: # Delete all auth tokens for the specified user. api_instance.delete_token(user_id) except ApiException as e: print(""Exception when calling TokensApi->delete_token: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/knowledge/documentuploads Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a presigned URL for uploading a knowledge import file with a set of documents,"```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.UploadsApi(); body = PureCloudPlatformClientV2.UploadUrlRequest() # UploadUrlRequest | query try: # Creates a presigned URL for uploading a knowledge import file with a set of documents api_response = api_instance.post_knowledge_documentuploads(body) pprint(api_response) except ApiException as e: print(""Exception when calling UploadsApi->post_knowledge_documentuploads: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/languageunderstanding/miners/{minerId}/uploads Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner,"```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.UploadsApi(); miner_id = 'miner_id_example' # str | Miner ID body = NULL # Empty | query try: # Creates a presigned URL for uploading a chat corpus which will be used for mining by intent miner api_response = api_instance.post_languageunderstanding_miner_uploads(miner_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UploadsApi->post_languageunderstanding_miner_uploads: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/uploads/learning/coverart Genesys Cloud Python SDK.,Genesys describes this as an API used to: Generates pre-signed URL to upload cover art for learning modules,"```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.UploadsApi(); body = PureCloudPlatformClientV2.LearningCoverArtUploadUrlRequest() # LearningCoverArtUploadUrlRequest | query try: # Generates pre-signed URL to upload cover art for learning modules api_response = api_instance.post_uploads_learning_coverart(body) pprint(api_response) except ApiException as e: print(""Exception when calling UploadsApi->post_uploads_learning_coverart: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/uploads/publicassets/images Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates presigned url for uploading a public asset image,"```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.UploadsApi(); body = PureCloudPlatformClientV2.UploadUrlRequest() # UploadUrlRequest | query try: # Creates presigned url for uploading a public asset image api_response = api_instance.post_uploads_publicassets_images(body) pprint(api_response) except ApiException as e: print(""Exception when calling UploadsApi->post_uploads_publicassets_images: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/uploads/recordings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates presigned url for uploading a recording file,"```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.UploadsApi(); body = PureCloudPlatformClientV2.UploadUrlRequest() # UploadUrlRequest | query try: # Creates presigned url for uploading a recording file api_response = api_instance.post_uploads_recordings(body) pprint(api_response) except ApiException as e: print(""Exception when calling UploadsApi->post_uploads_recordings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/uploads/workforcemanagement/historicaldata/csv Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates presigned url for uploading WFM historical data file. Requires data in csv format.,"```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.UploadsApi(); body = PureCloudPlatformClientV2.UploadUrlRequest() # UploadUrlRequest | query try: # Creates presigned url for uploading WFM historical data file. Requires data in csv format. api_response = api_instance.post_uploads_workforcemanagement_historicaldata_csv(body) pprint(api_response) except ApiException as e: print(""Exception when calling UploadsApi->post_uploads_workforcemanagement_historicaldata_csv: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/oauth/clients/{clientId}/usage/query Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Query for OAuth client API usage. After calling this method, you will then need to poll for the query results based on the returned execution 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.UsageApi(); client_id = 'client_id_example' # str | Client ID body = PureCloudPlatformClientV2.ApiUsageClientQuery() # ApiUsageClientQuery | Query try: # Query for OAuth client API usage api_response = api_instance.post_oauth_client_usage_query(client_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsageApi->post_oauth_client_usage_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/oauth/clients/{clientId}/usage/query/results/{executionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the results of a usage query,"```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.UsageApi(); execution_id = 'execution_id_example' # str | ID of the query execution client_id = 'client_id_example' # str | Client ID try: # Get the results of a usage query api_response = api_instance.get_oauth_client_usage_query_result(execution_id, client_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsageApi->get_oauth_client_usage_query_result: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/oauth/clients/{clientId}/usage/summary Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a summary of OAuth client API usage. After calling this method, you will then need to poll for the query results based on the returned execution 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.UsageApi(); client_id = 'client_id_example' # str | Client ID days = ''7'' # str | Previous number of days to query (optional) (default to '7') try: # Get a summary of OAuth client API usage api_response = api_instance.get_oauth_client_usage_summary(client_id, days=days) pprint(api_response) except ApiException as e: print(""Exception when calling UsageApi->get_oauth_client_usage_summary: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/usage/query Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Query organization API Usage -. After calling this method, you will then need to poll for the query results based on the returned execution 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.UsageApi(); body = PureCloudPlatformClientV2.ApiUsageOrganizationQuery() # ApiUsageOrganizationQuery | Query try: # Query organization API Usage - api_response = api_instance.post_usage_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsageApi->post_usage_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/usage/query/{executionId}/results Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the results of a usage query,"```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.UsageApi(); execution_id = 'execution_id_example' # str | ID of the query execution try: # Get the results of a usage query api_response = api_instance.get_usage_query_execution_id_results(execution_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsageApi->get_usage_query_execution_id_results: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/usage/simplesearch Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Search organization API Usage. After calling this method, you will then need to poll for the query results based on the returned execution Id. The number of records is limited to 20,000 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.UsageApi(); body = PureCloudPlatformClientV2.ApiUsageSimpleSearch() # ApiUsageSimpleSearch | SimpleSearch try: # Search organization API Usage api_response = api_instance.post_usage_simplesearch(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsageApi->post_usage_simplesearch: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/usage/simplesearch/{executionId}/results Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the results of a usage search. Number of records to be returned is limited to 20,000 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.UsageApi(); execution_id = 'execution_id_example' # str | ID of the search execution after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned (optional) page_size = 56 # int | The max number of entities to be returned per request. Maximum page size of 1000 (optional) try: # Get the results of a usage search. Number of records to be returned is limited to 20,000 results. api_response = api_instance.get_usage_simplesearch_execution_id_results(execution_id, after=after, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling UsageApi->get_usage_simplesearch_execution_id_results: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/userrecordings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of user recordings.,"```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.UserRecordingsApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get a list of user recordings. api_response = api_instance.get_userrecordings(page_size=page_size, page_number=page_number, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling UserRecordingsApi->get_userrecordings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/userrecordings/summary Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get user recording summary,"```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.UserRecordingsApi(); try: # Get user recording summary api_response = api_instance.get_userrecordings_summary() pprint(api_response) except ApiException as e: print(""Exception when calling UserRecordingsApi->get_userrecordings_summary: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/userrecordings/{recordingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a user recording.,"```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.UserRecordingsApi(); recording_id = 'recording_id_example' # str | User Recording ID try: # Delete a user recording. api_instance.delete_userrecording(recording_id) except ApiException as e: print(""Exception when calling UserRecordingsApi->delete_userrecording: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/userrecordings/{recordingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a user recording.,"```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.UserRecordingsApi(); recording_id = 'recording_id_example' # str | User Recording ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Get a user recording. api_response = api_instance.get_userrecording(recording_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling UserRecordingsApi->get_userrecording: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/userrecordings/{recordingId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a user recording.,"```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.UserRecordingsApi(); recording_id = 'recording_id_example' # str | User Recording ID body = PureCloudPlatformClientV2.UserRecording() # UserRecording | UserRecording expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) try: # Update a user recording. api_response = api_instance.put_userrecording(recording_id, body, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling UserRecordingsApi->put_userrecording: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/userrecordings/{recordingId}/transcoding Genesys Cloud Python SDK.,Genesys describes this as an API used to: Download a user recording.,"```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.UserRecordingsApi(); recording_id = 'recording_id_example' # str | User Recording ID format_id = ''WEBM'' # str | The desired media format. (optional) (default to 'WEBM') try: # Download a user recording. api_response = api_instance.get_userrecording_transcoding(recording_id, format_id=format_id) pprint(api_response) except ApiException as e: print(""Exception when calling UserRecordingsApi->get_userrecording_transcoding: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/users/activity/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user activity observations,"```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.UsersApi(); body = PureCloudPlatformClientV2.UserActivityQuery() # UserActivityQuery | query page_size = 56 # int | The desired page size (optional) page_number = 56 # int | The desired page number (optional) try: # Query for user activity observations api_response = api_instance.post_analytics_users_activity_query(body, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_analytics_users_activity_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/users/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user 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.UsersApi(); body = PureCloudPlatformClientV2.UserAggregationQuery() # UserAggregationQuery | query try: # Query for user aggregates api_response = api_instance.post_analytics_users_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_analytics_users_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/users/details/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user details 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.UsersApi(); body = PureCloudPlatformClientV2.AsyncUserDetailsQuery() # AsyncUserDetailsQuery | query try: # Query for user details asynchronously api_response = api_instance.post_analytics_users_details_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_analytics_users_details_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/users/details/jobs/availability Genesys Cloud Python SDK.,Genesys describes this as an API used to: Lookup the datalake availability date and time,"```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.UsersApi(); try: # Lookup the datalake availability date and time api_response = api_instance.get_analytics_users_details_jobs_availability() pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_analytics_users_details_jobs_availability: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/analytics/users/details/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete/cancel an async request,"```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.UsersApi(); job_id = 'job_id_example' # str | jobId try: # Delete/cancel an async request api_instance.delete_analytics_users_details_job(job_id) except ApiException as e: print(""Exception when calling UsersApi->delete_analytics_users_details_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/users/details/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get status for async query for user 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.UsersApi(); job_id = 'job_id_example' # str | jobId try: # Get status for async query for user details api_response = api_instance.get_analytics_users_details_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_analytics_users_details_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/analytics/users/details/jobs/{jobId}/results Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch a page of results for an async query,"```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.UsersApi(); job_id = 'job_id_example' # str | jobId cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional) page_size = 56 # int | The desired maximum number of results (optional) try: # Fetch a page of results for an async query api_response = api_instance.get_analytics_users_details_job_results(job_id, cursor=cursor, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_analytics_users_details_job_results: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/users/details/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user 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.UsersApi(); body = PureCloudPlatformClientV2.UserDetailsQuery() # UserDetailsQuery | query try: # Query for user details api_response = api_instance.post_analytics_users_details_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_analytics_users_details_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/analytics/users/observations/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query for user observations,"```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.UsersApi(); body = PureCloudPlatformClientV2.UserObservationQuery() # UserObservationQuery | query try: # Query for user observations api_response = api_instance.post_analytics_users_observations_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_analytics_users_observations_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/divisionspermitted/paged/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns which divisions the current user has the given permission in.,"```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.UsersApi(); permission = 'permission_example' # str | The permission string, including the object to access, e.g. routing:queue:view page_number = 1 # int | Page number (optional) (default to 1) page_size = 25 # int | Page size (optional) (default to 25) try: # Returns which divisions the current user has the given permission in. api_response = api_instance.get_authorization_divisionspermitted_paged_me(permission, page_number=page_number, page_size=page_size) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_authorization_divisionspermitted_paged_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/subjects/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns a listing of roles and permissions for the currently authenticated 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.UsersApi(); include_duplicates = False # bool | Include multiple entries with the same role and division but different subjects (optional) (default to False) try: # Returns a listing of roles and permissions for the currently authenticated user. api_response = api_instance.get_authorization_subjects_me(include_duplicates=include_duplicates) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_authorization_subjects_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/authorization/subjects/{subjectId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns a listing of roles and permissions for a 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.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) include_duplicates = False # bool | Include multiple entries with the same role and division but different subjects (optional) (default to False) try: # Returns a listing of roles and permissions for a user. api_response = api_instance.get_authorization_subject(subject_id, include_duplicates=include_duplicates) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_authorization_subject: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/subjects/{subjectId}/bulkadd Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk-grant roles and divisions to a subject.,"```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.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) body = PureCloudPlatformClientV2.RoleDivisionGrants() # RoleDivisionGrants | Pairs of role and division IDs subject_type = ''PC_USER'' # str | what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional) (default to 'PC_USER') try: # Bulk-grant roles and divisions to a subject. api_instance.post_authorization_subject_bulkadd(subject_id, body, subject_type=subject_type) except ApiException as e: print(""Exception when calling UsersApi->post_authorization_subject_bulkadd: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/subjects/{subjectId}/bulkremove Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk-remove grants from a subject.,"```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.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) body = PureCloudPlatformClientV2.RoleDivisionGrants() # RoleDivisionGrants | Pairs of role and division IDs try: # Bulk-remove grants from a subject. api_instance.post_authorization_subject_bulkremove(subject_id, body) except ApiException as e: print(""Exception when calling UsersApi->post_authorization_subject_bulkremove: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/subjects/{subjectId}/bulkreplace Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace subject's roles and divisions with the exact list supplied in the request. This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.,"```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.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) body = PureCloudPlatformClientV2.RoleDivisionGrants() # RoleDivisionGrants | Pairs of role and division IDs subject_type = ''PC_USER'' # str | what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional) (default to 'PC_USER') try: # Replace subject's roles and divisions with the exact list supplied in the request. api_instance.post_authorization_subject_bulkreplace(subject_id, body, subject_type=subject_type) except ApiException as e: print(""Exception when calling UsersApi->post_authorization_subject_bulkreplace: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a grant of a role in a division,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) division_id = 'division_id_example' # str | the id of the division of the grant role_id = 'role_id_example' # str | the id of the role of the grant try: # Delete a grant of a role in a division api_instance.delete_authorization_subject_division_role(subject_id, division_id, role_id) except ApiException as e: print(""Exception when calling UsersApi->delete_authorization_subject_division_role: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Make a grant of a role in a division,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.UsersApi(); subject_id = 'subject_id_example' # str | Subject ID (user or group) division_id = 'division_id_example' # str | the id of the division to which to make the grant role_id = 'role_id_example' # str | the id of the role to grant subject_type = ''PC_USER'' # str | what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) (optional) (default to 'PC_USER') try: # Make a grant of a role in a division api_instance.post_authorization_subject_division_role(subject_id, division_id, role_id, subject_type=subject_type) except ApiException as e: print(""Exception when calling UsersApi->post_authorization_subject_division_role: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/directroutingbackup/settings/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.,"```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.UsersApi(); try: # Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default. api_instance.delete_routing_directroutingbackup_settings_me() except ApiException as e: print(""Exception when calling UsersApi->delete_routing_directroutingbackup_settings_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/directroutingbackup/settings/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the user's Direct Routing Backup settings.,"```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.UsersApi(); try: # Get the user's Direct Routing Backup settings. api_response = api_instance.get_routing_directroutingbackup_settings_me() pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_routing_directroutingbackup_settings_me: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/directroutingbackup/settings/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the user's Direct Routing Backup settings.,"```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.UsersApi(); body = PureCloudPlatformClientV2.AgentDirectRoutingBackupSettings() # AgentDirectRoutingBackupSettings | directRoutingBackup try: # Update the user's Direct Routing Backup settings. api_response = api_instance.put_routing_directroutingbackup_settings_me(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_routing_directroutingbackup_settings_me: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/users/{userId}/directroutingbackup/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default. api_instance.delete_routing_user_directroutingbackup_settings(user_id) except ApiException as e: print(""Exception when calling UsersApi->delete_routing_user_directroutingbackup_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/users/{userId}/directroutingbackup/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the user's Direct Routing Backup settings.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Get the user's Direct Routing Backup settings. api_response = api_instance.get_routing_user_directroutingbackup_settings(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_routing_user_directroutingbackup_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/users/{userId}/directroutingbackup/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the user's Direct Routing Backup settings.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.AgentDirectRoutingBackupSettings() # AgentDirectRoutingBackupSettings | directRoutingBackup try: # Update the user's Direct Routing Backup settings. api_response = api_instance.put_routing_user_directroutingbackup_settings(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_routing_user_directroutingbackup_settings: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/routing/users/{userId}/utilization Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete the user's max utilization settings and revert to the organization-wide default.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Delete the user's max utilization settings and revert to the organization-wide default. api_instance.delete_routing_user_utilization(user_id) except ApiException as e: print(""Exception when calling UsersApi->delete_routing_user_utilization: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/routing/users/{userId}/utilization Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the user's max utilization settings. If not configured, the organization-wide default is 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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Get the user's max utilization settings. If not configured, the organization-wide default is returned. api_response = api_instance.get_routing_user_utilization(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_routing_user_utilization: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/routing/users/{userId}/utilization Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the user's max utilization settings. Include only those media types requiring custom 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UtilizationRequest() # UtilizationRequest | utilization try: # Update the user's max utilization settings. Include only those media types requiring custom configuration. api_response = api_instance.put_routing_user_utilization(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_routing_user_utilization: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of available users.,"```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.UsersApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) id = ['id_example'] # list[str] | A list of user IDs to fetch by bulk (optional) jabber_id = ['jabber_id_example'] # list[str] | A list of jabberIds to fetch by bulk (cannot be used with the \""id\"" parameter) (optional) sort_order = ''ASC'' # str | Ascending or descending sort order (optional) (default to 'ASC') expand = ['expand_example'] # list[str] | Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. (optional) integration_presence_source = 'integration_presence_source_example' # str | Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an \""expand\"". When using this parameter the maximum number of users that can be returned is 100. (optional) state = ''active'' # str | Only list users of this state (optional) (default to 'active') try: # Get the list of available users. api_response = api_instance.get_users(page_size=page_size, page_number=page_number, id=id, jabber_id=jabber_id, sort_order=sort_order, expand=expand, integration_presence_source=integration_presence_source, state=state) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_users: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Create user. If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password 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.UsersApi(); body = PureCloudPlatformClientV2.CreateUser() # CreateUser | User try: # Create user api_response = api_instance.post_users(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_users: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update bulk acd autoanswer on users. Max 50 users can be updated at a time.,"```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.UsersApi(); body = [PureCloudPlatformClientV2.PatchUser()] # list[PatchUser] | Users try: # Update bulk acd autoanswer on users. Max 50 users can be updated at a time. api_response = api_instance.patch_users_bulk(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_users_bulk: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/development/activities Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of Development Activities. Either moduleId or userId is required. Results are filtered based on the applicable permissions.,"```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.UsersApi(); user_id = ['user_id_example'] # list[str] | Specifies the list of user IDs to be queried, up to 100 user IDs. It searches for any relationship for the userId. (optional) module_id = 'module_id_example' # str | Specifies the ID of the learning module. (optional) interval = 'interval_example' # str | Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) completion_interval = 'completion_interval_example' # str | Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) overdue = ''Any'' # str | Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (optional) (default to 'Any') pcPass = ''Any'' # str | Specifies if only the failed (pass is \""False\"") or passed (pass is \""True\"") activities are returned. If pass is \""Any\"" or if the pass parameter is not supplied, all activities are returned (optional) (default to 'Any') page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''Desc'' # str | Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (optional) (default to 'Desc') types = ['types_example'] # list[str] | Specifies the activity types. Informational, AssessedContent and Assessment are deprecated (optional) statuses = ['statuses_example'] # list[str] | Specifies the activity statuses to filter by (optional) relationship = ['relationship_example'] # list[str] | Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied. (optional) try: # Get list of Development Activities api_response = api_instance.get_users_development_activities(user_id=user_id, module_id=module_id, interval=interval, completion_interval=completion_interval, overdue=overdue, pcPass=pcPass, page_size=page_size, page_number=page_number, sort_order=sort_order, types=types, statuses=statuses, relationship=relationship) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_users_development_activities: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/development/activities/aggregates/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieve aggregated development activity data. Results are filtered based on the applicable permissions.,"```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.UsersApi(); body = PureCloudPlatformClientV2.DevelopmentActivityAggregateParam() # DevelopmentActivityAggregateParam | Aggregate Request try: # Retrieve aggregated development activity data api_response = api_instance.post_users_development_activities_aggregates_query(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_users_development_activities_aggregates_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/development/activities/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of Development Activities for current user. Results are filtered based on the applicable permissions.,"```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.UsersApi(); module_id = 'module_id_example' # str | Specifies the ID of the learning module. (optional) interval = 'interval_example' # str | Specifies the dateDue range to be queried. Milliseconds will be truncated. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) completion_interval = 'completion_interval_example' # str | Specifies the range of completion dates to be used for filtering. A maximum of 1 year can be specified in the range. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional) overdue = ''Any'' # str | Specifies if non-overdue, overdue, or all activities are returned. If not specified, all activities are returned (optional) (default to 'Any') pcPass = ''Any'' # str | Specifies if only the failed (pass is \""False\"") or passed (pass is \""True\"") activities are returned. If pass is \""Any\"" or if the pass parameter is not supplied, all activities are returned (optional) (default to 'Any') page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''Desc'' # str | Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (optional) (default to 'Desc') types = ['types_example'] # list[str] | Specifies the activity types. Informational, AssessedContent and Assessment are deprecated (optional) statuses = ['statuses_example'] # list[str] | Specifies the activity statuses to filter by (optional) relationship = ['relationship_example'] # list[str] | Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied. (optional) try: # Get list of Development Activities for current user api_response = api_instance.get_users_development_activities_me(module_id=module_id, interval=interval, completion_interval=completion_interval, overdue=overdue, pcPass=pcPass, page_size=page_size, page_number=page_number, sort_order=sort_order, types=types, statuses=statuses, relationship=relationship) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_users_development_activities_me: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/development/activities/{activityId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get a Development Activity. Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.","```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.UsersApi(); activity_id = 'activity_id_example' # str | Specifies the activity ID, maps to either assignment or appointment ID type = 'type_example' # str | Specifies the activity type. Informational, AssessedContent and Assessment are deprecated try: # Get a Development Activity api_response = api_instance.get_users_development_activity(activity_id, type) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_users_development_activity: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/me Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get current user details. This request is not valid when using the Client Credentials OAuth grant.,"```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.UsersApi(); expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional) integration_presence_source = 'integration_presence_source_example' # str | Get your presence for a given integration. This parameter will only be used when presence is provided as an \""expand\"". (optional) try: # Get current user details. api_response = api_instance.get_users_me(expand=expand, integration_presence_source=integration_presence_source) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_users_me: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/me/password Genesys Cloud Python SDK.,Genesys describes this as an API used to: Change your password,"```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.UsersApi(); body = PureCloudPlatformClientV2.ChangeMyPasswordRequest() # ChangeMyPasswordRequest | Password try: # Change your password api_instance.post_users_me_password(body) except ApiException as e: print(""Exception when calling UsersApi->post_users_me_password: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search users using the q64 value returned from a previous search,"```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.UsersApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | expand (optional) integration_presence_source = 'integration_presence_source_example' # str | integrationPresenceSource (optional) try: # Search users using the q64 value returned from a previous search api_response = api_instance.get_users_search(q64, expand=expand, integration_presence_source=integration_presence_source) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_users_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search users,"```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.UsersApi(); body = PureCloudPlatformClientV2.UserSearchRequest() # UserSearchRequest | Search request options try: # Search users api_response = api_instance.post_users_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_users_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/search/teams/assign Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search users assigned to teams,"```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.UsersApi(); body = PureCloudPlatformClientV2.UserSearchRequest() # UserSearchRequest | Search request options try: # Search users assigned to teams api_response = api_instance.post_users_search_teams_assign(body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_users_search_teams_assign: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{subjectId}/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns a listing of roles and permissions for a 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.UsersApi(); subject_id = 'subject_id_example' # str | User ID try: # Returns a listing of roles and permissions for a user. api_response = api_instance.get_user_roles(subject_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_roles: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{subjectId}/roles Genesys Cloud Python SDK.,Genesys describes this as an API used to: Sets the user's roles,"```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.UsersApi(); subject_id = 'subject_id_example' # str | User ID body = ['body_example'] # list[str] | List of roles try: # Sets the user's roles api_response = api_instance.put_user_roles(subject_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_roles: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete 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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Delete user api_response = api_instance.delete_user(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->delete_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get 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.UsersApi(); user_id = 'user_id_example' # str | User ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead. (optional) integration_presence_source = 'integration_presence_source_example' # str | Gets an integration presence for a user instead of their default. (optional) state = ''active'' # str | Search for a user with this state (optional) (default to 'active') try: # Get user. api_response = api_instance.get_user(user_id, expand=expand, integration_presence_source=integration_presence_source, state=state) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UpdateUser() # UpdateUser | User try: # Update user api_response = api_instance.patch_user(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/adjacents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get adjacents,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) try: # Get adjacents api_response = api_instance.get_user_adjacents(user_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_adjacents: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/callforwarding Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a user's CallForwarding,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Get a user's CallForwarding api_response = api_instance.get_user_callforwarding(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_callforwarding: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/callforwarding Genesys Cloud Python SDK.,Genesys describes this as an API used to: Patch a user's CallForwarding,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.CallForwarding() # CallForwarding | Call forwarding try: # Patch a user's CallForwarding api_response = api_instance.patch_user_callforwarding(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_callforwarding: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/callforwarding Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a user's CallForwarding,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.CallForwarding() # CallForwarding | Call forwarding try: # Update a user's CallForwarding api_response = api_instance.put_user_callforwarding(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_callforwarding: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/directreports Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get direct reports,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) try: # Get direct reports api_response = api_instance.get_user_directreports(user_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_directreports: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/{userId}/externalid Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create mapping between external identifier and user. Limit 100 per entity. Authority Name and External key are case sensitive.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UserExternalIdentifier() # UserExternalIdentifier | try: # Create mapping between external identifier and user. Limit 100 per entity. api_response = api_instance.post_user_externalid(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_user_externalid: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/geolocations/{clientId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a user's Geolocation,"```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.UsersApi(); user_id = 'user_id_example' # str | user Id client_id = 'client_id_example' # str | client Id try: # Get a user's Geolocation api_response = api_instance.get_user_geolocation(user_id, client_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_geolocation: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/geolocations/{clientId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Patch a user's Geolocation. The geolocation object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the client as the user's primary geolocation source. Option 2: Provide the 'latitude' and 'longitude' values. This will enqueue an asynchronous update of the 'city', 'region', and 'country', generating a notification. A subsequent GET operation will include the new values for 'city', 'region' and 'country'. Option 3: Provide the 'city', 'region', 'country' values. Option 1 can be combined with Option 2 or Option 3. For example, update the client as primary and provide latitude and longitude values.","```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.UsersApi(); user_id = 'user_id_example' # str | user Id client_id = 'client_id_example' # str | client Id body = PureCloudPlatformClientV2.Geolocation() # Geolocation | Geolocation try: # Patch a user's Geolocation api_response = api_instance.patch_user_geolocation(user_id, client_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_geolocation: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/{userId}/invite Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send an activation email to the 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.UsersApi(); user_id = 'user_id_example' # str | User ID force = False # bool | Resend the invitation even if one is already outstanding (optional) (default to False) try: # Send an activation email to the user api_instance.post_user_invite(user_id, force=force) except ApiException as e: print(""Exception when calling UsersApi->post_user_invite: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/outofoffice Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a OutOfOffice,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Get a OutOfOffice api_response = api_instance.get_user_outofoffice(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_outofoffice: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/outofoffice Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an OutOfOffice,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.OutOfOffice() # OutOfOffice | The updated OutOffOffice try: # Update an OutOfOffice api_response = api_instance.put_user_outofoffice(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_outofoffice: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/{userId}/password Genesys Cloud Python SDK.,Genesys describes this as an API used to: Change a users password,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.ChangePasswordRequest() # ChangePasswordRequest | Password try: # Change a users password api_instance.post_user_password(user_id, body) except ApiException as e: print(""Exception when calling UsersApi->post_user_password: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/profileskills Genesys Cloud Python SDK.,Genesys describes this as an API used to: List profile skills for a 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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # List profile skills for a user api_response = api_instance.get_user_profileskills(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_profileskills: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/profileskills Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update profile skills for a 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = ['body_example'] # list[str] | Skills try: # Update profile skills for a user api_response = api_instance.put_user_profileskills(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_profileskills: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/queues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get queues for 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.UsersApi(); user_id = 'user_id_example' # str | User ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) joined = True # bool | Is joined to the queue (optional) (default to True) division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) try: # Get queues for user api_response = api_instance.get_user_queues(user_id, page_size=page_size, page_number=page_number, joined=joined, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_queues: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/queues Genesys Cloud Python SDK.,Genesys describes this as an API used to: Join or unjoin a set of queues for a 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = [PureCloudPlatformClientV2.UserQueue()] # list[UserQueue] | User Queues division_id = ['division_id_example'] # list[str] | Division ID(s) (optional) try: # Join or unjoin a set of queues for a user api_response = api_instance.patch_user_queues(user_id, body, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_queues: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/queues/{queueId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Join or unjoin a queue for a 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.UsersApi(); queue_id = 'queue_id_example' # str | Queue ID user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UserQueue() # UserQueue | Queue Member try: # Join or unjoin a queue for a user api_response = api_instance.patch_user_queue(queue_id, user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_queue: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/routinglanguages Genesys Cloud Python SDK.,Genesys describes this as an API used to: List routing language for 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.UsersApi(); user_id = 'user_id_example' # str | User ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''ASC'' # str | Ascending or descending sort order (optional) (default to 'ASC') try: # List routing language for user api_response = api_instance.get_user_routinglanguages(user_id, page_size=page_size, page_number=page_number, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_routinglanguages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/{userId}/routinglanguages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add routing language to 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UserRoutingLanguagePost() # UserRoutingLanguagePost | Language try: # Add routing language to user api_response = api_instance.post_user_routinglanguages(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_user_routinglanguages: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/routinglanguages/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add bulk routing language to user. Max limit 50 languages,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID body = [PureCloudPlatformClientV2.UserRoutingLanguagePost()] # list[UserRoutingLanguagePost] | Language try: # Add bulk routing language to user. Max limit 50 languages api_response = api_instance.patch_user_routinglanguages_bulk(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_routinglanguages_bulk: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/users/{userId}/routinglanguages/{languageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove routing language from 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.UsersApi(); user_id = 'user_id_example' # str | User ID language_id = 'language_id_example' # str | languageId try: # Remove routing language from user api_instance.delete_user_routinglanguage(user_id, language_id) except ApiException as e: print(""Exception when calling UsersApi->delete_user_routinglanguage: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/routinglanguages/{languageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update routing language proficiency or state.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.UsersApi(); user_id = 'user_id_example' # str | User ID language_id = 'language_id_example' # str | languageId body = PureCloudPlatformClientV2.UserRoutingLanguage() # UserRoutingLanguage | Language try: # Update routing language proficiency or state. api_response = api_instance.patch_user_routinglanguage(user_id, language_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_routinglanguage: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/routingskills Genesys Cloud Python SDK.,Genesys describes this as an API used to: List routing skills for 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.UsersApi(); user_id = 'user_id_example' # str | User ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) sort_order = ''ASC'' # str | Ascending or descending sort order (optional) (default to 'ASC') try: # List routing skills for user api_response = api_instance.get_user_routingskills(user_id, page_size=page_size, page_number=page_number, sort_order=sort_order) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_routingskills: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/users/{userId}/routingskills Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add routing skill to 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UserRoutingSkillPost() # UserRoutingSkillPost | Skill try: # Add routing skill to user api_response = api_instance.post_user_routingskills(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->post_user_routingskills: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/users/{userId}/routingskills/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk add routing skills to 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = [PureCloudPlatformClientV2.UserRoutingSkillPost()] # list[UserRoutingSkillPost] | Skill try: # Bulk add routing skills to user api_response = api_instance.patch_user_routingskills_bulk(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->patch_user_routingskills_bulk: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/routingskills/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Replace all routing skills assigned to a 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = [PureCloudPlatformClientV2.UserRoutingSkillPost()] # list[UserRoutingSkillPost] | Skill try: # Replace all routing skills assigned to a user api_response = api_instance.put_user_routingskills_bulk(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_routingskills_bulk: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/users/{userId}/routingskills/{skillId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove routing skill from 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.UsersApi(); user_id = 'user_id_example' # str | User ID skill_id = 'skill_id_example' # str | skillId try: # Remove routing skill from user api_instance.delete_user_routingskill(user_id, skill_id) except ApiException as e: print(""Exception when calling UsersApi->delete_user_routingskill: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/routingskills/{skillId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update routing skill proficiency or state.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.UsersApi(); user_id = 'user_id_example' # str | User ID skill_id = 'skill_id_example' # str | skillId body = PureCloudPlatformClientV2.UserRoutingSkill() # UserRoutingSkill | Skill try: # Update routing skill proficiency or state. api_response = api_instance.put_user_routingskill(user_id, skill_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_routingskill: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/routingstatus Genesys Cloud Python SDK.,Genesys describes this as an API used to: Fetch the routing status of a 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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Fetch the routing status of a user api_response = api_instance.get_user_routingstatus(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_routingstatus: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/routingstatus Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the routing status of a 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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.RoutingStatus() # RoutingStatus | Routing Status try: # Update the routing status of a user api_response = api_instance.put_user_routingstatus(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_routingstatus: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/skillgroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get skill groups for a 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.UsersApi(); user_id = 'user_id_example' # str | User ID page_size = 25 # int | Page size (optional) (default to 25) after = 'after_example' # str | The cursor that points to the next page (optional) before = 'before_example' # str | The cursor that points to the previous page (optional) try: # Get skill groups for a user api_response = api_instance.get_user_skillgroups(user_id, page_size=page_size, after=after, before=before) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_skillgroups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/state Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get user state information.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Get user state information. api_response = api_instance.get_user_state(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_state: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/state Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update user state information.,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.UserState() # UserState | User try: # Update user state information. api_response = api_instance.put_user_state(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_state: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/station Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get station information for 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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Get station information for user api_response = api_instance.get_user_station(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_station: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/users/{userId}/station/associatedstation Genesys Cloud Python SDK.,Genesys describes this as an API used to: Clear associated station,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Clear associated station api_instance.delete_user_station_associatedstation(user_id) except ApiException as e: print(""Exception when calling UsersApi->delete_user_station_associatedstation: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/station/associatedstation/{stationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set associated station,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID station_id = 'station_id_example' # str | stationId try: # Set associated station api_instance.put_user_station_associatedstation_station_id(user_id, station_id) except ApiException as e: print(""Exception when calling UsersApi->put_user_station_associatedstation_station_id: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/users/{userId}/station/defaultstation Genesys Cloud Python SDK.,Genesys describes this as an API used to: Clear default station,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Clear default station api_instance.delete_user_station_defaultstation(user_id) except ApiException as e: print(""Exception when calling UsersApi->delete_user_station_defaultstation: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/station/defaultstation/{stationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set default station,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID station_id = 'station_id_example' # str | stationId try: # Set default station api_instance.put_user_station_defaultstation_station_id(user_id, station_id) except ApiException as e: print(""Exception when calling UsersApi->put_user_station_defaultstation_station_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/superiors Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get superiors,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional) try: # Get superiors api_response = api_instance.get_user_superiors(user_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_superiors: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/trustors Genesys Cloud Python SDK.,Genesys describes this as an API used to: List the organizations that have authorized/trusted the 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.UsersApi(); user_id = 'user_id_example' # str | User ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # List the organizations that have authorized/trusted the user. api_response = api_instance.get_user_trustors(user_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_trustors: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/users/{userId}/verifiers Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of verifiers,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID try: # Get a list of verifiers api_response = api_instance.get_user_verifiers(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->get_user_verifiers: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/users/{userId}/verifiers/{verifierId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a verifier,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID verifier_id = 'verifier_id_example' # str | Verifier ID try: # Delete a verifier api_instance.delete_user_verifier(user_id, verifier_id) except ApiException as e: print(""Exception when calling UsersApi->delete_user_verifier: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/users/{userId}/verifiers/{verifierId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a verifier,"```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.UsersApi(); user_id = 'user_id_example' # str | User ID verifier_id = 'verifier_id_example' # str | Verifier ID body = PureCloudPlatformClientV2.UpdateVerifierRequest() # UpdateVerifierRequest | Verifier Update try: # Update a verifier api_response = api_instance.put_user_verifier(user_id, verifier_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling UsersApi->put_user_verifier: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/certificate/details Genesys Cloud Python SDK.,Genesys describes this as an API used to: Returns the information about an X509 PEM encoded certificate or certificate chain.,"```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.UtilitiesApi(); body = PureCloudPlatformClientV2.Certificate() # Certificate | Certificate try: # Returns the information about an X509 PEM encoded certificate or certificate chain. api_response = api_instance.post_certificate_details(body) pprint(api_response) except ApiException as e: print(""Exception when calling UtilitiesApi->post_certificate_details: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/date Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the current system date/time,"```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.UtilitiesApi(); try: # Get the current system date/time api_response = api_instance.get_date() pprint(api_response) except ApiException as e: print(""Exception when calling UtilitiesApi->get_date: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/ipranges Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get public ip address ranges for Genesys Cloud,"```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.UtilitiesApi(); try: # Get public ip address ranges for Genesys Cloud api_response = api_instance.get_ipranges() pprint(api_response) except ApiException as e: print(""Exception when calling UtilitiesApi->get_ipranges: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/timezones Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get time zones list,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.UtilitiesApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get time zones list api_response = api_instance.get_timezones(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling UtilitiesApi->get_timezones: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/groups/{groupId}/mailbox Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the group's mailbox information,"```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.VoicemailApi(); group_id = 'group_id_example' # str | groupId try: # Get the group's mailbox information api_response = api_instance.get_voicemail_group_mailbox(group_id) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_group_mailbox: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/groups/{groupId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: List voicemail 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.VoicemailApi(); group_id = 'group_id_example' # str | Group ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # List voicemail messages api_response = api_instance.get_voicemail_group_messages(group_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_group_messages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/groups/{groupId}/policy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a group's voicemail policy,"```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.VoicemailApi(); group_id = 'group_id_example' # str | Group ID try: # Get a group's voicemail policy api_response = api_instance.get_voicemail_group_policy(group_id) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_group_policy: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/voicemail/groups/{groupId}/policy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a group's voicemail policy,"```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.VoicemailApi(); group_id = 'group_id_example' # str | Group ID body = PureCloudPlatformClientV2.VoicemailGroupPolicy() # VoicemailGroupPolicy | The group's voicemail policy try: # Update a group's voicemail policy api_response = api_instance.patch_voicemail_group_policy(group_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->patch_voicemail_group_policy: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/mailbox Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the current user's mailbox information,"```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.VoicemailApi(); try: # Get the current user's mailbox information api_response = api_instance.get_voicemail_mailbox() pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_mailbox: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/me/mailbox Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the current user's mailbox information,"```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.VoicemailApi(); try: # Get the current user's mailbox information api_response = api_instance.get_voicemail_me_mailbox() pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_me_mailbox: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/me/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: List voicemail 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.VoicemailApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # List voicemail messages api_response = api_instance.get_voicemail_me_messages(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_me_messages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/me/policy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the current user's voicemail policy,"```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.VoicemailApi(); try: # Get the current user's voicemail policy api_response = api_instance.get_voicemail_me_policy() pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_me_policy: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/voicemail/me/policy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the current user's voicemail policy,"```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.VoicemailApi(); body = PureCloudPlatformClientV2.VoicemailUserPolicy() # VoicemailUserPolicy | The user's voicemail policy try: # Update the current user's voicemail policy api_response = api_instance.patch_voicemail_me_policy(body) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->patch_voicemail_me_policy: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/voicemail/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete all voicemail 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.VoicemailApi(); try: # Delete all voicemail messages api_instance.delete_voicemail_messages() except ApiException as e: print(""Exception when calling VoicemailApi->delete_voicemail_messages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: List voicemail 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.VoicemailApi(); ids = 'ids_example' # str | An optional comma separated list of VoicemailMessage ids (optional) expand = ['expand_example'] # list[str] | If the caller is a known user, which fields, if any, to expand (optional) try: # List voicemail messages api_response = api_instance.get_voicemail_messages(ids=ids, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_messages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/voicemail/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Copy a voicemail message to a user or group,"```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.VoicemailApi(); body = PureCloudPlatformClientV2.CopyVoicemailMessage() # CopyVoicemailMessage | (optional) try: # Copy a voicemail message to a user or group api_response = api_instance.post_voicemail_messages(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->post_voicemail_messages: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/voicemail/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a voicemail message. A user voicemail can only be deleted by its associated user. A group voicemail can only be deleted by a user that is a member of the group. A queue voicemail can only be deleted by a user with the acd voicemail delete permission.,"```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.VoicemailApi(); message_id = 'message_id_example' # str | Message ID try: # Delete a voicemail message. api_instance.delete_voicemail_message(message_id) except ApiException as e: print(""Exception when calling VoicemailApi->delete_voicemail_message: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a voicemail message,"```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.VoicemailApi(); message_id = 'message_id_example' # str | Message ID expand = ['expand_example'] # list[str] | If the caller is a known user, which fields, if any, to expand (optional) try: # Get a voicemail message api_response = api_instance.get_voicemail_message(message_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_message: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/voicemail/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a voicemail message. A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.,"```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.VoicemailApi(); message_id = 'message_id_example' # str | Message ID body = PureCloudPlatformClientV2.VoicemailMessage() # VoicemailMessage | VoicemailMessage try: # Update a voicemail message api_response = api_instance.patch_voicemail_message(message_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->patch_voicemail_message: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/voicemail/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a voicemail message. A user voicemail can only be modified by its associated user. A group voicemail can only be modified by a user that is a member of the group. A queue voicemail can only be modified by a participant of the conversation the voicemail is associated with.,"```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.VoicemailApi(); message_id = 'message_id_example' # str | Message ID body = PureCloudPlatformClientV2.VoicemailMessage() # VoicemailMessage | VoicemailMessage try: # Update a voicemail message api_response = api_instance.put_voicemail_message(message_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->put_voicemail_message: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/messages/{messageId}/media Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get media playback URI for this voicemail message,"```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.VoicemailApi(); message_id = 'message_id_example' # str | Message ID format_id = ''WEBM'' # str | The desired media format. (optional) (default to 'WEBM') try: # Get media playback URI for this voicemail message api_response = api_instance.get_voicemail_message_media(message_id, format_id=format_id) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_message_media: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/policy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a policy,"```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.VoicemailApi(); try: # Get a policy api_response = api_instance.get_voicemail_policy() pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_policy: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/voicemail/policy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a policy,"```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.VoicemailApi(); body = PureCloudPlatformClientV2.VoicemailOrganizationPolicy() # VoicemailOrganizationPolicy | Policy try: # Update a policy api_response = api_instance.put_voicemail_policy(body) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->put_voicemail_policy: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/queues/{queueId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: List voicemail 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.VoicemailApi(); queue_id = 'queue_id_example' # str | Queue ID page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # List voicemail messages api_response = api_instance.get_voicemail_queue_messages(queue_id, page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_queue_messages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search voicemails using the q64 value returned from a previous search,"```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.VoicemailApi(); q64 = 'q64_example' # str | q64 expand = ['expand_example'] # list[str] | expand (optional) try: # Search voicemails using the q64 value returned from a previous search api_response = api_instance.get_voicemail_search(q64, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/voicemail/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search voicemails,"```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.VoicemailApi(); body = PureCloudPlatformClientV2.VoicemailSearchRequest() # VoicemailSearchRequest | Search request options try: # Search voicemails api_response = api_instance.post_voicemail_search(body) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->post_voicemail_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/voicemail/userpolicies/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a user's voicemail policy,"```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.VoicemailApi(); user_id = 'user_id_example' # str | User ID try: # Get a user's voicemail policy api_response = api_instance.get_voicemail_userpolicy(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->get_voicemail_userpolicy: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/voicemail/userpolicies/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a user's voicemail policy,"```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.VoicemailApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.VoicemailUserPolicy() # VoicemailUserPolicy | The user's voicemail policy try: # Update a user's voicemail policy api_response = api_instance.patch_voicemail_userpolicy(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->patch_voicemail_userpolicy: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/voicemail/userpolicies/{userId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a user's voicemail policy,"```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.VoicemailApi(); user_id = 'user_id_example' # str | User ID body = PureCloudPlatformClientV2.VoicemailUserPolicy() # VoicemailUserPolicy | The user's voicemail policy try: # Update a user's voicemail policy api_response = api_instance.put_voicemail_userpolicy(user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling VoicemailApi->put_voicemail_userpolicy: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webdeployments/configurations Genesys Cloud Python SDK.,Genesys describes this as an API used to: View configuration drafts,"```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.WebDeploymentsApi(); show_only_published = False # bool | Get only configuration drafts with published versions (optional) (default to False) try: # View configuration drafts api_response = api_instance.get_webdeployments_configurations(show_only_published=show_only_published) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->get_webdeployments_configurations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/webdeployments/configurations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a configuration 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.WebDeploymentsApi(); configuration_version = PureCloudPlatformClientV2.WebDeploymentConfigurationVersion() # WebDeploymentConfigurationVersion | try: # Create a configuration draft api_response = api_instance.post_webdeployments_configurations(configuration_version) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->post_webdeployments_configurations: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/webdeployments/configurations/{configurationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete all versions of a 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.WebDeploymentsApi(); configuration_id = 'configuration_id_example' # str | The configuration version ID try: # Delete all versions of a configuration api_instance.delete_webdeployments_configuration(configuration_id) except ApiException as e: print(""Exception when calling WebDeploymentsApi->delete_webdeployments_configuration: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webdeployments/configurations/{configurationId}/versions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the versions of a configuration. This returns the 50 most recent versions for this 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.WebDeploymentsApi(); configuration_id = 'configuration_id_example' # str | The configuration version ID try: # Get the versions of a configuration api_response = api_instance.get_webdeployments_configuration_versions(configuration_id) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->get_webdeployments_configuration_versions: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webdeployments/configurations/{configurationId}/versions/draft Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the configuration 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.WebDeploymentsApi(); configuration_id = 'configuration_id_example' # str | The configuration version ID try: # Get the configuration draft api_response = api_instance.get_webdeployments_configuration_versions_draft(configuration_id) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->get_webdeployments_configuration_versions_draft: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/webdeployments/configurations/{configurationId}/versions/draft Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the configuration 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.WebDeploymentsApi(); configuration_id = 'configuration_id_example' # str | The configuration version ID configuration_version = PureCloudPlatformClientV2.WebDeploymentConfigurationVersion() # WebDeploymentConfigurationVersion | try: # Update the configuration draft api_response = api_instance.put_webdeployments_configuration_versions_draft(configuration_id, configuration_version) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->put_webdeployments_configuration_versions_draft: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/webdeployments/configurations/{configurationId}/versions/draft/publish Genesys Cloud Python SDK.,Genesys describes this as an API used to: Publish the configuration draft and create a new version,"```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.WebDeploymentsApi(); configuration_id = 'configuration_id_example' # str | The configuration version ID try: # Publish the configuration draft and create a new version api_response = api_instance.post_webdeployments_configuration_versions_draft_publish(configuration_id) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->post_webdeployments_configuration_versions_draft_publish: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webdeployments/configurations/{configurationId}/versions/{versionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a configuration version,"```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.WebDeploymentsApi(); configuration_id = 'configuration_id_example' # str | The configuration version ID version_id = 'version_id_example' # str | The version of the configuration to get try: # Get a configuration version api_response = api_instance.get_webdeployments_configuration_version(configuration_id, version_id) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->get_webdeployments_configuration_version: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webdeployments/deployments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get deployments,"```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.WebDeploymentsApi(); expand = ['expand_example'] # list[str] | The specified entity attributes will be filled. Comma separated values expected. (optional) try: # Get deployments api_response = api_instance.get_webdeployments_deployments(expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->get_webdeployments_deployments: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/webdeployments/deployments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a deployment,"```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.WebDeploymentsApi(); deployment = PureCloudPlatformClientV2.WebDeployment() # WebDeployment | try: # Create a deployment api_response = api_instance.post_webdeployments_deployments(deployment) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->post_webdeployments_deployments: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/webdeployments/deployments/{deploymentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a deployment,"```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.WebDeploymentsApi(); deployment_id = 'deployment_id_example' # str | The deployment ID try: # Delete a deployment api_instance.delete_webdeployments_deployment(deployment_id) except ApiException as e: print(""Exception when calling WebDeploymentsApi->delete_webdeployments_deployment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webdeployments/deployments/{deploymentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a deployment,"```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.WebDeploymentsApi(); deployment_id = 'deployment_id_example' # str | The deployment ID expand = ['expand_example'] # list[str] | The specified entity attributes will be filled. Comma separated values expected. (optional) try: # Get a deployment api_response = api_instance.get_webdeployments_deployment(deployment_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->get_webdeployments_deployment: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/webdeployments/deployments/{deploymentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a deployment,"```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.WebDeploymentsApi(); deployment_id = 'deployment_id_example' # str | The deployment ID deployment = PureCloudPlatformClientV2.WebDeployment() # WebDeployment | try: # Update a deployment api_response = api_instance.put_webdeployments_deployment(deployment_id, deployment) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->put_webdeployments_deployment: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a cobrowse session,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.WebDeploymentsApi(); deployment_id = 'deployment_id_example' # str | WebMessaging deployment ID session_id = 'session_id_example' # str | Cobrowse session id or join code try: # Deletes a cobrowse session api_response = api_instance.delete_webdeployments_deployment_cobrowse_session_id(deployment_id, session_id) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->delete_webdeployments_deployment_cobrowse_session_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webdeployments/deployments/{deploymentId}/cobrowse/{sessionId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves a cobrowse session,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.WebDeploymentsApi(); deployment_id = 'deployment_id_example' # str | WebMessaging deployment ID session_id = 'session_id_example' # str | Cobrowse session id or join code try: # Retrieves a cobrowse session api_response = api_instance.get_webdeployments_deployment_cobrowse_session_id(deployment_id, session_id) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->get_webdeployments_deployment_cobrowse_session_id: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webdeployments/deployments/{deploymentId}/configurations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get active configuration for a given deployment,"```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.WebDeploymentsApi(); deployment_id = 'deployment_id_example' # str | The deployment ID type = 'type_example' # str | Get active configuration on a deployment (optional) expand = ['expand_example'] # list[str] | Expand instructions for the return value (optional) try: # Get active configuration for a given deployment api_response = api_instance.get_webdeployments_deployment_configurations(deployment_id, type=type, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->get_webdeployments_deployment_configurations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/webdeployments/token/oauthcodegrantjwtexchange Genesys Cloud Python SDK.,Genesys describes this as an API used to: Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.WebDeploymentsApi(); body = PureCloudPlatformClientV2.WebDeploymentsOAuthExchangeRequest() # WebDeploymentsOAuthExchangeRequest | webDeploymentsOAuthExchangeRequest try: # Exchange an oAuth code (obtained using the Authorization Code Flow) for a JWT that can be used by webdeployments. api_response = api_instance.post_webdeployments_token_oauthcodegrantjwtexchange(body) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->post_webdeployments_token_oauthcodegrantjwtexchange: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/webdeployments/token/refresh Genesys Cloud Python SDK.,Genesys describes this as an API used to: Refresh a JWT.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.WebDeploymentsApi(); body = PureCloudPlatformClientV2.WebDeploymentsRefreshJWTRequest() # WebDeploymentsRefreshJWTRequest | (optional) try: # Refresh a JWT. api_response = api_instance.post_webdeployments_token_refresh(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WebDeploymentsApi->post_webdeployments_token_refresh: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/webdeployments/token/revoke Genesys Cloud Python SDK.,Genesys describes this as an API used to: Invalidate JWT,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.WebDeploymentsApi(); x_journey_session_id = 'x_journey_session_id_example' # str | The Customer's journey sessionId. (optional) x_journey_session_type = 'x_journey_session_type_example' # str | The Customer's journey session type. (optional) try: # Invalidate JWT api_instance.delete_webdeployments_token_revoke(x_journey_session_id=x_journey_session_id, x_journey_session_type=x_journey_session_type) except ApiException as e: print(""Exception when calling WebDeploymentsApi->delete_webdeployments_token_revoke: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/webchat/guest/conversations Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Create an ACD chat conversation from an external customer. This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the 'memberAuthToken' field should include his JWT as generated by the 'POST /api/v2/signeddata' resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the 'eventStreamUri' field of the response; the conversation is not routed until the event stream is attached.","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.WebChatApi(); body = PureCloudPlatformClientV2.CreateWebChatConversationRequest() # CreateWebChatConversationRequest | CreateConversationRequest try: # Create an ACD chat conversation from an external customer. api_response = api_instance.post_webchat_guest_conversations(body) pprint(api_response) except ApiException as e: print(""Exception when calling WebChatApi->post_webchat_guest_conversations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webchat/guest/conversations/{conversationId}/mediarequests Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all media requests to the guest in the conversation,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure API key authorization: Guest Chat JWT PureCloudPlatformClientV2.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. BEARER) for API key, if needed # PureCloudPlatformClientV2.configuration.api_key_prefix['Authorization'] = 'BEARER' # 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.WebChatApi(); conversation_id = 'conversation_id_example' # str | conversationId try: # Get all media requests to the guest in the conversation api_response = api_instance.get_webchat_guest_conversation_mediarequests(conversation_id) pprint(api_response) except ApiException as e: print(""Exception when calling WebChatApi->get_webchat_guest_conversation_mediarequests: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webchat/guest/conversations/{conversationId}/members Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the members of a chat conversation.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure API key authorization: Guest Chat JWT PureCloudPlatformClientV2.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. BEARER) for API key, if needed # PureCloudPlatformClientV2.configuration.api_key_prefix['Authorization'] = 'BEARER' # 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.WebChatApi(); conversation_id = 'conversation_id_example' # str | conversationId page_size = 25 # int | The number of entries to return per page, or omitted for the default. (optional) (default to 25) page_number = 1 # int | The page number to return, or omitted for the first page. (optional) (default to 1) exclude_disconnected_members = False # bool | If true, the results will not contain members who have a DISCONNECTED state. (optional) (default to False) try: # Get the members of a chat conversation. api_response = api_instance.get_webchat_guest_conversation_members(conversation_id, page_size=page_size, page_number=page_number, exclude_disconnected_members=exclude_disconnected_members) pprint(api_response) except ApiException as e: print(""Exception when calling WebChatApi->get_webchat_guest_conversation_members: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove a member from a chat conversation,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure API key authorization: Guest Chat JWT PureCloudPlatformClientV2.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. BEARER) for API key, if needed # PureCloudPlatformClientV2.configuration.api_key_prefix['Authorization'] = 'BEARER' # 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.WebChatApi(); conversation_id = 'conversation_id_example' # str | conversationId member_id = 'member_id_example' # str | memberId try: # Remove a member from a chat conversation api_instance.delete_webchat_guest_conversation_member(conversation_id, member_id) except ApiException as e: print(""Exception when calling WebChatApi->delete_webchat_guest_conversation_member: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a web chat conversation member,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure API key authorization: Guest Chat JWT PureCloudPlatformClientV2.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. BEARER) for API key, if needed # PureCloudPlatformClientV2.configuration.api_key_prefix['Authorization'] = 'BEARER' # 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.WebChatApi(); conversation_id = 'conversation_id_example' # str | conversationId member_id = 'member_id_example' # str | memberId try: # Get a web chat conversation member api_response = api_instance.get_webchat_guest_conversation_member(conversation_id, member_id) pprint(api_response) except ApiException as e: print(""Exception when calling WebChatApi->get_webchat_guest_conversation_member: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send a message in a chat conversation.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure API key authorization: Guest Chat JWT PureCloudPlatformClientV2.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. BEARER) for API key, if needed # PureCloudPlatformClientV2.configuration.api_key_prefix['Authorization'] = 'BEARER' # 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.WebChatApi(); conversation_id = 'conversation_id_example' # str | conversationId member_id = 'member_id_example' # str | memberId body = PureCloudPlatformClientV2.CreateWebChatMessageRequest() # CreateWebChatMessageRequest | Message try: # Send a message in a chat conversation. api_response = api_instance.post_webchat_guest_conversation_member_messages(conversation_id, member_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WebChatApi->post_webchat_guest_conversation_member_messages: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/webchat/guest/conversations/{conversationId}/members/{memberId}/typing Genesys Cloud Python SDK.,Genesys describes this as an API used to: Send a typing-indicator in a chat conversation.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure API key authorization: Guest Chat JWT PureCloudPlatformClientV2.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. BEARER) for API key, if needed # PureCloudPlatformClientV2.configuration.api_key_prefix['Authorization'] = 'BEARER' # 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.WebChatApi(); conversation_id = 'conversation_id_example' # str | conversationId member_id = 'member_id_example' # str | memberId try: # Send a typing-indicator in a chat conversation. api_response = api_instance.post_webchat_guest_conversation_member_typing(conversation_id, member_id) pprint(api_response) except ApiException as e: print(""Exception when calling WebChatApi->post_webchat_guest_conversation_member_typing: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webchat/guest/conversations/{conversationId}/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the messages of a chat conversation.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure API key authorization: Guest Chat JWT PureCloudPlatformClientV2.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. BEARER) for API key, if needed # PureCloudPlatformClientV2.configuration.api_key_prefix['Authorization'] = 'BEARER' # 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.WebChatApi(); conversation_id = 'conversation_id_example' # str | conversationId after = 'after_example' # str | If available, get the messages chronologically after the id of this message (optional) before = 'before_example' # str | If available, get the messages chronologically before the id of this message (optional) sort_order = ''ascending'' # str | Sort order (optional) (default to 'ascending') max_results = 100 # int | Limit the returned number of messages, up to a maximum of 100 (optional) (default to 100) try: # Get the messages of a chat conversation. api_response = api_instance.get_webchat_guest_conversation_messages(conversation_id, after=after, before=before, sort_order=sort_order, max_results=max_results) pprint(api_response) except ApiException as e: print(""Exception when calling WebChatApi->get_webchat_guest_conversation_messages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webchat/guest/conversations/{conversationId}/messages/{messageId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a web chat conversation message,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure API key authorization: Guest Chat JWT PureCloudPlatformClientV2.configuration.api_key['Authorization'] = 'YOUR_API_KEY' # Uncomment below to setup prefix (e.g. BEARER) for API key, if needed # PureCloudPlatformClientV2.configuration.api_key_prefix['Authorization'] = 'BEARER' # 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.WebChatApi(); conversation_id = 'conversation_id_example' # str | conversationId message_id = 'message_id_example' # str | messageId try: # Get a web chat conversation message api_response = api_instance.get_webchat_guest_conversation_message(conversation_id, message_id) pprint(api_response) except ApiException as e: print(""Exception when calling WebChatApi->get_webchat_guest_conversation_message: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/webchat/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Remove WebChat deployment settings,"```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.WebChatApi(); try: # Remove WebChat deployment settings api_instance.delete_webchat_settings() except ApiException as e: print(""Exception when calling WebChatApi->delete_webchat_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webchat/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get WebChat deployment settings,"```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.WebChatApi(); try: # Get WebChat deployment settings api_response = api_instance.get_webchat_settings() pprint(api_response) except ApiException as e: print(""Exception when calling WebChatApi->get_webchat_settings: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/webchat/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update WebChat deployment settings,"```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.WebChatApi(); body = PureCloudPlatformClientV2.WebChatSettings() # WebChatSettings | webChatSettings try: # Update WebChat deployment settings api_response = api_instance.put_webchat_settings(body) pprint(api_response) except ApiException as e: print(""Exception when calling WebChatApi->put_webchat_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/webmessaging/messages Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the messages for a web messaging session.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.WebMessagingApi(); page_size = 25 # int | Page size (optional) (default to 25) page_number = 1 # int | Page number (optional) (default to 1) try: # Get the messages for a web messaging session. api_response = api_instance.get_webmessaging_messages(page_size=page_size, page_number=page_number) pprint(api_response) except ApiException as e: print(""Exception when calling WebMessagingApi->get_webmessaging_messages: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/widgets/deployments Genesys Cloud Python SDK.,Genesys describes this as an API used to: List Widget deployments,"```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.WidgetsApi(); try: # List Widget deployments api_response = api_instance.get_widgets_deployments() pprint(api_response) except ApiException as e: print(""Exception when calling WidgetsApi->get_widgets_deployments: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/widgets/deployments Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create Widget deployment,"```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.WidgetsApi(); body = PureCloudPlatformClientV2.WidgetDeployment() # WidgetDeployment | Deployment try: # Create Widget deployment api_response = api_instance.post_widgets_deployments(body) pprint(api_response) except ApiException as e: print(""Exception when calling WidgetsApi->post_widgets_deployments: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/widgets/deployments/{deploymentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a Widget deployment,"```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.WidgetsApi(); deployment_id = 'deployment_id_example' # str | Widget Config Id try: # Delete a Widget deployment api_instance.delete_widgets_deployment(deployment_id) except ApiException as e: print(""Exception when calling WidgetsApi->delete_widgets_deployment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/widgets/deployments/{deploymentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a Widget deployment,"```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.WidgetsApi(); deployment_id = 'deployment_id_example' # str | Widget Config Id try: # Get a Widget deployment api_response = api_instance.get_widgets_deployment(deployment_id) pprint(api_response) except ApiException as e: print(""Exception when calling WidgetsApi->get_widgets_deployment: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/widgets/deployments/{deploymentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a Widget deployment,"```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.WidgetsApi(); deployment_id = 'deployment_id_example' # str | Widget Config Id body = PureCloudPlatformClientV2.WidgetDeployment() # WidgetDeployment | Deployment try: # Update a Widget deployment api_response = api_instance.put_widgets_deployment(deployment_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WidgetsApi->put_widgets_deployment: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/adherence Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of UserScheduleAdherence records for the requested users,"```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.WorkforceManagementApi(); user_id = ['user_id_example'] # list[str] | User Id(s) for which to fetch current schedule adherence information. Min 1, Max of 100 userIds per request try: # Get a list of UserScheduleAdherence records for the requested users api_response = api_instance.get_workforcemanagement_adherence(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_adherence: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/adherence/explanations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Submit an adherence explanation for the current 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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.AddAdherenceExplanationAgentRequest() # AddAdherenceExplanationAgentRequest | The request body try: # Submit an adherence explanation for the current user api_response = api_instance.post_workforcemanagement_adherence_explanations(body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_adherence_explanations: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/adherence/explanations/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the status of an adherence explanation operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response,"```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.WorkforceManagementApi(); job_id = 'job_id_example' # str | The ID of the job try: # Query the status of an adherence explanation operation. Only the user who started the operation can query the status api_response = api_instance.get_workforcemanagement_adherence_explanations_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_adherence_explanations_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/adherence/explanations/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query adherence explanations for the current 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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.AgentQueryAdherenceExplanationsRequest() # AgentQueryAdherenceExplanationsRequest | The request body force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Query adherence explanations for the current user api_response = api_instance.post_workforcemanagement_adherence_explanations_query(body, force_async=force_async, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_adherence_explanations_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/adherence/explanations/{explanationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an adherence explanation for the current 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.WorkforceManagementApi(); explanation_id = 'explanation_id_example' # str | The ID of the explanation to update try: # Get an adherence explanation for the current user api_response = api_instance.get_workforcemanagement_adherence_explanation(explanation_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_adherence_explanation: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/adherence/historical/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Request a historical adherence report in bulk,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.WfmHistoricalAdherenceBulkQuery() # WfmHistoricalAdherenceBulkQuery | body (optional) try: # Request a historical adherence report in bulk api_response = api_instance.post_workforcemanagement_adherence_historical_bulk(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_adherence_historical_bulk: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/adherence/historical/bulk/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response,"```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.WorkforceManagementApi(); job_id = 'job_id_example' # str | ID of the job to get try: # Request to fetch the status of the historical adherence bulk job. Only the user who started the operation can query the status api_response = api_instance.get_workforcemanagement_adherence_historical_bulk_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_adherence_historical_bulk_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/adherence/historical/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the status of a historical adherence request operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response,"```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.WorkforceManagementApi(); job_id = 'job_id_example' # str | jobId try: # Query the status of a historical adherence request operation. Only the user who started the operation can query the status api_response = api_instance.get_workforcemanagement_adherence_historical_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_adherence_historical_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/agents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Move agents in and out of management unit,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.MoveAgentsRequest() # MoveAgentsRequest | body (optional) try: # Move agents in and out of management unit api_response = api_instance.post_workforcemanagement_agents(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_agents: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/agents/integrations/hris/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query integrations for agents,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.QueryAgentsIntegrationsRequest() # QueryAgentsIntegrationsRequest | body (optional) try: # Query integrations for agents api_response = api_instance.post_workforcemanagement_agents_integrations_hris_query(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_agents_integrations_hris_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/agents/me/managementunit Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the management unit to which the currently logged in agent belongs,"```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.WorkforceManagementApi(); try: # Get the management unit to which the currently logged in agent belongs api_response = api_instance.get_workforcemanagement_agents_me_managementunit() pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_agents_me_managementunit: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/agents/me/possibleworkshifts Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get agent possible work shifts for requested time frame,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.AgentPossibleWorkShiftsRequest() # AgentPossibleWorkShiftsRequest | body try: # Get agent possible work shifts for requested time frame api_response = api_instance.post_workforcemanagement_agents_me_possibleworkshifts(body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_agents_me_possibleworkshifts: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add an adherence explanation for the requested 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.WorkforceManagementApi(); agent_id = 'agent_id_example' # str | The ID of the agent to query body = PureCloudPlatformClientV2.AddAdherenceExplanationAdminRequest() # AddAdherenceExplanationAdminRequest | The request body try: # Add an adherence explanation for the requested user api_response = api_instance.post_workforcemanagement_agent_adherence_explanations(agent_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_agent_adherence_explanations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query adherence explanations for the given agent across a specified range,"```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.WorkforceManagementApi(); agent_id = 'agent_id_example' # str | The ID of the agent to query body = PureCloudPlatformClientV2.AgentQueryAdherenceExplanationsRequest() # AgentQueryAdherenceExplanationsRequest | The request body force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Query adherence explanations for the given agent across a specified range api_response = api_instance.post_workforcemanagement_agent_adherence_explanations_query(agent_id, body, force_async=force_async, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_agent_adherence_explanations_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an adherence explanation,"```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.WorkforceManagementApi(); agent_id = 'agent_id_example' # str | The ID of the agent to query explanation_id = 'explanation_id_example' # str | The ID of the explanation to update try: # Get an adherence explanation api_response = api_instance.get_workforcemanagement_agent_adherence_explanation(agent_id, explanation_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_agent_adherence_explanation: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/agents/{agentId}/adherence/explanations/{explanationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an adherence explanation,"```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.WorkforceManagementApi(); agent_id = 'agent_id_example' # str | The ID of the agent to query explanation_id = 'explanation_id_example' # str | The ID of the explanation to update body = PureCloudPlatformClientV2.UpdateAdherenceExplanationStatusRequest() # UpdateAdherenceExplanationStatusRequest | The request body try: # Update an adherence explanation api_response = api_instance.patch_workforcemanagement_agent_adherence_explanation(agent_id, explanation_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_agent_adherence_explanation: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/workforcemanagement/agents/{agentId}/integrations/hris Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update integrations for 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.WorkforceManagementApi(); agent_id = 'agent_id_example' # str | The ID of the agent body = PureCloudPlatformClientV2.AgentIntegrationsRequest() # AgentIntegrationsRequest | body try: # Update integrations for agent api_response = api_instance.put_workforcemanagement_agent_integrations_hris(agent_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->put_workforcemanagement_agent_integrations_hris: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/agents/{agentId}/managementunit Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the management unit to which the agent belongs,"```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.WorkforceManagementApi(); agent_id = 'agent_id_example' # str | The ID of the agent to look up try: # Get the management unit to which the agent belongs api_response = api_instance.get_workforcemanagement_agent_managementunit(agent_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_agent_managementunit: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/agentschedules/mine Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get published schedule for the current 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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.BuGetCurrentAgentScheduleRequest() # BuGetCurrentAgentScheduleRequest | body (optional) try: # Get published schedule for the current user api_response = api_instance.post_workforcemanagement_agentschedules_mine(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_agentschedules_mine: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/alternativeshifts/offers/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Request a list of alternative shift offers for a given schedule,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.AlternativeShiftOffersRequest() # AlternativeShiftOffersRequest | The request body try: # Request a list of alternative shift offers for a given schedule api_response = api_instance.post_workforcemanagement_alternativeshifts_offers_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_alternativeshifts_offers_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the status of an alternative shift offers operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response,"```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.WorkforceManagementApi(); job_id = 'job_id_example' # str | The ID of the job try: # Query the status of an alternative shift offers operation. Only the user who started the operation can query the status api_response = api_instance.get_workforcemanagement_alternativeshifts_offers_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_alternativeshifts_offers_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/alternativeshifts/offers/search/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Request a search of alternative shift offers for a given shift,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.AlternativeShiftSearchOffersRequest() # AlternativeShiftSearchOffersRequest | The request body try: # Request a search of alternative shift offers for a given shift api_response = api_instance.post_workforcemanagement_alternativeshifts_offers_search_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_alternativeshifts_offers_search_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response,"```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.WorkforceManagementApi(); job_id = 'job_id_example' # str | The ID of the job try: # Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status api_response = api_instance.get_workforcemanagement_alternativeshifts_offers_search_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_alternativeshifts_offers_search_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/alternativeshifts/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get alternative shifts settings from the current logged in agent’s business unit,"```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.WorkforceManagementApi(); try: # Get alternative shifts settings from the current logged in agent’s business unit api_response = api_instance.get_workforcemanagement_alternativeshifts_settings() pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_alternativeshifts_settings: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/alternativeshifts/trades Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of my alternative shifts trades,"```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.WorkforceManagementApi(); force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) try: # Get a list of my alternative shifts trades api_response = api_instance.get_workforcemanagement_alternativeshifts_trades(force_async=force_async) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_alternativeshifts_trades: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/alternativeshifts/trades Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create my alternative shift trade using an existing offer's jobId,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.CreateAlternativeShiftTradeRequest() # CreateAlternativeShiftTradeRequest | The request body try: # Create my alternative shift trade using an existing offer's jobId api_response = api_instance.post_workforcemanagement_alternativeshifts_trades(body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_alternativeshifts_trades: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the status of an alternative shift trades operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response,"```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.WorkforceManagementApi(); job_id = 'job_id_example' # str | The ID of the job try: # Query the status of an alternative shift trades operation. Only the user who started the operation can query the status api_response = api_instance.get_workforcemanagement_alternativeshifts_trades_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_alternativeshifts_trades_job: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/alternativeshifts/trades/state/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Bulk update alternative shift trade states,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.AdminBulkUpdateAlternativeShiftTradeStateRequest() # AdminBulkUpdateAlternativeShiftTradeStateRequest | The request body try: # Bulk update alternative shift trade states api_response = api_instance.patch_workforcemanagement_alternativeshifts_trades_state_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_alternativeshifts_trades_state_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response,"```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.WorkforceManagementApi(); job_id = 'job_id_example' # str | The ID of the job try: # Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status api_response = api_instance.get_workforcemanagement_alternativeshifts_trades_state_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_alternativeshifts_trades_state_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/alternativeshifts/trades/{tradeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get my alternative shift trade by trade 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.WorkforceManagementApi(); trade_id = 'trade_id_example' # str | The ID of the alternative shift trade try: # Get my alternative shift trade by trade ID api_response = api_instance.get_workforcemanagement_alternativeshifts_trade(trade_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_alternativeshifts_trade: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/alternativeshifts/trades/{tradeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update my alternative shifts trade by trade 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.WorkforceManagementApi(); trade_id = 'trade_id_example' # str | The ID of the alternative shift trade body = PureCloudPlatformClientV2.AgentUpdateAlternativeShiftTradeRequest() # AgentUpdateAlternativeShiftTradeRequest | body (optional) try: # Update my alternative shifts trade by trade ID api_response = api_instance.patch_workforcemanagement_alternativeshifts_trade(trade_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_alternativeshifts_trade: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get business units,"```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.WorkforceManagementApi(); feature = 'feature_example' # str | If specified, the list of business units for which the user is authorized to use the requested feature will be returned (optional) division_id = 'division_id_example' # str | If specified, the list of business units belonging to the specified division will be returned (optional) try: # Get business units api_response = api_instance.get_workforcemanagement_businessunits(feature=feature, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunits: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a new business unit. It may take a minute or two for a new business unit to be available for api operations,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.CreateBusinessUnitRequest() # CreateBusinessUnitRequest | body (optional) try: # Add a new business unit api_response = api_instance.post_workforcemanagement_businessunits(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunits: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/divisionviews Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get business units across divisions,"```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.WorkforceManagementApi(); division_id = ['division_id_example'] # list[str] | The divisionIds to filter by. If omitted, will return business units in all divisions (optional) try: # Get business units across divisions api_response = api_instance.get_workforcemanagement_businessunits_divisionviews(division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunits_divisionviews: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete business unit. A business unit cannot be deleted if it contains one or more management units,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit, or 'mine' for the business unit of the logged-in user. try: # Delete business unit api_instance.delete_workforcemanagement_businessunit(business_unit_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get business unit. Expanding ""settings"" will retrieve all settings. All other expands will retrieve only the requested settings field(s).","```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit, or 'mine' for the business unit of the logged-in user. expand = ['expand_example'] # list[str] | Include to access additional data on the business unit (optional) try: # Get business unit api_response = api_instance.get_workforcemanagement_businessunit(business_unit_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update business unit,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit, or 'mine' for the business unit of the logged-in user. body = PureCloudPlatformClientV2.UpdateBusinessUnitRequest() # UpdateBusinessUnitRequest | body (optional) try: # Update business unit api_response = api_instance.patch_workforcemanagement_businessunit(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get activity codes,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit, or 'mine' for the business unit of the logged-in user. force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Get activity codes api_response = api_instance.get_workforcemanagement_businessunit_activitycodes(business_unit_id, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_activitycodes: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new activity code,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit, or 'mine' for the business unit of the logged-in user. body = PureCloudPlatformClientV2.CreateActivityCodeRequest() # CreateActivityCodeRequest | body (optional) try: # Create a new activity code api_response = api_instance.post_workforcemanagement_businessunit_activitycodes(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_activitycodes: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes an activity code,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit, or 'mine' for the business unit of the logged-in user. activity_code_id = 'activity_code_id_example' # str | The ID of the activity code to delete try: # Deletes an activity code api_instance.delete_workforcemanagement_businessunit_activitycode(business_unit_id, activity_code_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_activitycode: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an activity code,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit, or 'mine' for the business unit of the logged-in user. activity_code_id = 'activity_code_id_example' # str | The ID of the activity code to fetch try: # Get an activity code api_response = api_instance.get_workforcemanagement_businessunit_activitycode(business_unit_id, activity_code_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_activitycode: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an activity code,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit, or 'mine' for the business unit of the logged-in user. activity_code_id = 'activity_code_id_example' # str | The ID of the activity code to update body = PureCloudPlatformClientV2.UpdateActivityCodeRequest() # UpdateActivityCodeRequest | body (optional) try: # Update an activity code api_response = api_instance.patch_workforcemanagement_businessunit_activitycode(business_unit_id, activity_code_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_activitycode: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get activity plans,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit state = 'state_example' # str | Optionally filter by activity plan state (optional) try: # Get activity plans api_response = api_instance.get_workforcemanagement_businessunit_activityplans(business_unit_id, state=state) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_activityplans: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create an activity plan,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit body = PureCloudPlatformClientV2.CreateActivityPlanRequest() # CreateActivityPlanRequest | body try: # Create an activity plan api_response = api_instance.post_workforcemanagement_businessunit_activityplans(business_unit_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_activityplans: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets the latest job for all activity plans in the business unit,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit try: # Gets the latest job for all activity plans in the business unit api_response = api_instance.get_workforcemanagement_businessunit_activityplans_jobs(business_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_activityplans_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an activity plan,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit activity_plan_id = 'activity_plan_id_example' # str | The ID of the activity plan to fetch try: # Get an activity plan api_response = api_instance.get_workforcemanagement_businessunit_activityplan(business_unit_id, activity_plan_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_activityplan: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an activity plan. If a job associated with the activity plan is in 'Processing' state the activity plan cannot be updated,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit activity_plan_id = 'activity_plan_id_example' # str | The ID of the activity plan to update body = PureCloudPlatformClientV2.UpdateActivityPlanRequest() # UpdateActivityPlanRequest | body try: # Update an activity plan api_response = api_instance.patch_workforcemanagement_businessunit_activityplan(business_unit_id, activity_plan_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_activityplan: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Run an activity plan manually. Triggers a job running the activity plan. The activity plan cannot be updated until the job completes,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit activity_plan_id = 'activity_plan_id_example' # str | The ID of the activity plan to run try: # Run an activity plan manually api_response = api_instance.post_workforcemanagement_businessunit_activityplan_runs_jobs(business_unit_id, activity_plan_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_activityplan_runs_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets an activity plan run 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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit activity_plan_id = 'activity_plan_id_example' # str | The ID of the activity plan associated with the run job job_id = 'job_id_example' # str | The ID of the activity plan run job try: # Gets an activity plan run job api_response = api_instance.get_workforcemanagement_businessunit_activityplan_runs_job(business_unit_id, activity_plan_id, job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_activityplan_runs_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/adherence/explanations/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query adherence explanations across an entire business unit for the requested period,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit body = PureCloudPlatformClientV2.BuQueryAdherenceExplanationsRequest() # BuQueryAdherenceExplanationsRequest | The request body force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Query adherence explanations across an entire business unit for the requested period api_response = api_instance.post_workforcemanagement_businessunit_adherence_explanations_query(business_unit_id, body, force_async=force_async, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_adherence_explanations_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Search published schedules,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) body = PureCloudPlatformClientV2.BuSearchAgentSchedulesRequest() # BuSearchAgentSchedulesRequest | body (optional) try: # Search published schedules api_response = api_instance.post_workforcemanagement_businessunit_agentschedules_search(business_unit_id, force_async=force_async, force_download_service=force_download_service, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_agentschedules_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get alternative shifts settings for a business unit,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit try: # Get alternative shifts settings for a business unit api_response = api_instance.get_workforcemanagement_businessunit_alternativeshifts_settings(business_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_alternativeshifts_settings: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update alternative shifts settings for a business unit,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit body = PureCloudPlatformClientV2.UpdateAlternativeShiftBuSettingsRequest() # UpdateAlternativeShiftBuSettingsRequest | body (optional) try: # Update alternative shifts settings for a business unit api_response = api_instance.patch_workforcemanagement_businessunit_alternativeshifts_settings(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_alternativeshifts_settings: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: List alternative shifts trades for a given management unit or 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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit body = PureCloudPlatformClientV2.SearchAlternativeShiftTradesRequest() # SearchAlternativeShiftTradesRequest | The request body force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) try: # List alternative shifts trades for a given management unit or agent api_response = api_instance.post_workforcemanagement_businessunit_alternativeshifts_trades_search(business_unit_id, body, force_async=force_async) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_alternativeshifts_trades_search: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status. Job details are only retained if the initial request returned a 202 ACCEPTED response,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit job_id = 'job_id_example' # str | The ID of the job try: # Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status api_response = api_instance.get_workforcemanagement_businessunit_alternativeshifts_trades_search_job(business_unit_id, job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_alternativeshifts_trades_search_job: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get an alternative shifts trade in a business unit for a given trade 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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit trade_id = 'trade_id_example' # str | The ID of the alternative shift trade try: # Get an alternative shifts trade in a business unit for a given trade ID api_response = api_instance.get_workforcemanagement_businessunit_alternativeshifts_trade(business_unit_id, trade_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_alternativeshifts_trade: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get intraday data for the given date for the requested planningGroupIds,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) body = PureCloudPlatformClientV2.IntradayPlanningGroupRequest() # IntradayPlanningGroupRequest | body (optional) try: # Get intraday data for the given date for the requested planningGroupIds api_response = api_instance.post_workforcemanagement_businessunit_intraday(business_unit_id, force_async=force_async, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_intraday: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday/planninggroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get intraday planning groups for the given date,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit date = '2013-10-20' # date | yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd try: # Get intraday planning groups for the given date api_response = api_instance.get_workforcemanagement_businessunit_intraday_planninggroups(business_unit_id, date) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_intraday_planninggroups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/managementunits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get all authorized management units in the business unit,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit, or 'mine' for the business unit of the logged-in user. feature = 'feature_example' # str | If specified, the list of management units for which the user is authorized to use the requested feature will be returned (optional) division_id = 'division_id_example' # str | If specified, the list of management units belonging to the specified division will be returned (optional) try: # Get all authorized management units in the business unit api_response = api_instance.get_workforcemanagement_businessunit_managementunits(business_unit_id, feature=feature, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_managementunits: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets list of planning groups,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit. try: # Gets list of planning groups api_response = api_instance.get_workforcemanagement_businessunit_planninggroups(business_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_planninggroups: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Adds a new planning group,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit. body = PureCloudPlatformClientV2.CreatePlanningGroupRequest() # CreatePlanningGroupRequest | body (optional) try: # Adds a new planning group api_response = api_instance.post_workforcemanagement_businessunit_planninggroups(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_planninggroups: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes the planning group,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit. planning_group_id = 'planning_group_id_example' # str | The ID of a planning group to delete try: # Deletes the planning group api_instance.delete_workforcemanagement_businessunit_planninggroup(business_unit_id, planning_group_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_planninggroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a planning group,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit. planning_group_id = 'planning_group_id_example' # str | The ID of a planning group to fetch try: # Get a planning group api_response = api_instance.get_workforcemanagement_businessunit_planninggroup(business_unit_id, planning_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_planninggroup: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates the planning group,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit. planning_group_id = 'planning_group_id_example' # str | The ID of a planning group to update body = PureCloudPlatformClientV2.UpdatePlanningGroupRequest() # UpdatePlanningGroupRequest | body (optional) try: # Updates the planning group api_response = api_instance.patch_workforcemanagement_businessunit_planninggroup(business_unit_id, planning_group_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_planninggroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the list of scheduling runs,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit try: # Get the list of scheduling runs api_response = api_instance.get_workforcemanagement_businessunit_scheduling_runs(business_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_scheduling_runs: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Cancel a scheduling 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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit run_id = 'run_id_example' # str | The ID of the schedule run try: # Cancel a scheduling run api_instance.delete_workforcemanagement_businessunit_scheduling_run(business_unit_id, run_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_scheduling_run: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a scheduling 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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit run_id = 'run_id_example' # str | The ID of the schedule run try: # Get a scheduling run api_response = api_instance.get_workforcemanagement_businessunit_scheduling_run(business_unit_id, run_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_scheduling_run: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Mark a schedule run as applied,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit run_id = 'run_id_example' # str | The ID of the schedule run body = PureCloudPlatformClientV2.PatchBuScheduleRunRequest() # PatchBuScheduleRunRequest | body (optional) try: # Mark a schedule run as applied api_instance.patch_workforcemanagement_businessunit_scheduling_run(business_unit_id, run_id, body=body) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_scheduling_run: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}/result Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the result of a rescheduling operation,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit run_id = 'run_id_example' # str | The ID of the schedule run management_unit_ids = ['management_unit_ids_example'] # list[str] | The IDs of the management units for which to fetch the reschedule results expand = ['expand_example'] # list[str] | The fields to expand. Omitting will return an empty response try: # Get the result of a rescheduling operation api_response = api_instance.get_workforcemanagement_businessunit_scheduling_run_result(business_unit_id, run_id, management_unit_ids, expand) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_scheduling_run_result: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets list of service goal templates,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit. expand = ['expand_example'] # list[str] | Include to access additional data on the service goal template (optional) try: # Gets list of service goal templates api_response = api_instance.get_workforcemanagement_businessunit_servicegoaltemplates(business_unit_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_servicegoaltemplates: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates Genesys Cloud Python SDK.,Genesys describes this as an API used to: Adds a new service goal template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit. body = PureCloudPlatformClientV2.CreateServiceGoalTemplate() # CreateServiceGoalTemplate | body (optional) try: # Adds a new service goal template api_response = api_instance.post_workforcemanagement_businessunit_servicegoaltemplates(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_servicegoaltemplates: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a service goal template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit. service_goal_template_id = 'service_goal_template_id_example' # str | The ID of the service goal template to delete try: # Delete a service goal template api_instance.delete_workforcemanagement_businessunit_servicegoaltemplate(business_unit_id, service_goal_template_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_servicegoaltemplate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a service goal template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit. service_goal_template_id = 'service_goal_template_id_example' # str | The ID of a service goal template to fetch expand = ['expand_example'] # list[str] | Include to access additional data on the service goal template (optional) try: # Get a service goal template api_response = api_instance.get_workforcemanagement_businessunit_servicegoaltemplate(business_unit_id, service_goal_template_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_servicegoaltemplate: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a service goal template,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit. service_goal_template_id = 'service_goal_template_id_example' # str | The ID of a service goal template to update body = PureCloudPlatformClientV2.UpdateServiceGoalTemplate() # UpdateServiceGoalTemplate | body (optional) try: # Updates a service goal template api_response = api_instance.patch_workforcemanagement_businessunit_servicegoaltemplate(business_unit_id, service_goal_template_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_servicegoaltemplate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a list of staffing groups,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit management_unit_id = 'management_unit_id_example' # str | The ID of the management unit to get management unit specific staffing groups (optional) try: # Gets a list of staffing groups api_response = api_instance.get_workforcemanagement_businessunit_staffinggroups(business_unit_id, management_unit_id=management_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_staffinggroups: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a new staffing group,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit body = PureCloudPlatformClientV2.CreateStaffingGroupRequest() # CreateStaffingGroupRequest | body (optional) try: # Creates a new staffing group api_response = api_instance.post_workforcemanagement_businessunit_staffinggroups(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_staffinggroups: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets staffing group associations for a list of user IDs,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit body = PureCloudPlatformClientV2.QueryUserStaffingGroupListRequest() # QueryUserStaffingGroupListRequest | body (optional) try: # Gets staffing group associations for a list of user IDs api_response = api_instance.post_workforcemanagement_businessunit_staffinggroups_query(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_staffinggroups_query: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a staffing group,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit staffing_group_id = 'staffing_group_id_example' # str | The ID of the staffing group to delete try: # Deletes a staffing group api_instance.delete_workforcemanagement_businessunit_staffinggroup(business_unit_id, staffing_group_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_staffinggroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a staffing group,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit staffing_group_id = 'staffing_group_id_example' # str | The ID of the staffing group to fetch try: # Gets a staffing group api_response = api_instance.get_workforcemanagement_businessunit_staffinggroup(business_unit_id, staffing_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_staffinggroup: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a staffing group,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit staffing_group_id = 'staffing_group_id_example' # str | The ID of the staffing group to update body = PureCloudPlatformClientV2.UpdateStaffingGroupRequest() # UpdateStaffingGroupRequest | body (optional) try: # Updates a staffing group api_response = api_instance.patch_workforcemanagement_businessunit_staffinggroup(business_unit_id, staffing_group_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_staffinggroup: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a list of time-off limit objects,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit management_unit_id = 'management_unit_id_example' # str | The ID of the management unit to get management unit specific time-off limit objects (optional) try: # Gets a list of time-off limit objects api_response = api_instance.get_workforcemanagement_businessunit_timeofflimits(business_unit_id, management_unit_id=management_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_timeofflimits: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a new time-off limit object,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit body = PureCloudPlatformClientV2.BuCreateTimeOffLimitRequest() # BuCreateTimeOffLimitRequest | body (optional) try: # Creates a new time-off limit object api_response = api_instance.post_workforcemanagement_businessunit_timeofflimits(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_timeofflimits: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves time-off limit related values based on a given set of filters.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit body = PureCloudPlatformClientV2.QueryTimeOffLimitValuesRequest() # QueryTimeOffLimitValuesRequest | body (optional) try: # Retrieves time-off limit related values based on a given set of filters. api_response = api_instance.post_workforcemanagement_businessunit_timeofflimits_values_query(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_timeofflimits_values_query: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a time-off limit object,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit time_off_limit_id = 'time_off_limit_id_example' # str | The ID of the time-off limit object to delete try: # Deletes a time-off limit object api_instance.delete_workforcemanagement_businessunit_timeofflimit(business_unit_id, time_off_limit_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_timeofflimit: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Gets a time-off limit object. Returns properties of time-off limit object, but not daily values","```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit time_off_limit_id = 'time_off_limit_id_example' # str | The ID of the time-off limit to fetch try: # Gets a time-off limit object api_response = api_instance.get_workforcemanagement_businessunit_timeofflimit(business_unit_id, time_off_limit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_timeofflimit: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Sets daily values for a date range of time-off limit object. Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API","```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit time_off_limit_id = 'time_off_limit_id_example' # str | The ID of the time-off limit object to set values for body = PureCloudPlatformClientV2.BuSetTimeOffLimitValuesRequest() # BuSetTimeOffLimitValuesRequest | body (optional) try: # Sets daily values for a date range of time-off limit object api_response = api_instance.put_workforcemanagement_businessunit_timeofflimit_values(business_unit_id, time_off_limit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->put_workforcemanagement_businessunit_timeofflimit_values: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a list of time-off plans,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit management_unit_id = 'management_unit_id_example' # str | The ID of the management unit to get management unit specific staffing groups (optional) force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Gets a list of time-off plans api_response = api_instance.get_workforcemanagement_businessunit_timeoffplans(business_unit_id, management_unit_id=management_unit_id, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_timeoffplans: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a new time-off plan,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit body = PureCloudPlatformClientV2.BuCreateTimeOffPlanRequest() # BuCreateTimeOffPlanRequest | body (optional) try: # Creates a new time-off plan api_response = api_instance.post_workforcemanagement_businessunit_timeoffplans(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_timeoffplans: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a time-off plan,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit time_off_plan_id = 'time_off_plan_id_example' # str | The ID of the time-off plan to delete try: # Deletes a time-off plan api_instance.delete_workforcemanagement_businessunit_timeoffplan(business_unit_id, time_off_plan_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_timeoffplan: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a time-off plan,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit time_off_plan_id = 'time_off_plan_id_example' # str | The ID of the time-off plan to fetch try: # Gets a time-off plan api_response = api_instance.get_workforcemanagement_businessunit_timeoffplan(business_unit_id, time_off_plan_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_timeoffplan: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a time-off plan,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit time_off_plan_id = 'time_off_plan_id_example' # str | The ID of the time-off plan to update body = PureCloudPlatformClientV2.BuUpdateTimeOffPlanRequest() # BuUpdateTimeOffPlanRequest | body (optional) try: # Updates a time-off plan api_response = api_instance.patch_workforcemanagement_businessunit_timeoffplan(business_unit_id, time_off_plan_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_timeoffplan: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get short term forecasts. Use ""recent"" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week","```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = 'week_date_id_example' # str | The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts try: # Get short term forecasts api_response = api_instance.get_workforcemanagement_businessunit_week_shorttermforecasts(business_unit_id, week_date_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_shorttermforecasts: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/generate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Generate a short term forecast,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd body = PureCloudPlatformClientV2.GenerateBuForecastRequest() # GenerateBuForecastRequest | body force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) try: # Generate a short term forecast api_response = api_instance.post_workforcemanagement_businessunit_week_shorttermforecasts_generate(business_unit_id, week_date_id, body, force_async=force_async) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_shorttermforecasts_generate: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import Genesys Cloud Python SDK.,Genesys describes this as an API used to: Starts importing the uploaded short term forecast. Call after uploading the forecast data to the url supplied by the /import/uploadurl route,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd body = PureCloudPlatformClientV2.WfmProcessUploadRequest() # WfmProcessUploadRequest | body try: # Starts importing the uploaded short term forecast api_response = api_instance.post_workforcemanagement_businessunit_week_shorttermforecasts_import(business_unit_id, week_date_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_shorttermforecasts_import: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/import/uploadurl Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Creates a signed upload URL for importing a short term forecast. Once the upload is complete, call the /import route to start the short term forecast import process","```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd body = PureCloudPlatformClientV2.UploadUrlRequestBody() # UploadUrlRequestBody | body try: # Creates a signed upload URL for importing a short term forecast api_response = api_instance.post_workforcemanagement_businessunit_week_shorttermforecasts_import_uploadurl(business_unit_id, week_date_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_shorttermforecasts_import_uploadurl: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a short term forecast. Must not be tied to any schedules,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd forecast_id = 'forecast_id_example' # str | The ID of the forecast try: # Delete a short term forecast api_instance.delete_workforcemanagement_businessunit_week_shorttermforecast(business_unit_id, week_date_id, forecast_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_week_shorttermforecast: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a short term forecast,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd forecast_id = 'forecast_id_example' # str | The ID of the forecast expand = ['expand_example'] # list[str] | Include to access additional data on the forecast (optional) try: # Get a short term forecast api_response = api_instance.get_workforcemanagement_businessunit_week_shorttermforecast(business_unit_id, week_date_id, forecast_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_shorttermforecast: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/copy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Copy a short term forecast,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd forecast_id = 'forecast_id_example' # str | The ID of the forecast to copy body = PureCloudPlatformClientV2.CopyBuForecastRequest() # CopyBuForecastRequest | body force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) try: # Copy a short term forecast api_response = api_instance.post_workforcemanagement_businessunit_week_shorttermforecast_copy(business_unit_id, week_date_id, forecast_id, body, force_async=force_async) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_shorttermforecast_copy: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/data Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the result of a short term forecast calculation. Includes modifications unless you pass the doNotApplyModifications query parameter,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd forecast_id = 'forecast_id_example' # str | The ID of the forecast week_number = 56 # int | The week number to fetch (for multi-week forecasts) (optional) force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Get the result of a short term forecast calculation api_response = api_instance.get_workforcemanagement_businessunit_week_shorttermforecast_data(business_unit_id, week_date_id, forecast_id, week_number=week_number, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_shorttermforecast_data: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/generationresults Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets the forecast generation 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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd forecast_id = 'forecast_id_example' # str | The ID of the forecast try: # Gets the forecast generation results api_response = api_instance.get_workforcemanagement_businessunit_week_shorttermforecast_generationresults(business_unit_id, week_date_id, forecast_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_shorttermforecast_generationresults: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/longtermforecastdata Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the result of a long term forecast calculation. Includes modifications unless you pass the doNotApplyModifications query parameter,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd forecast_id = 'forecast_id_example' # str | The ID of the forecast force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Get the result of a long term forecast calculation api_response = api_instance.get_workforcemanagement_businessunit_week_shorttermforecast_longtermforecastdata(business_unit_id, week_date_id, forecast_id, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_shorttermforecast_longtermforecastdata: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/planninggroups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets the forecast planning group snapshot,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd forecast_id = 'forecast_id_example' # str | The ID of the forecast try: # Gets the forecast planning group snapshot api_response = api_instance.get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups(business_unit_id, week_date_id, forecast_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_shorttermforecast_planninggroups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekDateId}/shorttermforecasts/{forecastId}/staffingrequirement Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the staffing requirement by planning group for a forecast,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the forecast belongs week_date_id = '2013-10-20' # date | The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd forecast_id = 'forecast_id_example' # str | The ID of the forecast week_numbers = ['week_numbers_example'] # list[str] | The week numbers to fetch (for multi-week forecasts) staffing requirements. Returns all week data if the list is not specified (optional) try: # Get the staffing requirement by planning group for a forecast api_response = api_instance.get_workforcemanagement_businessunit_week_shorttermforecast_staffingrequirement(business_unit_id, week_date_id, forecast_id, week_numbers=week_numbers) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_shorttermforecast_staffingrequirement: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the list of week schedules for the specified week. Use ""recent"" (without quotes) for the `weekId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any schedule which spans the specified week","```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = 'week_id_example' # str | First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules include_only_published = True # bool | includeOnlyPublished (optional) expand = 'expand_example' # str | expand (optional) try: # Get the list of week schedules for the specified week api_response = api_instance.get_workforcemanagement_businessunit_week_schedules(business_unit_id, week_id, include_only_published=include_only_published, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_schedules: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a blank schedule,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd body = PureCloudPlatformClientV2.BuCreateBlankScheduleRequest() # BuCreateBlankScheduleRequest | body try: # Create a blank schedule api_response = api_instance.post_workforcemanagement_businessunit_week_schedules(business_unit_id, week_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedules: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/generate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Generate a schedule,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd body = PureCloudPlatformClientV2.BuGenerateScheduleRequest() # BuGenerateScheduleRequest | body try: # Generate a schedule api_response = api_instance.post_workforcemanagement_businessunit_week_schedules_generate(business_unit_id, week_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedules_generate: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import Genesys Cloud Python SDK.,Genesys describes this as an API used to: Starts processing a schedule import. Call after uploading the schedule data to the url supplied by the /import/uploadurl route,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd body = PureCloudPlatformClientV2.WfmProcessUploadRequest() # WfmProcessUploadRequest | try: # Starts processing a schedule import api_response = api_instance.post_workforcemanagement_businessunit_week_schedules_import(business_unit_id, week_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedules_import: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/import/uploadurl Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Creates a signed upload URL for importing a schedule. Once the upload is complete, call the /import route to start the schedule import process","```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd body = PureCloudPlatformClientV2.UploadUrlRequestBody() # UploadUrlRequestBody | body try: # Creates a signed upload URL for importing a schedule api_response = api_instance.post_workforcemanagement_businessunit_week_schedules_import_uploadurl(business_unit_id, week_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedules_import_uploadurl: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a schedule,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd schedule_id = 'schedule_id_example' # str | The ID of the schedule try: # Delete a schedule api_response = api_instance.delete_workforcemanagement_businessunit_week_schedule(business_unit_id, week_id, schedule_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_week_schedule: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route","```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd schedule_id = 'schedule_id_example' # str | The ID of the schedule expand = 'expand_example' # str | expand (optional) try: # Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route api_response = api_instance.get_workforcemanagement_businessunit_week_schedule(business_unit_id, week_id, schedule_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_schedule: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/agentschedules/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Loads agent schedule data from the schedule. Used in combination with the metadata route,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd schedule_id = 'schedule_id_example' # str | The ID of the schedule body = PureCloudPlatformClientV2.BuQueryAgentSchedulesRequest() # BuQueryAgentSchedulesRequest | body force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Loads agent schedule data from the schedule. Used in combination with the metadata route api_response = api_instance.post_workforcemanagement_businessunit_week_schedule_agentschedules_query(business_unit_id, week_id, schedule_id, body, force_async=force_async, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedule_agentschedules_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/copy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Copy a schedule,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd schedule_id = 'schedule_id_example' # str | The ID of the schedule to copy body = PureCloudPlatformClientV2.BuCopyScheduleRequest() # BuCopyScheduleRequest | body try: # Copy a schedule api_response = api_instance.post_workforcemanagement_businessunit_week_schedule_copy(business_unit_id, week_id, schedule_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedule_copy: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/generationresults Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the generation results for a generated schedule,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd schedule_id = 'schedule_id_example' # str | The ID of the schedule try: # Get the generation results for a generated schedule api_response = api_instance.get_workforcemanagement_businessunit_week_schedule_generationresults(business_unit_id, week_id, schedule_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_schedule_generationresults: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/headcountforecast Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the headcount forecast by planning group for the schedule,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd schedule_id = 'schedule_id_example' # str | The ID of the schedule force_download = True # bool | Whether to force the result to come via download url. For testing purposes only (optional) try: # Get the headcount forecast by planning group for the schedule api_response = api_instance.get_workforcemanagement_businessunit_week_schedule_headcountforecast(business_unit_id, week_id, schedule_id, force_download=force_download) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_schedule_headcountforecast: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/history/agents/{agentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Loads agent's schedule history.,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd schedule_id = 'schedule_id_example' # str | The ID of the schedule agent_id = 'agent_id_example' # str | THe ID of the agent try: # Loads agent's schedule history. api_response = api_instance.get_workforcemanagement_businessunit_week_schedule_history_agent(business_unit_id, week_id, schedule_id, agent_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_schedule_history_agent: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the performance prediction for the associated schedule,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the performance prediction belongs week_id = 'week_id_example' # str | First day of schedule week in yyyy-MM-dd format schedule_id = 'schedule_id_example' # str | The ID of the schedule the performance prediction belongs to try: # Get the performance prediction for the associated schedule api_response = api_instance.get_workforcemanagement_businessunit_week_schedule_performancepredictions(business_unit_id, week_id, schedule_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_schedule_performancepredictions: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Request a daily recalculation of the performance prediction for the associated schedule,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the performance prediction belongs week_id = 'week_id_example' # str | First day of schedule week in yyyy-MM-dd format schedule_id = 'schedule_id_example' # str | The ID of the schedule the performance prediction belongs to body = PureCloudPlatformClientV2.WfmProcessUploadRequest() # WfmProcessUploadRequest | body (optional) try: # Request a daily recalculation of the performance prediction for the associated schedule api_response = api_instance.post_workforcemanagement_businessunit_week_schedule_performancepredictions_recalculations(business_unit_id, week_id, schedule_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedule_performancepredictions_recalculations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl Genesys Cloud Python SDK.,Genesys describes this as an API used to: Upload daily activity changes to be able to request a performance prediction recalculation,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the performance prediction belongs week_id = 'week_id_example' # str | First day of schedule week in yyyy-MM-dd format schedule_id = 'schedule_id_example' # str | The ID of the schedule the performance prediction belongs to body = PureCloudPlatformClientV2.UploadUrlRequestBody() # UploadUrlRequestBody | body (optional) try: # Upload daily activity changes to be able to request a performance prediction recalculation api_response = api_instance.post_workforcemanagement_businessunit_week_schedule_performancepredictions_recalculations_uploadurl(business_unit_id, week_id, schedule_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedule_performancepredictions_recalculations_uploadurl: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/{recalculationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get recalculated performance prediction result,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit to which the performance prediction belongs week_id = 'week_id_example' # str | First day of schedule week in yyyy-MM-dd format schedule_id = 'schedule_id_example' # str | The ID of the schedule the recalculation belongs to recalculation_id = 'recalculation_id_example' # str | The ID of the recalculation request try: # Get recalculated performance prediction result api_response = api_instance.get_workforcemanagement_businessunit_week_schedule_performancepredictions_recalculation(business_unit_id, week_id, schedule_id, recalculation_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_week_schedule_performancepredictions_recalculation: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/reschedule Genesys Cloud Python SDK.,Genesys describes this as an API used to: Start a rescheduling 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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd schedule_id = 'schedule_id_example' # str | The ID of the schedule body = PureCloudPlatformClientV2.BuRescheduleRequest() # BuRescheduleRequest | body try: # Start a rescheduling run api_response = api_instance.post_workforcemanagement_businessunit_week_schedule_reschedule(business_unit_id, week_id, schedule_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedule_reschedule: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update Genesys Cloud Python SDK.,Genesys describes this as an API used to: Starts processing a schedule update. Call after uploading the schedule data to the url supplied by the /update/uploadurl route,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd schedule_id = 'schedule_id_example' # str | The ID of the schedule body = PureCloudPlatformClientV2.ProcessScheduleUpdateUploadRequest() # ProcessScheduleUpdateUploadRequest | body try: # Starts processing a schedule update api_response = api_instance.post_workforcemanagement_businessunit_week_schedule_update(business_unit_id, week_id, schedule_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedule_update: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/update/uploadurl Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Creates a signed upload URL for updating a schedule. Once the upload is complete, call the /{scheduleId}/update route to start the schedule update process","```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit week_id = '2013-10-20' # date | First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd schedule_id = 'schedule_id_example' # str | The ID of the schedule body = PureCloudPlatformClientV2.UploadUrlRequestBody() # UploadUrlRequestBody | body try: # Creates a signed upload URL for updating a schedule api_response = api_instance.post_workforcemanagement_businessunit_week_schedule_update_uploadurl(business_unit_id, week_id, schedule_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_week_schedule_update_uploadurl: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of work plan bids,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit try: # Get list of work plan bids api_response = api_instance.get_workforcemanagement_businessunit_workplanbids(business_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_workplanbids: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new work plan bid,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit body = PureCloudPlatformClientV2.CreateWorkPlanBid() # CreateWorkPlanBid | The work plan bid to be created (optional) try: # Create a new work plan bid api_response = api_instance.post_workforcemanagement_businessunit_workplanbids(business_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_workplanbids: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a work plan bid,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The ID of the work plan bid try: # Delete a work plan bid api_instance.delete_workforcemanagement_businessunit_workplanbid(business_unit_id, bid_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_workplanbid: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a work plan bid,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The id of the workplanbid try: # Get a work plan bid api_response = api_instance.get_workforcemanagement_businessunit_workplanbid(business_unit_id, bid_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_workplanbid: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update work plan bid,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The id of the workplanbid body = PureCloudPlatformClientV2.UpdateWorkPlanBid() # UpdateWorkPlanBid | The work plan bid to be updated try: # Update work plan bid api_response = api_instance.patch_workforcemanagement_businessunit_workplanbid(business_unit_id, bid_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_workplanbid: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Copy a work plan bid,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The ID of the work plan bid to copy body = PureCloudPlatformClientV2.CopyWorkPlanBid() # CopyWorkPlanBid | body (optional) try: # Copy a work plan bid api_response = api_instance.post_workforcemanagement_businessunit_workplanbid_copy(business_unit_id, bid_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_workplanbid_copy: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a bid group in a given work plan bid,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The work plan bid id of the bid groups body = PureCloudPlatformClientV2.WorkPlanBidGroupCreate() # WorkPlanBidGroupCreate | body (optional) try: # Add a bid group in a given work plan bid api_response = api_instance.post_workforcemanagement_businessunit_workplanbid_groups(business_unit_id, bid_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_businessunit_workplanbid_groups: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/summary Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get summary of bid groups that belong to a work plan bid,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The work plan bid id of the bid groups try: # Get summary of bid groups that belong to a work plan bid api_response = api_instance.get_workforcemanagement_businessunit_workplanbid_groups_summary(business_unit_id, bid_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_workplanbid_groups_summary: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a bid group by bid group 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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The work plan bid id of the bid groups bid_group_id = 'bid_group_id_example' # str | Work Plan Bid Group id try: # Delete a bid group by bid group Id api_instance.delete_workforcemanagement_businessunit_workplanbid_group(business_unit_id, bid_id, bid_group_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_businessunit_workplanbid_group: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a bid group by bid group 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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The work plan bid id of the bid groups bid_group_id = 'bid_group_id_example' # str | Work Plan Bid Group id try: # Get a bid group by bid group Id api_response = api_instance.get_workforcemanagement_businessunit_workplanbid_group(business_unit_id, bid_id, bid_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_workplanbid_group: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a bid group by bid group 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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The work plan bid id of the bid groups bid_group_id = 'bid_group_id_example' # str | Work Plan Bid Group id body = PureCloudPlatformClientV2.WorkPlanBidGroupUpdate() # WorkPlanBidGroupUpdate | body (optional) try: # Update a bid group by bid group Id api_response = api_instance.patch_workforcemanagement_businessunit_workplanbid_group(business_unit_id, bid_id, bid_group_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_workplanbid_group: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets the work plan preferences of all the agents in the work plan bid group,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The work plan bid id of the bid groups bid_group_id = 'bid_group_id_example' # str | The ID of the work plan bid group try: # Gets the work plan preferences of all the agents in the work plan bid group api_response = api_instance.get_workforcemanagement_businessunit_workplanbid_group_preferences(business_unit_id, bid_id, bid_group_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_businessunit_workplanbid_group_preferences: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences Genesys Cloud Python SDK.,Genesys describes this as an API used to: Overrides the assigned work plan for the specified agents,"```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.WorkforceManagementApi(); business_unit_id = 'business_unit_id_example' # str | The ID of the business unit bid_id = 'bid_id_example' # str | The work plan bid id of the bid groups bid_group_id = 'bid_group_id_example' # str | The ID of the work plan bid group body = PureCloudPlatformClientV2.AgentsBidAssignedWorkPlanOverrideRequest() # AgentsBidAssignedWorkPlanOverrideRequest | body (optional) try: # Overrides the assigned work plan for the specified agents api_response = api_instance.patch_workforcemanagement_businessunit_workplanbid_group_preferences(business_unit_id, bid_id, bid_group_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_businessunit_workplanbid_group_preferences: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/calendar/data/ics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get ics formatted calendar based on shareable link,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # create an instance of the API class api_instance = PureCloudPlatformClientV2.WorkforceManagementApi(); calendar_id = 'calendar_id_example' # str | The id of the ics-formatted calendar try: # Get ics formatted calendar based on shareable link api_response = api_instance.get_workforcemanagement_calendar_data_ics(calendar_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_calendar_data_ics: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/calendar/url/ics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Disable generated calendar link for the current 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.WorkforceManagementApi(); try: # Disable generated calendar link for the current user api_instance.delete_workforcemanagement_calendar_url_ics() except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_calendar_url_ics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/calendar/url/ics Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get existing calendar link for the current 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.WorkforceManagementApi(); try: # Get existing calendar link for the current user api_response = api_instance.get_workforcemanagement_calendar_url_ics() pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_calendar_url_ics: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/calendar/url/ics Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be 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.WorkforceManagementApi(); language = ''en-US'' # str | A language tag (which is sometimes referred to as a \""locale identifier\"") to use to localize default activity code names in the ics-formatted calendar (optional) (default to 'en-US') try: # Create a newly generated calendar link for the current user; if the current user has previously generated one, the generated link will be returned api_response = api_instance.post_workforcemanagement_calendar_url_ics(language=language) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_calendar_url_ics: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/historicaldata/deletejob Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves delete job status for historical data imports of the organization,"```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.WorkforceManagementApi(); try: # Retrieves delete job status for historical data imports of the organization api_response = api_instance.get_workforcemanagement_historicaldata_deletejob() pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_historicaldata_deletejob: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/historicaldata/deletejob Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete the entries of the historical data imports in the organization,"```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.WorkforceManagementApi(); try: # Delete the entries of the historical data imports in the organization api_response = api_instance.post_workforcemanagement_historicaldata_deletejob() pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_historicaldata_deletejob: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/historicaldata/importstatus Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves status of the historical data imports of the organization,"```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.WorkforceManagementApi(); try: # Retrieves status of the historical data imports of the organization api_response = api_instance.get_workforcemanagement_historicaldata_importstatus() pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_historicaldata_importstatus: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/historicaldata/validate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Trigger validation process for historical import,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.ValidationServiceRequest() # ValidationServiceRequest | body (optional) try: # Trigger validation process for historical import api_instance.post_workforcemanagement_historicaldata_validate(body=body) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_historicaldata_validate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/integrations/hris Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get 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.WorkforceManagementApi(); try: # Get integrations api_response = api_instance.get_workforcemanagement_integrations_hris() pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_integrations_hris: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the results of time off types 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.WorkforceManagementApi(); job_id = 'job_id_example' # str | The ID of the job. try: # Query the results of time off types job api_response = api_instance.get_workforcemanagement_integrations_hris_timeofftypes_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_integrations_hris_timeofftypes_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get list of time off types configured in 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.WorkforceManagementApi(); hris_integration_id = 'hris_integration_id_example' # str | The ID of the HRIS integration for which time off types are queried. try: # Get list of time off types configured in integration api_response = api_instance.post_workforcemanagement_integrations_hri_timeofftypes_jobs(hris_integration_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_integrations_hri_timeofftypes_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get management units,"```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.WorkforceManagementApi(); page_size = 56 # int | Deprecated, paging is not supported (optional) page_number = 56 # int | Deprecated, paging is not supported (optional) expand = 'expand_example' # str | Deprecated, expand settings on the single MU route (optional) feature = 'feature_example' # str | If specified, the list of management units for which the user is authorized to use the requested feature will be returned (optional) division_id = 'division_id_example' # str | If specified, the list of management units belonging to the specified division will be returned (optional) try: # Get management units api_response = api_instance.get_workforcemanagement_managementunits(page_size=page_size, page_number=page_number, expand=expand, feature=feature, division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunits: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits Genesys Cloud Python SDK.,Genesys describes this as an API used to: Add a management unit. It may take a minute or two for a new management unit to be available for api operations,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.CreateManagementUnitApiRequest() # CreateManagementUnitApiRequest | body (optional) try: # Add a management unit api_response = api_instance.post_workforcemanagement_managementunits(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunits: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/divisionviews Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get management units across divisions,"```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.WorkforceManagementApi(); division_id = ['division_id_example'] # list[str] | The divisionIds to filter by. If omitted, will return all divisions (optional) try: # Get management units across divisions api_response = api_instance.get_workforcemanagement_managementunits_divisionviews(division_id=division_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunits_divisionviews: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete management unit,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. try: # Delete management unit api_instance.delete_workforcemanagement_managementunit(management_unit_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get management unit. settings.shortTermForecasting is deprecated and now lives on the business unit,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. expand = ['expand_example'] # list[str] | (optional) try: # Get management unit api_response = api_instance.get_workforcemanagement_managementunit(management_unit_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update the requested management unit,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. body = PureCloudPlatformClientV2.UpdateManagementUnitRequest() # UpdateManagementUnitRequest | body (optional) try: # Update the requested management unit api_response = api_instance.patch_workforcemanagement_managementunit(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/adherence Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of user schedule adherence records for the requested management unit,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Get a list of user schedule adherence records for the requested management unit api_response = api_instance.get_workforcemanagement_managementunit_adherence(management_unit_id, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_adherence: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update agent configurations,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. body = PureCloudPlatformClientV2.UpdateMuAgentsRequest() # UpdateMuAgentsRequest | body (optional) try: # Update agent configurations api_instance.patch_workforcemanagement_managementunit_agents(management_unit_id, body=body) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_agents: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get data for agent in the management unit,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. agent_id = 'agent_id_example' # str | The agent id exclude_capabilities = True # bool | Excludes all capabilities of the agent such as queues, languages, and skills (optional) expand = ['expand_example'] # list[str] | (optional) try: # Get data for agent in the management unit api_response = api_instance.get_workforcemanagement_managementunit_agent(management_unit_id, agent_id, exclude_capabilities=exclude_capabilities, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_agent: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}/shifttrades Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets all the shift trades for a given 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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. agent_id = 'agent_id_example' # str | The agent id try: # Gets all the shift trades for a given agent api_response = api_instance.get_workforcemanagement_managementunit_agent_shifttrades(management_unit_id, agent_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_agent_shifttrades: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query published schedules for given given time range for set of users,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) body = PureCloudPlatformClientV2.BuSearchAgentSchedulesRequest() # BuSearchAgentSchedulesRequest | body (optional) try: # Query published schedules for given given time range for set of users api_response = api_instance.post_workforcemanagement_managementunit_agentschedules_search(management_unit_id, force_async=force_async, force_download_service=force_download_service, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_agentschedules_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Request a historical adherence report. The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true","```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit body = PureCloudPlatformClientV2.WfmHistoricalAdherenceQuery() # WfmHistoricalAdherenceQuery | body (optional) try: # Request a historical adherence report api_response = api_instance.post_workforcemanagement_managementunit_historicaladherencequery(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_historicaladherencequery: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/move Genesys Cloud Python SDK.,Genesys describes this as an API used to: Move the requested management unit to a new business unit. Returns status 200 if the management unit is already in the requested business unit,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. body = PureCloudPlatformClientV2.MoveManagementUnitRequest() # MoveManagementUnitRequest | body (optional) try: # Move the requested management unit to a new business unit api_response = api_instance.post_workforcemanagement_managementunit_move(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_move: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/matched Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a summary of all shift trades in the matched state,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. try: # Gets a summary of all shift trades in the matched state api_response = api_instance.get_workforcemanagement_managementunit_shifttrades_matched(management_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_shifttrades_matched: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/shifttrades/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets list of users available for whom you can send direct shift trade requests,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. try: # Gets list of users available for whom you can send direct shift trade requests api_response = api_instance.get_workforcemanagement_managementunit_shifttrades_users(management_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_shifttrades_users: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Request a historical shrinkage report. The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body.","```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit body = PureCloudPlatformClientV2.WfmHistoricalShrinkageRequest() # WfmHistoricalShrinkageRequest | body (optional) try: # Request a historical shrinkage report api_response = api_instance.post_workforcemanagement_managementunit_shrinkage_jobs(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_shrinkage_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Gets a list of time off limit objects under management unit. Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.","```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. try: # Gets a list of time off limit objects under management unit. api_response = api_instance.get_workforcemanagement_managementunit_timeofflimits(management_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_timeofflimits: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Creates a new time off limit object under management unit. Only one limit object is allowed under management unit, so an attempt to create second object will fail.","```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. body = PureCloudPlatformClientV2.CreateTimeOffLimitRequest() # CreateTimeOffLimitRequest | body (optional) try: # Creates a new time off limit object under management unit. api_response = api_instance.post_workforcemanagement_managementunit_timeofflimits(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeofflimits: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves time off limit related values based on a given set of filters.,"```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. body = PureCloudPlatformClientV2.QueryTimeOffLimitValuesRequest() # QueryTimeOffLimitValuesRequest | body (optional) try: # Retrieves time off limit related values based on a given set of filters. api_response = api_instance.post_workforcemanagement_managementunit_timeofflimits_values_query(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeofflimits_values_query: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a time off limit object,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. time_off_limit_id = 'time_off_limit_id_example' # str | The ID of the time off limit object to delete try: # Deletes a time off limit object api_instance.delete_workforcemanagement_managementunit_timeofflimit(management_unit_id, time_off_limit_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_timeofflimit: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Gets a time off limit object. Returns properties of time off limit object, but not daily values.","```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. time_off_limit_id = 'time_off_limit_id_example' # str | The ID of the time off limit to fetch try: # Gets a time off limit object api_response = api_instance.get_workforcemanagement_managementunit_timeofflimit(management_unit_id, time_off_limit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_timeofflimit: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId} Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Updates a time off limit object. Updates time off limit object properties, but not daily values.","```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. time_off_limit_id = 'time_off_limit_id_example' # str | The id of time off limit object to update body = PureCloudPlatformClientV2.UpdateTimeOffLimitRequest() # UpdateTimeOffLimitRequest | body (optional) try: # Updates a time off limit object. api_response = api_instance.patch_workforcemanagement_managementunit_timeofflimit(management_unit_id, time_off_limit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_timeofflimit: %s\n"" % e)```" Provide a Python example that uses the PUT /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Sets daily values for a date range of time off limit object. Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API","```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. time_off_limit_id = 'time_off_limit_id_example' # str | The ID of the time off limit object to set values for body = PureCloudPlatformClientV2.SetTimeOffLimitValuesRequest() # SetTimeOffLimitValuesRequest | body (optional) try: # Sets daily values for a date range of time off limit object api_response = api_instance.put_workforcemanagement_managementunit_timeofflimit_values(management_unit_id, time_off_limit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->put_workforcemanagement_managementunit_timeofflimit_values: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a list of time off plans,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit try: # Gets a list of time off plans api_response = api_instance.get_workforcemanagement_managementunit_timeoffplans(management_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_timeoffplans: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans Genesys Cloud Python SDK.,Genesys describes this as an API used to: Creates a new time off plan,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit body = PureCloudPlatformClientV2.CreateTimeOffPlanRequest() # CreateTimeOffPlanRequest | body (optional) try: # Creates a new time off plan api_response = api_instance.post_workforcemanagement_managementunit_timeoffplans(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffplans: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Deletes a time off plan,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit time_off_plan_id = 'time_off_plan_id_example' # str | The ID of the time off plan to delete try: # Deletes a time off plan api_instance.delete_workforcemanagement_managementunit_timeoffplan(management_unit_id, time_off_plan_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_timeoffplan: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets a time off plan,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit time_off_plan_id = 'time_off_plan_id_example' # str | The ID of the time off plan to fetch try: # Gets a time off plan api_response = api_instance.get_workforcemanagement_managementunit_timeoffplan(management_unit_id, time_off_plan_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_timeoffplan: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a time off plan,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit time_off_plan_id = 'time_off_plan_id_example' # str | The ID of the time off plan to update body = PureCloudPlatformClientV2.UpdateTimeOffPlanRequest() # UpdateTimeOffPlanRequest | body (optional) try: # Updates a time off plan api_response = api_instance.patch_workforcemanagement_managementunit_timeoffplan(management_unit_id, time_off_plan_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_timeoffplan: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new time off request,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. body = PureCloudPlatformClientV2.CreateAdminTimeOffRequest() # CreateAdminTimeOffRequest | body (optional) try: # Create a new time off request api_response = api_instance.post_workforcemanagement_managementunit_timeoffrequests(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves integration statuses for a list of time off requests,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. body = PureCloudPlatformClientV2.QueryTimeOffIntegrationStatusRequest() # QueryTimeOffIntegrationStatusRequest | body (optional) try: # Retrieves integration statuses for a list of time off requests api_response = api_instance.post_workforcemanagement_managementunit_timeoffrequests_integrationstatus_query(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_integrationstatus_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Fetches time off requests matching the conditions specified in the request body. Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters","```import PureCloudPlatformClientV2 from PureCloudPlatformClientV2.rest import ApiException from pprint import pprint # Configure OAuth2 access token for authorization: PureCloud OAuth PureCloudPlatformClientV2.configuration.access_token = 'your_access_token' # or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...) # create an instance of the API class api_instance = PureCloudPlatformClientV2.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) body = PureCloudPlatformClientV2.TimeOffRequestQueryBody() # TimeOffRequestQueryBody | body (optional) try: # Fetches time off requests matching the conditions specified in the request body api_response = api_instance.post_workforcemanagement_managementunit_timeoffrequests_query(management_unit_id, force_download_service=force_download_service, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_query: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves daily waitlist position for a list of time off requests,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. body = PureCloudPlatformClientV2.QueryWaitlistPositionsRequest() # QueryWaitlistPositionsRequest | body (optional) try: # Retrieves daily waitlist position for a list of time off requests api_response = api_instance.post_workforcemanagement_managementunit_timeoffrequests_waitlistpositions_query(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_timeoffrequests_waitlistpositions_query: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus Genesys Cloud Python SDK.,Genesys describes this as an API used to: Set integration status for a time off request.,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. time_off_request_id = 'time_off_request_id_example' # str | The ID of the time off request. user_id = 'user_id_example' # str | The ID of user to whom the time off request belongs. body = PureCloudPlatformClientV2.SetTimeOffIntegrationStatusRequest() # SetTimeOffIntegrationStatusRequest | body (optional) try: # Set integration status for a time off request. api_response = api_instance.patch_workforcemanagement_managementunit_timeoffrequest_user_integrationstatus(management_unit_id, time_off_request_id, user_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_timeoffrequest_user_integrationstatus: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get users in the management unit,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. try: # Get users in the management unit api_response = api_instance.get_workforcemanagement_managementunit_users(management_unit_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_users: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffbalance/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query time off balances for a given user for specified activity code and dates,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit user_id = 'user_id_example' # str | The ID of the user body = PureCloudPlatformClientV2.TimeOffBalanceRequest() # TimeOffBalanceRequest | The request body try: # Query time off balances for a given user for specified activity code and dates api_response = api_instance.post_workforcemanagement_managementunit_user_timeoffbalance_jobs(management_unit_id, user_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_user_timeoffbalance_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of time off requests for a given 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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. user_id = 'user_id_example' # str | The userId to whom the Time Off Request applies. recently_reviewed = False # bool | Limit results to requests that have been reviewed within the preceding 30 days (optional) (default to False) try: # Get a list of time off requests for a given user api_response = api_instance.get_workforcemanagement_managementunit_user_timeoffrequests(management_unit_id, user_id, recently_reviewed=recently_reviewed) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequests: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Estimates available time off for an 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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit user_id = 'user_id_example' # str | The id of the user for whom the time off request estimate is requested body = PureCloudPlatformClientV2.EstimateAvailableTimeOffRequest() # EstimateAvailableTimeOffRequest | body (optional) try: # Estimates available time off for an agent api_response = api_instance.post_workforcemanagement_managementunit_user_timeoffrequests_estimate(management_unit_id, user_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_user_timeoffrequests_estimate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a time off request,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. user_id = 'user_id_example' # str | The userId to whom the Time Off Request applies. time_off_request_id = 'time_off_request_id_example' # str | Time Off Request Id try: # Get a time off request api_response = api_instance.get_workforcemanagement_managementunit_user_timeoffrequest(management_unit_id, user_id, time_off_request_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequest: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a time off request,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. user_id = 'user_id_example' # str | The id of the user the requested time off request belongs to time_off_request_id = 'time_off_request_id_example' # str | The id of the time off request to update body = PureCloudPlatformClientV2.AdminTimeOffRequestPatch() # AdminTimeOffRequestPatch | body (optional) try: # Update a time off request api_response = api_instance.patch_workforcemanagement_managementunit_user_timeoffrequest(management_unit_id, user_id, time_off_request_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_user_timeoffrequest: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeoffbalance/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query time off balances for dates spanned by a given time off request,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. user_id = 'user_id_example' # str | The userId to whom the time off request applies. time_off_request_id = 'time_off_request_id_example' # str | The time off request id. try: # Query time off balances for dates spanned by a given time off request api_response = api_instance.post_workforcemanagement_managementunit_user_timeoffrequest_timeoffbalance_jobs(management_unit_id, user_id, time_off_request_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_user_timeoffrequest_timeoffbalance_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}/timeofflimits Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Retrieves time off limit, allocated and waitlisted values according to specific time off request","```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit. user_id = 'user_id_example' # str | The userId to whom the time off request applies. time_off_request_id = 'time_off_request_id_example' # str | The ID of the time off request, which dates and activityCodeId determine limit values to retrieve try: # Retrieves time off limit, allocated and waitlisted values according to specific time off request api_response = api_instance.get_workforcemanagement_managementunit_user_timeoffrequest_timeofflimits(management_unit_id, user_id, time_off_request_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_user_timeoffrequest_timeofflimits: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets all the shift trades for a given week,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. week_date_id = '2013-10-20' # date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd evaluate_matches = True # bool | Whether to evaluate the matches for violations (optional) (default to True) force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Gets all the shift trades for a given week api_response = api_instance.get_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, evaluate_matches=evaluate_matches, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_week_shifttrades: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades Genesys Cloud Python SDK.,Genesys describes this as an API used to: Adds a shift trade,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. week_date_id = '2013-10-20' # date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd body = PureCloudPlatformClientV2.AddShiftTradeRequest() # AddShiftTradeRequest | body try: # Adds a shift trade api_response = api_instance.post_workforcemanagement_managementunit_week_shifttrades(management_unit_id, week_date_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrades: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/search Genesys Cloud Python SDK.,Genesys describes this as an API used to: Searches for potential shift trade matches for the current 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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. week_date_id = '2013-10-20' # date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd body = PureCloudPlatformClientV2.SearchShiftTradesRequest() # SearchShiftTradesRequest | body force_download_service = True # bool | Force the result of this operation to be sent via download service. For testing/app development purposes (optional) try: # Searches for potential shift trade matches for the current agent api_response = api_instance.post_workforcemanagement_managementunit_week_shifttrades_search(management_unit_id, week_date_id, body, force_download_service=force_download_service) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrades_search: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/state/bulk Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Updates the state of a batch of shift trades. Admin functionality is not supported with ""mine"".","```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. week_date_id = '2013-10-20' # date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd body = PureCloudPlatformClientV2.BulkShiftTradeStateUpdateRequest() # BulkShiftTradeStateUpdateRequest | body force_async = True # bool | Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes (optional) try: # Updates the state of a batch of shift trades api_response = api_instance.post_workforcemanagement_managementunit_week_shifttrades_state_bulk(management_unit_id, week_date_id, body, force_async=force_async) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrades_state_bulk: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Updates a shift trade. This route can only be called by the initiating 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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. week_date_id = '2013-10-20' # date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd trade_id = 'trade_id_example' # str | The ID of the shift trade to update body = PureCloudPlatformClientV2.PatchShiftTradeRequest() # PatchShiftTradeRequest | body try: # Updates a shift trade. This route can only be called by the initiating agent api_response = api_instance.patch_workforcemanagement_managementunit_week_shifttrade(management_unit_id, week_date_id, trade_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_week_shifttrade: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/weeks/{weekDateId}/shifttrades/{tradeId}/match Genesys Cloud Python SDK.,Genesys describes this as an API used to: Matches a shift trade. This route can only be called by the receiving 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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. week_date_id = '2013-10-20' # date | The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd trade_id = 'trade_id_example' # str | The ID of the shift trade to update body = PureCloudPlatformClientV2.MatchShiftTradeRequest() # MatchShiftTradeRequest | body try: # Matches a shift trade. This route can only be called by the receiving agent api_response = api_instance.post_workforcemanagement_managementunit_week_shifttrade_match(management_unit_id, week_date_id, trade_id, body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_week_shifttrade_match: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get work plan rotations,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. expand = ['expand_example'] # list[str] | (optional) try: # Get work plan rotations api_response = api_instance.get_workforcemanagement_managementunit_workplanrotations(management_unit_id, expand=expand) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_workplanrotations: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new work plan rotation,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. body = PureCloudPlatformClientV2.AddWorkPlanRotationRequest() # AddWorkPlanRotationRequest | body (optional) try: # Create a new work plan rotation api_response = api_instance.post_workforcemanagement_managementunit_workplanrotations(management_unit_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplanrotations: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a work plan rotation,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. work_plan_rotation_id = 'work_plan_rotation_id_example' # str | The ID of the work plan rotation to be deleted try: # Delete a work plan rotation api_instance.delete_workforcemanagement_managementunit_workplanrotation(management_unit_id, work_plan_rotation_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_workplanrotation: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a work plan rotation,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. work_plan_rotation_id = 'work_plan_rotation_id_example' # str | The ID of the work plan rotation to fetch try: # Get a work plan rotation api_response = api_instance.get_workforcemanagement_managementunit_workplanrotation(management_unit_id, work_plan_rotation_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_workplanrotation: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a work plan rotation,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. work_plan_rotation_id = 'work_plan_rotation_id_example' # str | The ID of the work plan rotation to update body = PureCloudPlatformClientV2.UpdateWorkPlanRotationRequest() # UpdateWorkPlanRotationRequest | body (optional) try: # Update a work plan rotation api_response = api_instance.patch_workforcemanagement_managementunit_workplanrotation(management_unit_id, work_plan_rotation_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_workplanrotation: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a copy of work plan rotation,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. work_plan_rotation_id = 'work_plan_rotation_id_example' # str | The ID of the work plan rotation to create a copy body = PureCloudPlatformClientV2.CopyWorkPlanRotationRequest() # CopyWorkPlanRotationRequest | body (optional) try: # Create a copy of work plan rotation api_response = api_instance.post_workforcemanagement_managementunit_workplanrotation_copy(management_unit_id, work_plan_rotation_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplanrotation_copy: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Get work plans. ""expand=details"" is deprecated","```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. expand = ['expand_example'] # list[str] | Include to access additional data on the work plans (optional) exclude = ['exclude_example'] # list[str] | Exclude specific data on the work plans from the response (optional) try: # Get work plans api_response = api_instance.get_workforcemanagement_managementunit_workplans(management_unit_id, expand=expand, exclude=exclude) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_workplans: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a new work plan,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. validation_mode = 'validation_mode_example' # str | Allows to create work plan even if the validation result is invalid (optional) body = PureCloudPlatformClientV2.CreateWorkPlan() # CreateWorkPlan | body (optional) try: # Create a new work plan api_response = api_instance.post_workforcemanagement_managementunit_workplans(management_unit_id, validation_mode=validation_mode, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplans: %s\n"" % e)```" Provide a Python example that uses the DELETE /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Delete a work plan,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. work_plan_id = 'work_plan_id_example' # str | The ID of the work plan to delete try: # Delete a work plan api_instance.delete_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id) except ApiException as e: print(""Exception when calling WorkforceManagementApi->delete_workforcemanagement_managementunit_workplan: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a work plan,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. work_plan_id = 'work_plan_id_example' # str | The ID of the work plan to fetch include_only = ['include_only_example'] # list[str] | limit response to the specified fields (optional) try: # Get a work plan api_response = api_instance.get_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, include_only=include_only) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_managementunit_workplan: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a work plan,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. work_plan_id = 'work_plan_id_example' # str | The ID of the work plan to update validation_mode = 'validation_mode_example' # str | Allows to update work plan even if validation result is invalid (optional) body = PureCloudPlatformClientV2.WorkPlan() # WorkPlan | body (optional) try: # Update a work plan api_response = api_instance.patch_workforcemanagement_managementunit_workplan(management_unit_id, work_plan_id, validation_mode=validation_mode, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_managementunit_workplan: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a copy of work plan,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. work_plan_id = 'work_plan_id_example' # str | The ID of the work plan to create a copy body = PureCloudPlatformClientV2.CopyWorkPlan() # CopyWorkPlan | body (optional) try: # Create a copy of work plan api_response = api_instance.post_workforcemanagement_managementunit_workplan_copy(management_unit_id, work_plan_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplan_copy: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Validate Work Plan,"```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.WorkforceManagementApi(); management_unit_id = 'management_unit_id_example' # str | The ID of the management unit, or 'mine' for the management unit of the logged-in user. work_plan_id = 'work_plan_id_example' # str | The ID of the work plan to validate. For new work plan, use the word 'new' for the ID. expand = ['expand_example'] # list[str] | (optional) body = PureCloudPlatformClientV2.WorkPlanValidationRequest() # WorkPlanValidationRequest | body (optional) try: # Validate Work Plan api_response = api_instance.post_workforcemanagement_managementunit_workplan_validate(management_unit_id, work_plan_id, expand=expand, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_managementunit_workplan_validate: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/notifications Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of notifications for the current user. Notifications are only initially sent if you have the relevant Notify and Edit permissions,"```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.WorkforceManagementApi(); try: # Get a list of notifications for the current user api_response = api_instance.get_workforcemanagement_notifications() pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_notifications: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/notifications/update Genesys Cloud Python SDK.,Genesys describes this as an API used to: Mark a list of notifications as read or unread,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.UpdateNotificationsRequest() # UpdateNotificationsRequest | body (optional) try: # Mark a list of notifications as read or unread api_response = api_instance.post_workforcemanagement_notifications_update(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_notifications_update: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/schedulingjobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get status of the scheduling 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.WorkforceManagementApi(); job_id = 'job_id_example' # str | The id of the scheduling job try: # Get status of the scheduling job api_response = api_instance.get_workforcemanagement_schedulingjob(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_schedulingjob: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/shifttrades Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets all of my shift trades,"```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.WorkforceManagementApi(); try: # Gets all of my shift trades api_response = api_instance.get_workforcemanagement_shifttrades() pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_shifttrades: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/shrinkage/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Request to fetch the status of the historical shrinkage query,"```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.WorkforceManagementApi(); job_id = 'job_id_example' # str | jobId try: # Request to fetch the status of the historical shrinkage query api_response = api_instance.get_workforcemanagement_shrinkage_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_shrinkage_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/teams/{teamId}/adherence/historical Genesys Cloud Python SDK.,"Genesys describes this as an API used to: Request a teams historical adherence report. The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true","```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.WorkforceManagementApi(); team_id = 'team_id_example' # str | The ID of the team body = PureCloudPlatformClientV2.WfmHistoricalAdherenceQueryForTeams() # WfmHistoricalAdherenceQueryForTeams | body (optional) try: # Request a teams historical adherence report api_response = api_instance.post_workforcemanagement_team_adherence_historical(team_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_team_adherence_historical: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Request a historical shrinkage report. The maximum supported range for historical shrinkage queries is up to 32 days,"```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.WorkforceManagementApi(); team_id = 'team_id_example' # str | The ID of the team body = PureCloudPlatformClientV2.WfmHistoricalShrinkageTeamsRequest() # WfmHistoricalShrinkageTeamsRequest | body (optional) try: # Request a historical shrinkage report api_response = api_instance.post_workforcemanagement_team_shrinkage_jobs(team_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_team_shrinkage_jobs: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/timeoffbalance/jobs Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query time off balances for the current user for specified activity code and dates,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.TimeOffBalanceRequest() # TimeOffBalanceRequest | The request body try: # Query time off balances for the current user for specified activity code and dates api_response = api_instance.post_workforcemanagement_timeoffbalance_jobs(body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_timeoffbalance_jobs: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/timeoffbalance/jobs/{jobId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Query the results of time off types 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.WorkforceManagementApi(); job_id = 'job_id_example' # str | The ID of the job. try: # Query the results of time off types job api_response = api_instance.get_workforcemanagement_timeoffbalance_job(job_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffbalance_job: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/timeofflimits/available/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Queries available time off for the current 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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.AvailableTimeOffRequest() # AvailableTimeOffRequest | body (optional) try: # Queries available time off for the current user api_response = api_instance.post_workforcemanagement_timeofflimits_available_query(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_timeofflimits_available_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/timeoffrequests Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a list of time off requests for the current 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.WorkforceManagementApi(); recently_reviewed = False # bool | Limit results to requests that have been reviewed within the preceding 30 days (optional) (default to False) try: # Get a list of time off requests for the current user api_response = api_instance.get_workforcemanagement_timeoffrequests(recently_reviewed=recently_reviewed) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequests: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/timeoffrequests Genesys Cloud Python SDK.,Genesys describes this as an API used to: Create a time off request for the current 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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.CreateAgentTimeOffRequest() # CreateAgentTimeOffRequest | body (optional) try: # Create a time off request for the current user api_response = api_instance.post_workforcemanagement_timeoffrequests(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_timeoffrequests: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/timeoffrequests/estimate Genesys Cloud Python SDK.,Genesys describes this as an API used to: Estimates available time off for current 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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.EstimateAvailableTimeOffRequest() # EstimateAvailableTimeOffRequest | body (optional) try: # Estimates available time off for current user api_response = api_instance.post_workforcemanagement_timeoffrequests_estimate(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_timeoffrequests_estimate: %s\n"" % e)```" Provide a Python example that uses the POST /api/v2/workforcemanagement/timeoffrequests/integrationstatus/query Genesys Cloud Python SDK.,Genesys describes this as an API used to: Retrieves integration statuses for a list of current user time off requests,"```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.WorkforceManagementApi(); body = PureCloudPlatformClientV2.CurrentUserTimeOffIntegrationStatusRequest() # CurrentUserTimeOffIntegrationStatusRequest | body (optional) try: # Retrieves integration statuses for a list of current user time off requests api_response = api_instance.post_workforcemanagement_timeoffrequests_integrationstatus_query(body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->post_workforcemanagement_timeoffrequests_integrationstatus_query: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get a time off request for the current 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.WorkforceManagementApi(); time_off_request_id = 'time_off_request_id_example' # str | The ID of the time off request try: # Get a time off request for the current user api_response = api_instance.get_workforcemanagement_timeoffrequest(time_off_request_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequest: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId} Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update a time off request for the current 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.WorkforceManagementApi(); time_off_request_id = 'time_off_request_id_example' # str | The ID of the time off request body = PureCloudPlatformClientV2.AgentTimeOffRequestPatch() # AgentTimeOffRequestPatch | body (optional) try: # Update a time off request for the current user api_response = api_instance.patch_workforcemanagement_timeoffrequest(time_off_request_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_timeoffrequest: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}/waitlistpositions Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get the daily waitlist positions of a time off request for the current 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.WorkforceManagementApi(); time_off_request_id = 'time_off_request_id_example' # str | The ID of the time off request try: # Get the daily waitlist positions of a time off request for the current user api_response = api_instance.get_workforcemanagement_timeoffrequest_waitlistpositions(time_off_request_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_timeoffrequest_waitlistpositions: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/users/workplanbidranks/bulk Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.,"```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.WorkforceManagementApi(); body = [PureCloudPlatformClientV2.WorkPlanBidRanks()] # list[WorkPlanBidRanks] | Users try: # Update bulk work plan bid ranks on users. Max 50 users can be updated at a time. api_response = api_instance.patch_workforcemanagement_users_workplanbidranks_bulk(body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_users_workplanbidranks_bulk: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/users/{userId}/workplanbidranks Genesys Cloud Python SDK.,Genesys describes this as an API used to: Get work plan bid ranks for a 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.WorkforceManagementApi(); user_id = 'user_id_example' # str | The userId to whom the work plan bid ranks apply. try: # Get work plan bid ranks for a user api_response = api_instance.get_workforcemanagement_user_workplanbidranks(user_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_user_workplanbidranks: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/users/{userId}/workplanbidranks Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update work plan bid ranks for a 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.WorkforceManagementApi(); user_id = 'user_id_example' # str | The userId to whom the work plan bid ranks apply. body = PureCloudPlatformClientV2.WorkPlanBidRanks() # WorkPlanBidRanks | body (optional) try: # Update work plan bid ranks for a user api_response = api_instance.patch_workforcemanagement_user_workplanbidranks(user_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_user_workplanbidranks: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/workplanbids Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets the list of work plan bids that belong to an 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.WorkforceManagementApi(); try: # Gets the list of work plan bids that belong to an agent api_response = api_instance.get_workforcemanagement_workplanbids() pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_workplanbids: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/workplanbids/{bidId}/preferences Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets an agent's work plan bidding preference,"```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.WorkforceManagementApi(); bid_id = 'bid_id_example' # str | The ID of the work plan bid try: # Gets an agent's work plan bidding preference api_response = api_instance.get_workforcemanagement_workplanbid_preferences(bid_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_workplanbid_preferences: %s\n"" % e)```" Provide a Python example that uses the PATCH /api/v2/workforcemanagement/workplanbids/{bidId}/preferences Genesys Cloud Python SDK.,Genesys describes this as an API used to: Update an agent's work plan bidding preference,"```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.WorkforceManagementApi(); bid_id = 'bid_id_example' # str | The ID of the work plan bid body = PureCloudPlatformClientV2.UpdateAgentWorkPlanBiddingPreference() # UpdateAgentWorkPlanBiddingPreference | body (optional) try: # Update an agent's work plan bidding preference api_response = api_instance.patch_workforcemanagement_workplanbid_preferences(bid_id, body=body) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->patch_workforcemanagement_workplanbid_preferences: %s\n"" % e)```" Provide a Python example that uses the GET /api/v2/workforcemanagement/workplanbids/{bidId}/workplans Genesys Cloud Python SDK.,Genesys describes this as an API used to: Gets an agent's work plans for a bid,"```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.WorkforceManagementApi(); bid_id = 'bid_id_example' # str | The ID of the work plan bid try: # Gets an agent's work plans for a bid api_response = api_instance.get_workforcemanagement_workplanbid_workplans(bid_id) pprint(api_response) except ApiException as e: print(""Exception when calling WorkforceManagementApi->get_workforcemanagement_workplanbid_workplans: %s\n"" % e)```"