instruction
stringlengths 81
221
| input
stringlengths 50
1.19k
| output
stringlengths 525
3.61k
|
|---|---|---|
Provide a Python example that uses the GET /api/v2/locations/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search locations using the q64 value returned from a previous search
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SearchApi();
q64 = 'q64_example' # str | q64
expand = ['expand_example'] # list[str] | Provides more details about a specified resource (optional)
try:
# Search locations using the q64 value returned from a previous search
api_response = api_instance.get_locations_search(q64, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->get_locations_search: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/locations/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search locations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SearchApi();
body = PureCloudPlatformClientV2.LocationSearchRequest() # LocationSearchRequest | Search request options
try:
# Search locations
api_response = api_instance.post_locations_search(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->post_locations_search: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search using the q64 value returned from a previous search.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SuggestApi();
q64 = 'q64_example' # str | q64
expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional)
profile = True # bool | profile (optional) (default to True)
try:
# Search using the q64 value returned from a previous search.
api_response = api_instance.get_search(q64, expand=expand, profile=profile)
pprint(api_response)
except ApiException as e:
print("Exception when calling SuggestApi->get_search: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search resources.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SuggestApi();
body = PureCloudPlatformClientV2.SearchRequest() # SearchRequest | Search request options
profile = True # bool | profile (optional) (default to True)
try:
# Search resources.
api_response = api_instance.post_search(body, profile=profile)
pprint(api_response)
except ApiException as e:
print("Exception when calling SuggestApi->post_search: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/search/suggest Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Suggest resources using the q64 value returned from a previous suggest query.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SuggestApi();
q64 = 'q64_example' # str | q64
expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional)
profile = True # bool | profile (optional) (default to True)
try:
# Suggest resources using the q64 value returned from a previous suggest query.
api_response = api_instance.get_search_suggest(q64, expand=expand, profile=profile)
pprint(api_response)
except ApiException as e:
print("Exception when calling SuggestApi->get_search_suggest: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/search/suggest Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Suggest resources.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SuggestApi();
body = PureCloudPlatformClientV2.SuggestSearchRequest() # SuggestSearchRequest | Search request options
profile = True # bool | profile (optional) (default to True)
try:
# Suggest resources.
api_response = api_instance.post_search_suggest(body, profile=profile)
pprint(api_response)
except ApiException as e:
print("Exception when calling SuggestApi->post_search_suggest: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/speechandtextanalytics/transcripts/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search resources.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.TranscriptSearchRequest() # TranscriptSearchRequest | Search request options
try:
# Search resources.
api_response = api_instance.post_speechandtextanalytics_transcripts_search(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_transcripts_search: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/teams/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search resources.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TeamsApi();
body = PureCloudPlatformClientV2.TeamSearchRequest() # TeamSearchRequest | Search request options
try:
# Search resources.
api_response = api_instance.post_teams_search(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling TeamsApi->post_teams_search: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/users/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search users using the q64 value returned from a previous search
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
q64 = 'q64_example' # str | q64
expand = ['expand_example'] # list[str] | expand (optional)
integration_presence_source = 'integration_presence_source_example' # str | integrationPresenceSource (optional)
try:
# Search users using the q64 value returned from a previous search
api_response = api_instance.get_users_search(q64, expand=expand, integration_presence_source=integration_presence_source)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->get_users_search: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/users/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search users
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
body = PureCloudPlatformClientV2.UserSearchRequest() # UserSearchRequest | Search request options
try:
# Search users
api_response = api_instance.post_users_search(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->post_users_search: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/users/search/teams/assign Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search users assigned to teams
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.UsersApi();
body = PureCloudPlatformClientV2.UserSearchRequest() # UserSearchRequest | Search request options
try:
# Search users assigned to teams
api_response = api_instance.post_users_search_teams_assign(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling UsersApi->post_users_search_teams_assign: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/voicemail/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search voicemails using the q64 value returned from a previous search
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.VoicemailApi();
q64 = 'q64_example' # str | q64
expand = ['expand_example'] # list[str] | expand (optional)
try:
# Search voicemails using the q64 value returned from a previous search
api_response = api_instance.get_voicemail_search(q64, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling VoicemailApi->get_voicemail_search: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/voicemail/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search voicemails
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.VoicemailApi();
body = PureCloudPlatformClientV2.VoicemailSearchRequest() # VoicemailSearchRequest | Search request options
try:
# Search voicemails
api_response = api_instance.post_voicemail_search(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling VoicemailApi->post_voicemail_search: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/emails/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get email Contact Center settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
try:
# Get email Contact Center settings
api_response = api_instance.get_emails_settings()
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->get_emails_settings: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/emails/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Patch email Contact Center settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
body = PureCloudPlatformClientV2.EmailSettings() # EmailSettings | (optional)
try:
# Patch email Contact Center settings
api_response = api_instance.patch_emails_settings(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->patch_emails_settings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/settings/executiondata Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the execution history enabled setting. Get the execution history enabled setting.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
try:
# Get the execution history enabled setting.
api_response = api_instance.get_settings_executiondata()
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->get_settings_executiondata: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/settings/executiondata Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Edit the execution history on off setting. Edit the execution history on off setting.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
body = PureCloudPlatformClientV2.ExecutionDataSettingsRequest() # ExecutionDataSettingsRequest | New Execution Data Setting
try:
# Edit the execution history on off setting.
api_response = api_instance.patch_settings_executiondata(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->patch_settings_executiondata: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete agent auto answer settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to
try:
# Delete agent auto answer settings
api_instance.delete_users_agentui_agents_autoanswer_agent_id_settings(agent_id)
except ApiException as e:
print("Exception when calling SettingsApi->delete_users_agentui_agents_autoanswer_agent_id_settings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get agent auto answer settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to
try:
# Get agent auto answer settings
api_response = api_instance.get_users_agentui_agents_autoanswer_agent_id_settings(agent_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->get_users_agentui_agents_autoanswer_agent_id_settings: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update agent auto answer settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to
body = PureCloudPlatformClientV2.AutoAnswerSettings() # AutoAnswerSettings | AutoAnswerSettings
try:
# Update agent auto answer settings
api_response = api_instance.patch_users_agentui_agents_autoanswer_agent_id_settings(agent_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->patch_users_agentui_agents_autoanswer_agent_id_settings: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/users/agentui/agents/autoanswer/{agentId}/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Set agent auto answer settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
agent_id = 'agent_id_example' # str | The agent to apply the auto answer settings to
body = PureCloudPlatformClientV2.AutoAnswerSettings() # AutoAnswerSettings | AutoAnswerSettings
try:
# Set agent auto answer settings
api_response = api_instance.put_users_agentui_agents_autoanswer_agent_id_settings(agent_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->put_users_agentui_agents_autoanswer_agent_id_settings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/categories Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of Speech and Text Analytics categories
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
page_size = 25 # int | The page size for the listing. The max that will be returned is 50. (optional) (default to 25)
page_number = 1 # int | The page number for the listing (optional) (default to 1)
name = 'name_example' # str | The category name filter applied to the listing (optional)
sort_order = ''asc'' # str | The sort order for the listing (optional) (default to 'asc')
sort_by = ''name'' # str | The field to sort by for the listing (optional) (default to 'name')
ids = ['ids_example'] # list[str] | Comma separated Category IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. (optional)
try:
# Get the list of Speech and Text Analytics categories
api_response = api_instance.get_speechandtextanalytics_categories(page_size=page_size, page_number=page_number, name=name, sort_order=sort_order, sort_by=sort_by, ids=ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_categories: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/speechandtextanalytics/categories Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create new Speech & Text Analytics category
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.CategoryRequest() # CategoryRequest | The category to create
try:
# Create new Speech & Text Analytics category
api_response = api_instance.post_speechandtextanalytics_categories(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_categories: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/categories/{categoryId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a Speech & Text Analytics category by ID
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
category_id = 'category_id_example' # str | The id of the category
try:
# Delete a Speech & Text Analytics category by ID
api_instance.delete_speechandtextanalytics_category(category_id)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_category: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/categories/{categoryId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Speech & Text Analytics Category by ID
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
category_id = 'category_id_example' # str | The id of the category
try:
# Get a Speech & Text Analytics Category by ID
api_response = api_instance.get_speechandtextanalytics_category(category_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_category: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/categories/{categoryId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a Speech & Text Analytics category by ID
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
category_id = 'category_id_example' # str | The id of the category
body = PureCloudPlatformClientV2.CategoryRequest() # CategoryRequest | The updated category
try:
# Update a Speech & Text Analytics category by ID
api_response = api_instance.put_speechandtextanalytics_category(category_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_category: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/conversations/{conversationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Speech and Text Analytics for a specific conversation
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
conversation_id = 'conversation_id_example' # str | Conversation Id
try:
# Get Speech and Text Analytics for a specific conversation
api_response = api_instance.get_speechandtextanalytics_conversation(conversation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/conversations/{conversationId}/categories Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of detected Speech and Text Analytics categories of conversation
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
conversation_id = 'conversation_id_example' # str | The id of the conversation
page_size = 25 # int | The page size for the listing. The max that will be returned is 50. (optional) (default to 25)
page_number = 1 # int | The page number for the listing (optional) (default to 1)
try:
# Get the list of detected Speech and Text Analytics categories of conversation
api_response = api_instance.get_speechandtextanalytics_conversation_categories(conversation_id, page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation_categories: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturl Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
conversation_id = 'conversation_id_example' # str | Conversation ID
communication_id = 'communication_id_example' # str | Communication ID
try:
# Get the pre-signed S3 URL for the transcript of a specific communication of a conversation
api_response = api_instance.get_speechandtextanalytics_conversation_communication_transcripturl(conversation_id, communication_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation_communication_transcripturl: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
conversation_id = 'conversation_id_example' # str | Conversation ID
communication_id = 'communication_id_example' # str | Communication ID
try:
# Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation
api_response = api_instance.get_speechandtextanalytics_conversation_communication_transcripturls(conversation_id, communication_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_conversation_communication_transcripturls: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/dictionaryfeedback Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of Speech & Text Analytics dictionary feedbacks
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
dialect = 'en-US' # str | The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard (optional)
next_page = 'next_page_example' # str | The key for listing the next page (optional)
page_size = 500 # int | The page size for the listing (optional) (default to 500)
try:
# Get the list of Speech & Text Analytics dictionary feedbacks
api_response = api_instance.get_speechandtextanalytics_dictionaryfeedback(dialect=dialect, next_page=next_page, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_dictionaryfeedback: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/speechandtextanalytics/dictionaryfeedback Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a Speech & Text Analytics DictionaryFeedback
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.DictionaryFeedback() # DictionaryFeedback | The DictionaryFeedback to create
try:
# Create a Speech & Text Analytics DictionaryFeedback
api_response = api_instance.post_speechandtextanalytics_dictionaryfeedback(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_dictionaryfeedback: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a Speech & Text Analytics DictionaryFeedback by Id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
dictionary_feedback_id = 'dictionary_feedback_id_example' # str | The Id of the Dictionary Feedback
try:
# Delete a Speech & Text Analytics DictionaryFeedback by Id
api_instance.delete_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id(dictionary_feedback_id)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Speech & Text Analytics dictionary feedback by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
dictionary_feedback_id = 'dictionary_feedback_id_example' # str | The Id of the Dictionary Feedback
try:
# Get a Speech & Text Analytics dictionary feedback by id
api_response = api_instance.get_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id(dictionary_feedback_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/dictionaryfeedback/{dictionaryFeedbackId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update existing Speech & Text Analytics dictionary feedback by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
dictionary_feedback_id = 'dictionary_feedback_id_example' # str | The Id of the Dictionary Feedback
body = PureCloudPlatformClientV2.DictionaryFeedback() # DictionaryFeedback | (optional)
try:
# Update existing Speech & Text Analytics dictionary feedback by id
api_response = api_instance.put_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id(dictionary_feedback_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_dictionaryfeedback_dictionary_feedback_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of Speech & Text Analytics programs
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
next_page = 'next_page_example' # str | The key for listing the next page (optional)
page_size = 20 # int | The page size for the listing (optional) (default to 20)
state = 'state_example' # str | Program state. Defaults to Latest (optional)
try:
# Get the list of Speech & Text Analytics programs
api_response = api_instance.get_speechandtextanalytics_programs(next_page=next_page, page_size=page_size, state=state)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/speechandtextanalytics/programs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create new Speech & Text Analytics program
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.ProgramRequest() # ProgramRequest | The program to create
try:
# Create new Speech & Text Analytics program
api_response = api_instance.post_speechandtextanalytics_programs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_programs: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/speechandtextanalytics/programs/general/jobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create new Speech & Text Analytics general program job
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.GeneralProgramJobRequest() # GeneralProgramJobRequest | The general programs job to create
try:
# Create new Speech & Text Analytics general program job
api_response = api_instance.post_speechandtextanalytics_programs_general_jobs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_programs_general_jobs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/general/jobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Speech & Text Analytics general program job by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
job_id = 'job_id_example' # str | The id of the publish programs job
try:
# Get a Speech & Text Analytics general program job by id
api_response = api_instance.get_speechandtextanalytics_programs_general_job(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs_general_job: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/mappings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of Speech & Text Analytics programs mappings to queues and flows
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
next_page = 'next_page_example' # str | The key for listing the next page (optional)
page_size = 20 # int | The page size for the listing (optional) (default to 20)
try:
# Get the list of Speech & Text Analytics programs mappings to queues and flows
api_response = api_instance.get_speechandtextanalytics_programs_mappings(next_page=next_page, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs_mappings: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/speechandtextanalytics/programs/publishjobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create new Speech & Text Analytics publish programs job
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.ProgramJobRequest() # ProgramJobRequest | The publish programs job to create
try:
# Create new Speech & Text Analytics publish programs job
api_response = api_instance.post_speechandtextanalytics_programs_publishjobs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_programs_publishjobs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/publishjobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Speech & Text Analytics publish programs job by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
job_id = 'job_id_example' # str | The id of the publish programs job
try:
# Get a Speech & Text Analytics publish programs job by id
api_response = api_instance.get_speechandtextanalytics_programs_publishjob(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs_publishjob: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/transcriptionengines/dialects Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get supported dialects for each transcription engine
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
try:
# Get supported dialects for each transcription engine
api_response = api_instance.get_speechandtextanalytics_programs_transcriptionengines_dialects()
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs_transcriptionengines_dialects: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/unpublished Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of Speech & Text Analytics unpublished programs
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
next_page = 'next_page_example' # str | The key for listing the next page (optional)
page_size = 20 # int | The page size for the listing (optional) (default to 20)
try:
# Get the list of Speech & Text Analytics unpublished programs
api_response = api_instance.get_speechandtextanalytics_programs_unpublished(next_page=next_page, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_programs_unpublished: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/programs/{programId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a Speech & Text Analytics program by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
program_id = 'program_id_example' # str | The id of the program
force_delete = False # bool | Indicates whether the program is forced to be deleted or not. Required when the program to delete is the default program. (optional) (default to False)
try:
# Delete a Speech & Text Analytics program by id
api_response = api_instance.delete_speechandtextanalytics_program(program_id, force_delete=force_delete)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_program: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/{programId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Speech & Text Analytics program by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
program_id = 'program_id_example' # str | The id of the program
try:
# Get a Speech & Text Analytics program by id
api_response = api_instance.get_speechandtextanalytics_program(program_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_program: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/programs/{programId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update existing Speech & Text Analytics program
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
program_id = 'program_id_example' # str | The id of the program
body = PureCloudPlatformClientV2.ProgramRequest() # ProgramRequest | The program to update
try:
# Update existing Speech & Text Analytics program
api_response = api_instance.put_speechandtextanalytics_program(program_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_program: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/{programId}/mappings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Speech & Text Analytics program mappings to queues and flows by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
program_id = 'program_id_example' # str | The id of the program
try:
# Get Speech & Text Analytics program mappings to queues and flows by id
api_response = api_instance.get_speechandtextanalytics_program_mappings(program_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_program_mappings: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/programs/{programId}/mappings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Set Speech & Text Analytics program mappings to queues and flows
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
program_id = 'program_id_example' # str | The id of the program
body = PureCloudPlatformClientV2.ProgramMappingsRequest() # ProgramMappingsRequest | The program to set mappings for
try:
# Set Speech & Text Analytics program mappings to queues and flows
api_response = api_instance.put_speechandtextanalytics_program_mappings(program_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_program_mappings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get transcription engine settings of a program
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
program_id = 'program_id_example' # str | The id of the program
try:
# Get transcription engine settings of a program
api_response = api_instance.get_speechandtextanalytics_program_transcriptionengines(program_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_program_transcriptionengines: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/programs/{programId}/transcriptionengines Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update transcription engine settings of a program
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
program_id = 'program_id_example' # str | The id of the program
body = PureCloudPlatformClientV2.TranscriptionEnginesRequest() # TranscriptionEnginesRequest | Program transcription engine setting
try:
# Update transcription engine settings of a program
api_response = api_instance.put_speechandtextanalytics_program_transcriptionengines(program_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_program_transcriptionengines: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/sentiment/dialects Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of Speech & Text Analytics sentiment supported dialects
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
try:
# Get the list of Speech & Text Analytics sentiment supported dialects
api_response = api_instance.get_speechandtextanalytics_sentiment_dialects()
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_sentiment_dialects: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/sentimentfeedback Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete All Speech & Text Analytics SentimentFeedback
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
try:
# Delete All Speech & Text Analytics SentimentFeedback
api_instance.delete_speechandtextanalytics_sentimentfeedback()
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_sentimentfeedback: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/sentimentfeedback Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of Speech & Text Analytics SentimentFeedback
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
dialect = 'en-US' # str | The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard (optional)
try:
# Get the list of Speech & Text Analytics SentimentFeedback
api_response = api_instance.get_speechandtextanalytics_sentimentfeedback(dialect=dialect)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_sentimentfeedback: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/speechandtextanalytics/sentimentfeedback Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a Speech & Text Analytics SentimentFeedback
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.SentimentFeedback() # SentimentFeedback | The SentimentFeedback to create
try:
# Create a Speech & Text Analytics SentimentFeedback
api_response = api_instance.post_speechandtextanalytics_sentimentfeedback(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_sentimentfeedback: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/sentimentfeedback/{sentimentFeedbackId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a Speech & Text Analytics SentimentFeedback by Id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
sentiment_feedback_id = 'sentiment_feedback_id_example' # str | The Id of the SentimentFeedback
try:
# Delete a Speech & Text Analytics SentimentFeedback by Id
api_instance.delete_speechandtextanalytics_sentimentfeedback_sentiment_feedback_id(sentiment_feedback_id)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_sentimentfeedback_sentiment_feedback_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Speech And Text Analytics Settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
try:
# Get Speech And Text Analytics Settings
api_response = api_instance.get_speechandtextanalytics_settings()
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_settings: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/speechandtextanalytics/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Patch Speech And Text Analytics Settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.SpeechTextAnalyticsSettingsRequest() # SpeechTextAnalyticsSettingsRequest | Speech And Text Analytics Settings
try:
# Patch Speech And Text Analytics Settings
api_response = api_instance.patch_speechandtextanalytics_settings(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->patch_speechandtextanalytics_settings: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update Speech And Text Analytics Settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.SpeechTextAnalyticsSettingsRequest() # SpeechTextAnalyticsSettingsRequest | Speech And Text Analytics Settings
try:
# Update Speech And Text Analytics Settings
api_response = api_instance.put_speechandtextanalytics_settings(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_settings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of Speech & Text Analytics topics
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
next_page = 'next_page_example' # str | The key for listing the next page (optional)
page_size = 20 # int | The page size for the listing. The max that will be returned is 500. (optional) (default to 20)
state = 'state_example' # str | Topic state. Defaults to latest (optional)
name = 'name_example' # str | Case insensitive partial name to filter by (optional)
ids = ['ids_example'] # list[str] | Comma separated Topic IDs to filter by. Cannot be used with other filters. Maximum of 50 IDs allowed. (optional)
dialects = ['dialects_example'] # list[str] | Comma separated dialect strings to filter by. Maximum of 15 dialects allowed. (optional)
sort_by = 'sort_by_example' # str | Sort results by. Defaults to name (optional)
sort_order = 'sort_order_example' # str | Sort order. Defaults to asc (optional)
try:
# Get the list of Speech & Text Analytics topics
api_response = api_instance.get_speechandtextanalytics_topics(next_page=next_page, page_size=page_size, state=state, name=name, ids=ids, dialects=dialects, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topics: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/speechandtextanalytics/topics Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create new Speech & Text Analytics topic
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.TopicRequest() # TopicRequest | The topic to create
try:
# Create new Speech & Text Analytics topic
api_response = api_instance.post_speechandtextanalytics_topics(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_topics: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics/dialects Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get list of supported Speech & Text Analytics topics dialects
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
try:
# Get list of supported Speech & Text Analytics topics dialects
api_response = api_instance.get_speechandtextanalytics_topics_dialects()
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topics_dialects: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics/general Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the Speech & Text Analytics general topics for a given dialect
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
dialect = 'dialect_example' # str | The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard (optional)
try:
# Get the Speech & Text Analytics general topics for a given dialect
api_response = api_instance.get_speechandtextanalytics_topics_general(dialect=dialect)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topics_general: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics/general/status Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of general topics from the org and the system with their current status
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
dialect = 'dialect_example' # str | The dialect of the general topics, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard (optional)
try:
# Get the list of general topics from the org and the system with their current status
api_response = api_instance.get_speechandtextanalytics_topics_general_status(dialect=dialect)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topics_general_status: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/speechandtextanalytics/topics/publishjobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create new Speech & Text Analytics publish topics job
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.TopicJobRequest() # TopicJobRequest | The publish topics job to create
try:
# Create new Speech & Text Analytics publish topics job
api_response = api_instance.post_speechandtextanalytics_topics_publishjobs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_topics_publishjobs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics/publishjobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Speech & Text Analytics publish topics job by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
job_id = 'job_id_example' # str | The id of the publish topics job
try:
# Get a Speech & Text Analytics publish topics job by id
api_response = api_instance.get_speechandtextanalytics_topics_publishjob(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topics_publishjob: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/speechandtextanalytics/topics/{topicId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a Speech & Text Analytics topic by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
topic_id = 'topic_id_example' # str | The id of the topic
try:
# Delete a Speech & Text Analytics topic by id
api_instance.delete_speechandtextanalytics_topic(topic_id)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->delete_speechandtextanalytics_topic: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/speechandtextanalytics/topics/{topicId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Speech & Text Analytics topic by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
topic_id = 'topic_id_example' # str | The id of the topic
try:
# Get a Speech & Text Analytics topic by id
api_response = api_instance.get_speechandtextanalytics_topic(topic_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->get_speechandtextanalytics_topic: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/speechandtextanalytics/topics/{topicId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update existing Speech & Text Analytics topic
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
topic_id = 'topic_id_example' # str | The id of the topic
body = PureCloudPlatformClientV2.TopicRequest() # TopicRequest | The topic to update
try:
# Update existing Speech & Text Analytics topic
api_response = api_instance.put_speechandtextanalytics_topic(topic_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->put_speechandtextanalytics_topic: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/speechandtextanalytics/transcripts/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search resources.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SpeechTextAnalyticsApi();
body = PureCloudPlatformClientV2.TranscriptSearchRequest() # TranscriptSearchRequest | Search request options
try:
# Search resources.
api_response = api_instance.post_speechandtextanalytics_transcripts_search(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SpeechTextAnalyticsApi->post_speechandtextanalytics_transcripts_search: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/stations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of available stations.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.StationsApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
sort_by = ''name'' # str | Sort by (optional) (default to 'name')
name = 'name_example' # str | Name (optional)
user_selectable = 'user_selectable_example' # str | True for stations that the user can select otherwise false (optional)
web_rtc_user_id = 'web_rtc_user_id_example' # str | Filter for the webRtc station of the webRtcUserId (optional)
id = 'id_example' # str | Comma separated list of stationIds (optional)
line_appearance_id = 'line_appearance_id_example' # str | lineAppearanceId (optional)
try:
# Get the list of available stations.
api_response = api_instance.get_stations(page_size=page_size, page_number=page_number, sort_by=sort_by, name=name, user_selectable=user_selectable, web_rtc_user_id=web_rtc_user_id, id=id, line_appearance_id=line_appearance_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling StationsApi->get_stations: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/stations/{stationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get station.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.StationsApi();
station_id = 'station_id_example' # str | Station ID
try:
# Get station.
api_response = api_instance.get_station(station_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling StationsApi->get_station: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/stations/{stationId}/associateduser Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Unassigns the user assigned to this station
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.StationsApi();
station_id = 'station_id_example' # str | Station ID
try:
# Unassigns the user assigned to this station
api_instance.delete_station_associateduser(station_id)
except ApiException as e:
print("Exception when calling StationsApi->delete_station_associateduser: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search using the q64 value returned from a previous search.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SuggestApi();
q64 = 'q64_example' # str | q64
expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional)
profile = True # bool | profile (optional) (default to True)
try:
# Search using the q64 value returned from a previous search.
api_response = api_instance.get_search(q64, expand=expand, profile=profile)
pprint(api_response)
except ApiException as e:
print("Exception when calling SuggestApi->get_search: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search resources.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SuggestApi();
body = PureCloudPlatformClientV2.SearchRequest() # SearchRequest | Search request options
profile = True # bool | profile (optional) (default to True)
try:
# Search resources.
api_response = api_instance.post_search(body, profile=profile)
pprint(api_response)
except ApiException as e:
print("Exception when calling SuggestApi->post_search: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/search/suggest Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Suggest resources using the q64 value returned from a previous suggest query.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SuggestApi();
q64 = 'q64_example' # str | q64
expand = ['expand_example'] # list[str] | Which fields, if any, to expand (optional)
profile = True # bool | profile (optional) (default to True)
try:
# Suggest resources using the q64 value returned from a previous suggest query.
api_response = api_instance.get_search_suggest(q64, expand=expand, profile=profile)
pprint(api_response)
except ApiException as e:
print("Exception when calling SuggestApi->get_search_suggest: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/search/suggest Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Suggest resources.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SuggestApi();
body = PureCloudPlatformClientV2.SuggestSearchRequest() # SuggestSearchRequest | Search request options
profile = True # bool | profile (optional) (default to True)
try:
# Suggest resources.
api_response = api_instance.post_search_suggest(body, profile=profile)
pprint(api_response)
except ApiException as e:
print("Exception when calling SuggestApi->post_search_suggest: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/taskmanagement/workbins Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a workbin
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
body = PureCloudPlatformClientV2.WorkbinCreate() # WorkbinCreate | Workbin
try:
# Create a workbin
api_response = api_instance.post_taskmanagement_workbins(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->post_taskmanagement_workbins: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/taskmanagement/workbins/query Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query for workbins
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
body = PureCloudPlatformClientV2.WorkbinQueryRequest() # WorkbinQueryRequest | QueryPostRequest
try:
# Query for workbins
api_response = api_instance.post_taskmanagement_workbins_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->post_taskmanagement_workbins_query: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/taskmanagement/workbins/{workbinId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a workbin
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
workbin_id = 'workbin_id_example' # str | Workbin ID
try:
# Delete a workbin
api_instance.delete_taskmanagement_workbin(workbin_id)
except ApiException as e:
print("Exception when calling TaskManagementApi->delete_taskmanagement_workbin: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/taskmanagement/workbins/{workbinId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a workbin
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
workbin_id = 'workbin_id_example' # str | Workbin ID
try:
# Get a workbin
api_response = api_instance.get_taskmanagement_workbin(workbin_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->get_taskmanagement_workbin: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/taskmanagement/workbins/{workbinId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update the attributes of a workbin
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
workbin_id = 'workbin_id_example' # str | Workbin ID
body = PureCloudPlatformClientV2.WorkbinUpdate() # WorkbinUpdate | Json with attributes and their new values: {\"description\":\"new description\", \"name\":\"new name\"}.
try:
# Update the attributes of a workbin
api_response = api_instance.patch_taskmanagement_workbin(workbin_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->patch_taskmanagement_workbin: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/taskmanagement/workitems Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a workitem
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
body = PureCloudPlatformClientV2.WorkitemCreate() # WorkitemCreate | Workitem
try:
# Create a workitem
api_response = api_instance.post_taskmanagement_workitems(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->post_taskmanagement_workitems: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/taskmanagement/workitems/query/jobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a workitem query job
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
body = PureCloudPlatformClientV2.WorkitemQueryJobCreate() # WorkitemQueryJobCreate | WorkitemQueryJobCreate
try:
# Create a workitem query job
api_response = api_instance.post_taskmanagement_workitems_query_jobs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->post_taskmanagement_workitems_query_jobs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/query/jobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the workitem query job associated with the job id.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
job_id = 'job_id_example' # str | jobId
try:
# Get the workitem query job associated with the job id.
api_response = api_instance.get_taskmanagement_workitems_query_job(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->get_taskmanagement_workitems_query_job: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/query/jobs/{jobId}/results Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get results from for workitem query job
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
job_id = 'job_id_example' # str | jobId
try:
# Get results from for workitem query job
api_response = api_instance.get_taskmanagement_workitems_query_job_results(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->get_taskmanagement_workitems_query_job_results: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/schemas Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of schemas.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
try:
# Get a list of schemas.
api_response = api_instance.get_taskmanagement_workitems_schemas()
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->get_taskmanagement_workitems_schemas: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/taskmanagement/workitems/schemas Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a schema
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
body = PureCloudPlatformClientV2.DataSchema() # DataSchema | Schema
try:
# Create a schema
api_response = api_instance.post_taskmanagement_workitems_schemas(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->post_taskmanagement_workitems_schemas: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/taskmanagement/workitems/schemas/{schemaId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a schema
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
schema_id = 'schema_id_example' # str | Schema ID
try:
# Delete a schema
api_instance.delete_taskmanagement_workitems_schema(schema_id)
except ApiException as e:
print("Exception when calling TaskManagementApi->delete_taskmanagement_workitems_schema: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/schemas/{schemaId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a schema
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
schema_id = 'schema_id_example' # str | Schema ID
try:
# Get a schema
api_response = api_instance.get_taskmanagement_workitems_schema(schema_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->get_taskmanagement_workitems_schema: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/taskmanagement/workitems/schemas/{schemaId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a schema
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
schema_id = 'schema_id_example' # str | Schema ID
body = PureCloudPlatformClientV2.DataSchema() # DataSchema | Data Schema
try:
# Update a schema
api_response = api_instance.put_taskmanagement_workitems_schema(schema_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->put_taskmanagement_workitems_schema: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/schemas/{schemaId}/versions Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get all versions of a schema
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
schema_id = 'schema_id_example' # str | Schema ID
try:
# Get all versions of a schema
api_response = api_instance.get_taskmanagement_workitems_schema_versions(schema_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->get_taskmanagement_workitems_schema_versions: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/schemas/{schemaId}/versions/{versionId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a specific version of a schema
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
schema_id = 'schema_id_example' # str | Schema ID
version_id = 'version_id_example' # str | Schema version
try:
# Get a specific version of a schema
api_response = api_instance.get_taskmanagement_workitems_schema_version(schema_id, version_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->get_taskmanagement_workitems_schema_version: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/taskmanagement/workitems/{workitemId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a workitem
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
workitem_id = 'workitem_id_example' # str | Workitem ID
try:
# Delete a workitem
api_instance.delete_taskmanagement_workitem(workitem_id)
except ApiException as e:
print("Exception when calling TaskManagementApi->delete_taskmanagement_workitem: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/taskmanagement/workitems/{workitemId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a workitem
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
workitem_id = 'workitem_id_example' # str | Workitem ID
expands = 'expands_example' # str | Which fields to expand. Comma separated if more than one. (optional)
try:
# Get a workitem
api_response = api_instance.get_taskmanagement_workitem(workitem_id, expands=expands)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->get_taskmanagement_workitem: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/taskmanagement/workitems/{workitemId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update the attributes of a workitem
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
workitem_id = 'workitem_id_example' # str | Workitem ID
body = PureCloudPlatformClientV2.WorkitemUpdate() # WorkitemUpdate | Workitem
try:
# Update the attributes of a workitem
api_response = api_instance.patch_taskmanagement_workitem(workitem_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->patch_taskmanagement_workitem: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/taskmanagement/workitems/{workitemId}/acd/cancel Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
workitem_id = 'workitem_id_example' # str | Workitem ID
try:
# Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
api_response = api_instance.post_taskmanagement_workitem_acd_cancel(workitem_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->post_taskmanagement_workitem_acd_cancel: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/taskmanagement/workitems/{workitemId}/assignment Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
workitem_id = 'workitem_id_example' # str | Workitem ID
body = PureCloudPlatformClientV2.WorkitemManualAssign() # WorkitemManualAssign | Targeted user
try:
# Attempts to manually assign a specified workitem to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
api_instance.patch_taskmanagement_workitem_assignment(workitem_id, body)
except ApiException as e:
print("Exception when calling TaskManagementApi->patch_taskmanagement_workitem_assignment: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/taskmanagement/workitems/{workitemId}/disconnect Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Disconnect the assignee of the workitem
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
workitem_id = 'workitem_id_example' # str | Workitem ID
try:
# Disconnect the assignee of the workitem
api_response = api_instance.post_taskmanagement_workitem_disconnect(workitem_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->post_taskmanagement_workitem_disconnect: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/taskmanagement/workitems/{workitemId}/terminate Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Terminate a workitem
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.TaskManagementApi();
workitem_id = 'workitem_id_example' # str | Workitem ID
body = PureCloudPlatformClientV2.WorkitemTerminate() # WorkitemTerminate | Terminated request (optional)
try:
# Terminate a workitem
api_response = api_instance.post_taskmanagement_workitem_terminate(workitem_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling TaskManagementApi->post_taskmanagement_workitem_terminate: %s\n" % e)```
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.