instruction
stringlengths 81
221
| input
stringlengths 50
1.19k
| output
stringlengths 525
3.61k
|
|---|---|---|
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)```
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.