instruction
stringlengths 81
221
| input
stringlengths 50
1.19k
| output
stringlengths 525
3.61k
|
|---|---|---|
Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/instagram Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of Instagram Integrations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
expand = 'expand_example' # str | Expand instructions for the return value. (optional)
supported_content_id = 'supported_content_id_example' # str | Filter integrations returned based on the supported content ID (optional)
messaging_setting_id = 'messaging_setting_id_example' # str | Filter integrations returned based on the setting ID (optional)
try:
# Get a list of Instagram Integrations
api_response = api_instance.get_conversations_messaging_integrations_instagram(page_size=page_size, page_number=page_number, expand=expand, supported_content_id=supported_content_id, messaging_setting_id=messaging_setting_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_integrations_instagram: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/messaging/integrations/instagram Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create Instagram Integration
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.InstagramIntegrationRequest() # InstagramIntegrationRequest | InstagramIntegrationRequest
try:
# Create Instagram Integration
api_response = api_instance.post_conversations_messaging_integrations_instagram(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_messaging_integrations_instagram: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/conversations/messaging/integrations/instagram/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete Instagram messaging integration
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
integration_id = 'integration_id_example' # str | Integration ID
try:
# Delete Instagram messaging integration
api_instance.delete_conversations_messaging_integrations_instagram_integration_id(integration_id)
except ApiException as e:
print("Exception when calling ConversationsApi->delete_conversations_messaging_integrations_instagram_integration_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/instagram/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Instagram messaging integration
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
integration_id = 'integration_id_example' # str | Integration ID
expand = 'expand_example' # str | Expand instructions for the return value. (optional)
try:
# Get Instagram messaging integration
api_response = api_instance.get_conversations_messaging_integrations_instagram_integration_id(integration_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_integrations_instagram_integration_id: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/messaging/integrations/instagram/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update Instagram messaging integration
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
integration_id = 'integration_id_example' # str | Integration ID
body = PureCloudPlatformClientV2.InstagramIntegrationUpdateRequest() # InstagramIntegrationUpdateRequest | InstagramIntegrationUpdateRequest
try:
# Update Instagram messaging integration
api_response = api_instance.patch_conversations_messaging_integrations_instagram_integration_id(integration_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_messaging_integrations_instagram_integration_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/open Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of Open messaging integrations. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
expand = 'expand_example' # str | Expand instructions for the return value. (optional)
supported_content_id = 'supported_content_id_example' # str | Filter integrations returned based on the supported content ID (optional)
messaging_setting_id = 'messaging_setting_id_example' # str | Filter integrations returned based on the setting ID (optional)
try:
# Get a list of Open messaging integrations
api_response = api_instance.get_conversations_messaging_integrations_open(page_size=page_size, page_number=page_number, expand=expand, supported_content_id=supported_content_id, messaging_setting_id=messaging_setting_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_integrations_open: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/messaging/integrations/open Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.OpenIntegrationRequest() # OpenIntegrationRequest | OpenIntegrationRequest
try:
# Create an Open messaging integration
api_response = api_instance.post_conversations_messaging_integrations_open(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_messaging_integrations_open: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/conversations/messaging/integrations/open/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
integration_id = 'integration_id_example' # str | Integration ID
try:
# Delete an Open messaging integration
api_instance.delete_conversations_messaging_integrations_open_integration_id(integration_id)
except ApiException as e:
print("Exception when calling ConversationsApi->delete_conversations_messaging_integrations_open_integration_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/open/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
integration_id = 'integration_id_example' # str | Integration ID
expand = 'expand_example' # str | Expand instructions for the return value. (optional)
try:
# Get an Open messaging integration
api_response = api_instance.get_conversations_messaging_integrations_open_integration_id(integration_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_integrations_open_integration_id: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/messaging/integrations/open/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update an Open messaging integration. See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
integration_id = 'integration_id_example' # str | Integration ID
body = PureCloudPlatformClientV2.OpenIntegrationUpdateRequest() # OpenIntegrationUpdateRequest | OpenIntegrationUpdateRequest
try:
# Update an Open messaging integration
api_response = api_instance.patch_conversations_messaging_integrations_open_integration_id(integration_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_messaging_integrations_open_integration_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/whatsapp Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of WhatsApp Integrations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
expand = 'expand_example' # str | Expand instructions for the return value. (optional)
supported_content_id = 'supported_content_id_example' # str | Filter integrations returned based on the supported content ID (optional)
messaging_setting_id = 'messaging_setting_id_example' # str | Filter integrations returned based on the setting ID (optional)
try:
# Get a list of WhatsApp Integrations
api_response = api_instance.get_conversations_messaging_integrations_whatsapp(page_size=page_size, page_number=page_number, expand=expand, supported_content_id=supported_content_id, messaging_setting_id=messaging_setting_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_integrations_whatsapp: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a WhatsApp Integration using the WhatsApp embedded signup flow. Use the access token returned from the embedded signup flow to obtain a list of available phone numbers that can be associated with the created integration. The returned WhatsApp integration will initially have a createStatus of Initiated until the list of available phone numbers can be obtained from the provider. Please run a GET on the created integration until it returns a createStatus of Completed, and the list of available phone numbers obtained from the provider. You can then specify one of the available phone numbers in the PATCH call on the integration to activate it.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.WhatsAppEmbeddedSignupIntegrationRequest() # WhatsAppEmbeddedSignupIntegrationRequest | WhatsAppEmbeddedSignupIntegrationRequest
try:
# Create a WhatsApp Integration using the WhatsApp embedded signup flow
api_response = api_instance.post_conversations_messaging_integrations_whatsapp_embeddedsignup(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_messaging_integrations_whatsapp_embeddedsignup: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/messaging/integrations/whatsapp/embeddedsignup/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow. Please specify the phone number to associate with this WhatsApp integration from the list of available phone numbers returned to you in the POST call to create the integration. You can then run a GET on the integration to check if its status has been updated to Active
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
integration_id = 'integration_id_example' # str | Integration ID
body = PureCloudPlatformClientV2.WhatsAppEmbeddedSignupIntegrationActivationRequest() # WhatsAppEmbeddedSignupIntegrationActivationRequest | WhatsAppEmbeddedSignupIntegrationActivationRequest
try:
# Activate a WhatsApp messaging integration created using the WhatsApp embedded signup flow
api_response = api_instance.patch_conversations_messaging_integrations_whatsapp_embeddedsignup_integration_id(integration_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_messaging_integrations_whatsapp_embeddedsignup_integration_id: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/conversations/messaging/integrations/whatsapp/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a WhatsApp messaging integration
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
integration_id = 'integration_id_example' # str | Integration ID
try:
# Delete a WhatsApp messaging integration
api_response = api_instance.delete_conversations_messaging_integrations_whatsapp_integration_id(integration_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->delete_conversations_messaging_integrations_whatsapp_integration_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/integrations/whatsapp/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a WhatsApp messaging integration
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
integration_id = 'integration_id_example' # str | Integration ID
expand = 'expand_example' # str | Expand instructions for the return value. (optional)
try:
# Get a WhatsApp messaging integration
api_response = api_instance.get_conversations_messaging_integrations_whatsapp_integration_id(integration_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_integrations_whatsapp_integration_id: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/messaging/integrations/whatsapp/{integrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a WhatsApp messaging integration
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
integration_id = 'integration_id_example' # str | Integration ID
body = PureCloudPlatformClientV2.WhatsAppIntegrationUpdateRequest() # WhatsAppIntegrationUpdateRequest | WhatsAppIntegrationUpdateRequest
try:
# Update a WhatsApp messaging integration
api_response = api_instance.patch_conversations_messaging_integrations_whatsapp_integration_id(integration_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_messaging_integrations_whatsapp_integration_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of messaging settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
try:
# Get a list of messaging settings
api_response = api_instance.get_conversations_messaging_settings(page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_settings: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/messaging/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a messaging setting
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.MessagingSettingRequest() # MessagingSettingRequest | MessagingSetting
try:
# Create a messaging setting
api_response = api_instance.post_conversations_messaging_settings(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_messaging_settings: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/conversations/messaging/settings/default Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete the organization's default setting, a global default will be applied to integrations without settings. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
try:
# Delete the organization's default setting, a global default will be applied to integrations without settings
api_instance.delete_conversations_messaging_settings_default()
except ApiException as e:
print("Exception when calling ConversationsApi->delete_conversations_messaging_settings_default: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/settings/default Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the organization's default settings that will be used as the default when creating an integration. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
try:
# Get the organization's default settings that will be used as the default when creating an integration.
api_response = api_instance.get_conversations_messaging_settings_default()
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_settings_default: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/conversations/messaging/settings/default Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Set the organization's default setting that may be applied to to integrations without settings. When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.MessagingSettingDefaultRequest() # MessagingSettingDefaultRequest | MessagingSetting
try:
# Set the organization's default setting that may be applied to to integrations without settings
api_response = api_instance.put_conversations_messaging_settings_default(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->put_conversations_messaging_settings_default: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/conversations/messaging/settings/{messageSettingId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a messaging setting
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
message_setting_id = 'message_setting_id_example' # str | Message Setting ID
try:
# Delete a messaging setting
api_instance.delete_conversations_messaging_setting(message_setting_id)
except ApiException as e:
print("Exception when calling ConversationsApi->delete_conversations_messaging_setting: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/settings/{messageSettingId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a messaging setting
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
message_setting_id = 'message_setting_id_example' # str | Message Setting ID
try:
# Get a messaging setting
api_response = api_instance.get_conversations_messaging_setting(message_setting_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_setting: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/messaging/settings/{messageSettingId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a messaging setting
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
message_setting_id = 'message_setting_id_example' # str | Message Setting ID
body = PureCloudPlatformClientV2.MessagingSettingPatchRequest() # MessagingSettingPatchRequest | MessagingSetting
try:
# Update a messaging setting
api_response = api_instance.patch_conversations_messaging_setting(message_setting_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_messaging_setting: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/supportedcontent Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of Supported Content profiles
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
try:
# Get a list of Supported Content profiles
api_response = api_instance.get_conversations_messaging_supportedcontent(page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_supportedcontent: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/messaging/supportedcontent Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a Supported Content profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.SupportedContent() # SupportedContent | SupportedContent
try:
# Create a Supported Content profile
api_response = api_instance.post_conversations_messaging_supportedcontent(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_messaging_supportedcontent: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/supportedcontent/default Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the organization's default supported content profile that will be used as the default when creating an integration. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
try:
# Get the organization's default supported content profile that will be used as the default when creating an integration.
api_response = api_instance.get_conversations_messaging_supportedcontent_default()
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_supportedcontent_default: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/conversations/messaging/supportedcontent/default Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Set the organization's default supported content profile that may be assigned to an integration when it is created. When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.SupportedContentReference() # SupportedContentReference | SupportedContent
try:
# Set the organization's default supported content profile that may be assigned to an integration when it is created.
api_response = api_instance.put_conversations_messaging_supportedcontent_default(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->put_conversations_messaging_supportedcontent_default: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a supported content profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
supported_content_id = 'supported_content_id_example' # str | Supported Content ID
try:
# Delete a supported content profile
api_instance.delete_conversations_messaging_supportedcontent_supported_content_id(supported_content_id)
except ApiException as e:
print("Exception when calling ConversationsApi->delete_conversations_messaging_supportedcontent_supported_content_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a supported content profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
supported_content_id = 'supported_content_id_example' # str | Supported Content ID
try:
# Get a supported content profile
api_response = api_instance.get_conversations_messaging_supportedcontent_supported_content_id(supported_content_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_supportedcontent_supported_content_id: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a supported content profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
supported_content_id = 'supported_content_id_example' # str | Supported Content ID
body = PureCloudPlatformClientV2.SupportedContent() # SupportedContent | SupportedContent
try:
# Update a supported content profile
api_response = api_instance.patch_conversations_messaging_supportedcontent_supported_content_id(supported_content_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_messaging_supportedcontent_supported_content_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/messaging/threadingtimeline Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get conversation threading window timeline for each messaging type. Conversation messaging threading timeline is a setting defined for each messenger type in your organization. This setting will dictate whether a new message is added to the most recent existing conversation, or creates a new Conversation. If the existing Conversation is still in a connected state the threading timeline setting will never play a role. After the conversation is disconnected, if an inbound message is received or an outbound message is sent after the setting for threading timeline expires, a new conversation is created.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
try:
# Get conversation threading window timeline for each messaging type
api_response = api_instance.get_conversations_messaging_threadingtimeline()
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_messaging_threadingtimeline: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/conversations/messaging/threadingtimeline Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update conversation threading window timeline for each messaging type. PUT Conversation messaging threading timeline is intended to set the conversation threading settings for ALL messengerTypes. If you omit a messengerType in the request body then the setting for that messengerType will use the platform default value. The PUT replaces the existing setting(s) that were previously set for each messengerType.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.ConversationThreadingWindow() # ConversationThreadingWindow | ConversationThreadingWindowRequest
try:
# Update conversation threading window timeline for each messaging type
api_response = api_instance.put_conversations_messaging_threadingtimeline(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->put_conversations_messaging_threadingtimeline: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/participants/attributes/search Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Search conversations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SearchApi();
body = PureCloudPlatformClientV2.ConversationParticipantSearchRequest() # ConversationParticipantSearchRequest | Search request options
try:
# Search conversations
api_response = api_instance.post_conversations_participants_attributes_search(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SearchApi->post_conversations_participants_attributes_search: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
try:
# Get Settings
api_response = api_instance.get_conversations_settings()
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_settings: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update Settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.Settings() # Settings | Settings
try:
# Update Settings
api_instance.patch_conversations_settings(body)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_settings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the wrap-up for this conversation communication.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
communication_id = 'communication_id_example' # str | communicationId
provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False)
try:
# Get the wrap-up for this conversation communication.
api_response = api_instance.get_conversations_social_participant_communication_wrapup(conversation_id, participant_id, communication_id, provisional=provisional)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_social_participant_communication_wrapup: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/socials/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Apply wrap-up for this conversation communication
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
communication_id = 'communication_id_example' # str | communicationId
body = PureCloudPlatformClientV2.WrapupInput() # WrapupInput | Wrap-up (optional)
try:
# Apply wrap-up for this conversation communication
api_instance.post_conversations_social_participant_communication_wrapup(conversation_id, participant_id, communication_id, body=body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_social_participant_communication_wrapup: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/conversations/socials/{conversationId}/recordingstate Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a conversation by setting its recording state
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState
try:
# Update a conversation by setting its recording state
api_response = api_instance.put_conversations_social_recordingstate(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->put_conversations_social_recordingstate: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the wrap-up for this conversation communication.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
communication_id = 'communication_id_example' # str | communicationId
provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False)
try:
# Get the wrap-up for this conversation communication.
api_response = api_instance.get_conversations_video_participant_communication_wrapup(conversation_id, participant_id, communication_id, provisional=provisional)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_video_participant_communication_wrapup: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/videos/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Apply wrap-up for this conversation communication
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
communication_id = 'communication_id_example' # str | communicationId
body = PureCloudPlatformClientV2.WrapupInput() # WrapupInput | Wrap-up (optional)
try:
# Apply wrap-up for this conversation communication
api_instance.post_conversations_video_participant_communication_wrapup(conversation_id, participant_id, communication_id, body=body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_video_participant_communication_wrapup: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/conversations/videos/{conversationId}/recordingstate Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a conversation by setting its recording state
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState
try:
# Update a conversation by setting its recording state
api_response = api_instance.put_conversations_video_recordingstate(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->put_conversations_video_recordingstate: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/{conversationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get conversation
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
try:
# Get conversation
api_response = api_instance.get_conversation(conversation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversation: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/assign Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
body = PureCloudPlatformClientV2.ConversationUser() # ConversationUser | Targeted user
try:
# Attempts to manually assign a specified conversation to a specified user. Ignores bullseye ring, PAR score, skills, and languages.
api_response = api_instance.post_conversation_assign(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_assign: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/barge Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Barge a conversation creating a barged in conference of connected participants.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
try:
# Barge a conversation creating a barged in conference of connected participants.
api_instance.post_conversation_barge(conversation_id)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_barge: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/cobrowse Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Creates a cobrowse session. Requires "conversation:cobrowse:add" (for web messaging) or "conversation:cobrowsevoice:add" permission.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | Conversation ID
try:
# Creates a cobrowse session. Requires \"conversation:cobrowse:add\" (for web messaging) or \"conversation:cobrowsevoice:add\" permission.
api_response = api_instance.post_conversation_cobrowse(conversation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_cobrowse: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/disconnect Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
try:
# Performs a full conversation teardown. Issues disconnect requests for any connected media. Applies a system wrap-up code to any participants that are pending wrap-up. This is not intended to be the normal way of ending interactions but is available in the event of problems with the application to allow a resynchronization of state across all components. It is recommended that users submit a support case if they are relying on this endpoint systematically as there is likely something that needs investigation.
api_response = api_instance.post_conversation_disconnect(conversation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_disconnect: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/{conversationId}/participants/{participantId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a participant. Update conversation participant.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Update request
try:
# Update a participant.
api_instance.patch_conversation_participant(conversation_id, participant_id, body)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversation_participant: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/attributes Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update the attributes on a conversation participant.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
body = PureCloudPlatformClientV2.ParticipantAttributes() # ParticipantAttributes | Participant attributes
try:
# Update the attributes on a conversation participant.
api_instance.patch_conversation_participant_attributes(conversation_id, participant_id, body)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversation_participant_attributes: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a new callback for the specified participant on the conversation.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
body = PureCloudPlatformClientV2.CreateCallbackOnConversationCommand() # CreateCallbackOnConversationCommand | (optional)
try:
# Create a new callback for the specified participant on the conversation.
api_instance.post_conversation_participant_callbacks(conversation_id, participant_id, body=body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_participant_callbacks: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a code used to add a communication to this participant
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
add_communication_code = 'add_communication_code_example' # str | addCommunicationCode
try:
# Delete a code used to add a communication to this participant
api_instance.delete_conversation_participant_code(conversation_id, participant_id, add_communication_code)
except ApiException as e:
print("Exception when calling ConversationsApi->delete_conversation_participant_code: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/digits Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Sends DTMF to the participant
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
body = PureCloudPlatformClientV2.Digits() # Digits | Digits (optional)
try:
# Sends DTMF to the participant
api_instance.post_conversation_participant_digits(conversation_id, participant_id, body=body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_participant_digits: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Remove flagged reason from conversation participant.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
try:
# Remove flagged reason from conversation participant.
api_instance.delete_conversation_participant_flaggedreason(conversation_id, participant_id)
except ApiException as e:
print("Exception when calling ConversationsApi->delete_conversation_participant_flaggedreason: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/conversations/{conversationId}/participants/{participantId}/flaggedreason Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Set flagged reason on conversation participant to indicate bad conversation quality.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
try:
# Set flagged reason on conversation participant to indicate bad conversation quality.
api_instance.put_conversation_participant_flaggedreason(conversation_id, participant_id)
except ApiException as e:
print("Exception when calling ConversationsApi->put_conversation_participant_flaggedreason: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Replace this participant with the specified user and/or address
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
body = PureCloudPlatformClientV2.TransferRequest() # TransferRequest | Transfer request
try:
# Replace this participant with the specified user and/or address
api_instance.post_conversation_participant_replace(conversation_id, participant_id, body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_participant_replace: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Replace this participant with the specified agent
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
body = PureCloudPlatformClientV2.TransferToAgentRequest() # TransferToAgentRequest | Transfer request
try:
# Replace this participant with the specified agent
api_instance.post_conversation_participant_replace_agent(conversation_id, participant_id, body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_participant_replace_agent: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/external Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Replace this participant with the an external contact
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
body = PureCloudPlatformClientV2.TransferToExternalRequest() # TransferToExternalRequest | Transfer request
try:
# Replace this participant with the an external contact
api_instance.post_conversation_participant_replace_external(conversation_id, participant_id, body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_participant_replace_external: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Replace this participant with the specified queue
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
body = PureCloudPlatformClientV2.TransferToQueueRequest() # TransferToQueueRequest | Transfer request
try:
# Replace this participant with the specified queue
api_instance.post_conversation_participant_replace_queue(conversation_id, participant_id, body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_participant_replace_queue: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of secure sessions for this participant.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
try:
# Get a list of secure sessions for this participant.
api_response = api_instance.get_conversation_participant_secureivrsessions(conversation_id, participant_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversation_participant_secureivrsessions: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
body = PureCloudPlatformClientV2.CreateSecureSession() # CreateSecureSession | (optional)
try:
# Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
api_response = api_instance.post_conversation_participant_secureivrsessions(conversation_id, participant_id, body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_participant_secureivrsessions: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/participants/{participantId}/secureivrsessions/{secureSessionId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Fetch info on a secure session
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
secure_session_id = 'secure_session_id_example' # str | secure IVR session ID
try:
# Fetch info on a secure session
api_response = api_instance.get_conversation_participant_secureivrsession(conversation_id, participant_id, secure_session_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversation_participant_secureivrsession: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the wrap-up for this conversation participant.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False)
try:
# Get the wrap-up for this conversation participant.
api_response = api_instance.get_conversation_participant_wrapup(conversation_id, participant_id, provisional=provisional)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversation_participant_wrapup: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get list of wrapup codes for this conversation participant
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
participant_id = 'participant_id_example' # str | participant ID
try:
# Get list of wrapup codes for this conversation participant
api_response = api_instance.get_conversation_participant_wrapupcodes(conversation_id, participant_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversation_participant_wrapupcodes: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/secureattributes Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the secure attributes on a conversation.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
try:
# Get the secure attributes on a conversation.
api_response = api_instance.get_conversation_secureattributes(conversation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversation_secureattributes: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/{conversationId}/secureattributes Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update the secure attributes on a conversation.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
body = PureCloudPlatformClientV2.ConversationSecureAttributes() # ConversationSecureAttributes | Conversation Secure Attributes
try:
# Update the secure attributes on a conversation.
api_response = api_instance.patch_conversation_secureattributes(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversation_secureattributes: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/conversations/{conversationId}/secureattributes Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Set the secure attributes on a conversation.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
body = PureCloudPlatformClientV2.ConversationSecureAttributes() # ConversationSecureAttributes | Conversation Secure Attributes
try:
# Set the secure attributes on a conversation.
api_response = api_instance.put_conversation_secureattributes(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->put_conversation_secureattributes: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/suggestions Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get all suggestions for a conversation.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | Conversation ID
before = 'before_example' # str | The cursor that points to the start of the set of entities that has been returned. (optional)
after = 'after_example' # str | The cursor that points to the end of the set of entities that has been returned. (optional)
page_size = 'page_size_example' # str | Number of entities to return. Maximum of 200. (optional)
type = 'type_example' # str | Suggestion type to filter by. (optional)
state = 'state_example' # str | Suggestion state to filter Copilot suggestions. (optional)
try:
# Get all suggestions for a conversation.
api_response = api_instance.get_conversation_suggestions(conversation_id, before=before, after=after, page_size=page_size, type=type, state=state)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversation_suggestions: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/suggestions/feedback Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Suggestion feedback.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | Conversation ID
body = PureCloudPlatformClientV2.Feedback() # Feedback | SuggestionFeedback
try:
# Suggestion feedback.
api_instance.post_conversation_suggestions_feedback(conversation_id, body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_suggestions_feedback: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/{conversationId}/suggestions/{suggestionId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get Suggestion.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | Conversation ID
suggestion_id = 'suggestion_id_example' # str | Suggestion ID
try:
# Get Suggestion.
api_response = api_instance.get_conversation_suggestion(conversation_id, suggestion_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversation_suggestion: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Save an engagement on the suggestion.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | Conversation ID
suggestion_id = 'suggestion_id_example' # str | Suggestion ID
body = PureCloudPlatformClientV2.SuggestionEngagement() # SuggestionEngagement |
try:
# Save an engagement on the suggestion.
api_response = api_instance.post_conversation_suggestion_engagement(conversation_id, suggestion_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_suggestion_engagement: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/{conversationId}/summaries/{summaryId}/feedback Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Submit feedback for the summary.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | Conversation ID
summary_id = 'summary_id_example' # str | Summary ID
body = PureCloudPlatformClientV2.FeedbackAddRequest() # FeedbackAddRequest | (optional)
try:
# Submit feedback for the summary.
api_instance.post_conversation_summary_feedback(conversation_id, summary_id, body=body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversation_summary_feedback: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/conversations/{conversationId}/tags Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update the tags on a conversation.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
body = PureCloudPlatformClientV2.ConversationTagsUpdate() # ConversationTagsUpdate | Conversation Tags
try:
# Update the tags on a conversation.
api_response = api_instance.put_conversation_tags(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->put_conversation_tags: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/{conversationId}/utilizationlabel Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update the utilization label on a conversation. When there is no value provided, the system default label is applied
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversation ID
body = PureCloudPlatformClientV2.ConversationUtilizationLabelUpdate() # ConversationUtilizationLabelUpdate | Conversation Utilization Label
try:
# Update the utilization label on a conversation. When there is no value provided, the system default label is applied
api_response = api_instance.patch_conversation_utilizationlabel(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversation_utilizationlabel: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/dataextensions/coretypes Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the core types from which all schemas are built.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.DataExtensionsApi();
try:
# Get the core types from which all schemas are built.
api_response = api_instance.get_dataextensions_coretypes()
pprint(api_response)
except ApiException as e:
print("Exception when calling DataExtensionsApi->get_dataextensions_coretypes: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/dataextensions/coretypes/{coretypeName} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a specific named core type.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.DataExtensionsApi();
coretype_name = 'coretype_name_example' # str | The core type's name
try:
# Get a specific named core type.
api_response = api_instance.get_dataextensions_coretype(coretype_name)
pprint(api_response)
except ApiException as e:
print("Exception when calling DataExtensionsApi->get_dataextensions_coretype: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/dataextensions/limits Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get quantitative limits on schemas
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.DataExtensionsApi();
try:
# Get quantitative limits on schemas
api_response = api_instance.get_dataextensions_limits()
pprint(api_response)
except ApiException as e:
print("Exception when calling DataExtensionsApi->get_dataextensions_limits: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/downloads/{downloadId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Issues a redirect to a signed secure download URL for specified download. this method will issue a redirect to the url to the content
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.DownloadsApi();
download_id = 'download_id_example' # str | Download ID
content_disposition = 'content_disposition_example' # str | (optional)
issue_redirect = True # bool | (optional) (default to True)
redirect_to_auth = True # bool | (optional) (default to True)
try:
# Issues a redirect to a signed secure download URL for specified download
api_response = api_instance.get_download(download_id, content_disposition=content_disposition, issue_redirect=issue_redirect, redirect_to_auth=redirect_to_auth)
pprint(api_response)
except ApiException as e:
print("Exception when calling DownloadsApi->get_download: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/emails/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get email Contact Center settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
try:
# Get email Contact Center settings
api_response = api_instance.get_emails_settings()
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->get_emails_settings: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/emails/settings Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Patch email Contact Center settings
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.SettingsApi();
body = PureCloudPlatformClientV2.EmailSettings() # EmailSettings | (optional)
try:
# Patch email Contact Center settings
api_response = api_instance.patch_emails_settings(body=body)
pprint(api_response)
except ApiException as e:
print("Exception when calling SettingsApi->patch_emails_settings: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/employeeengagement/celebrations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get all celebrations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.EmployeeEngagementApi();
page_number = 1 # int | (optional) (default to 1)
page_size = 25 # int | (optional) (default to 25)
try:
# Get all celebrations
api_response = api_instance.get_employeeengagement_celebrations(page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling EmployeeEngagementApi->get_employeeengagement_celebrations: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/employeeengagement/celebrations/{celebrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Deletes a celebration
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.EmployeeEngagementApi();
celebration_id = 'celebration_id_example' # str | The ID of the celebration
try:
# Deletes a celebration
api_instance.delete_employeeengagement_celebration(celebration_id)
except ApiException as e:
print("Exception when calling EmployeeEngagementApi->delete_employeeengagement_celebration: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/employeeengagement/celebrations/{celebrationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Set a state for a celebration
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.EmployeeEngagementApi();
celebration_id = 'celebration_id_example' # str | The ID of the celebration
body = PureCloudPlatformClientV2.CelebrationStateParam() # CelebrationStateParam | Patch Celebration state
try:
# Set a state for a celebration
api_instance.patch_employeeengagement_celebration(celebration_id, body)
except ApiException as e:
print("Exception when calling EmployeeEngagementApi->patch_employeeengagement_celebration: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/employeeengagement/recognitions Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Creates a recognition
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.EmployeeEngagementApi();
body = PureCloudPlatformClientV2.CreateRecognition() # CreateRecognition | Create Recognition
try:
# Creates a recognition
api_response = api_instance.post_employeeengagement_recognitions(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling EmployeeEngagementApi->post_employeeengagement_recognitions: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/employeeengagement/recognitions/{recognitionId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Gets a single recognition
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.EmployeeEngagementApi();
recognition_id = 'recognition_id_example' # str | The Recognition ID
try:
# Gets a single recognition
api_response = api_instance.get_employeeengagement_recognition(recognition_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling EmployeeEngagementApi->get_employeeengagement_recognition: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/events/conversations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Publish Conversation Batch Events
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.EventsApi();
body = PureCloudPlatformClientV2.BatchConversationEventRequest() # BatchConversationEventRequest | batchRequest
try:
# Publish Conversation Batch Events
api_response = api_instance.post_events_conversations(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling EventsApi->post_events_conversations: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/events/users/presence Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Publish User Presence Status Batch Events
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.EventsApi();
body = PureCloudPlatformClientV2.BatchUserPresenceEventRequest() # BatchUserPresenceEventRequest | batchRequest
try:
# Publish User Presence Status Batch Events
api_response = api_instance.post_events_users_presence(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling EventsApi->post_events_users_presence: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/events/users/routingstatus Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Publish Agent Routing Status Batch Events
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.EventsApi();
body = PureCloudPlatformClientV2.BatchUserRoutingStatusEventRequest() # BatchUserRoutingStatusEventRequest | batchRequest
try:
# Publish Agent Routing Status Batch Events
api_response = api_instance.post_events_users_routingstatus(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling EventsApi->post_events_users_routingstatus: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/contacts Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk fetch contacts
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Contact ids
try:
# Bulk fetch contacts
api_response = api_instance.post_externalcontacts_bulk_contacts(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_contacts: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/contacts/add Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk add contacts
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkContactsRequest() # BulkContactsRequest | Contacts
try:
# Bulk add contacts
api_response = api_instance.post_externalcontacts_bulk_contacts_add(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_contacts_add: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/contacts/remove Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk remove contacts
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Contact ids
try:
# Bulk remove contacts
api_response = api_instance.post_externalcontacts_bulk_contacts_remove(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_contacts_remove: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/contacts/unresolved Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk fetch unresolved ancestor contacts
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Contact ids
try:
# Bulk fetch unresolved ancestor contacts
api_response = api_instance.post_externalcontacts_bulk_contacts_unresolved(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_contacts_unresolved: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/contacts/update Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk update contacts
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkContactsRequest() # BulkContactsRequest | Contacts
try:
# Bulk update contacts
api_response = api_instance.post_externalcontacts_bulk_contacts_update(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_contacts_update: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/notes Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk fetch notes
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Note ids
try:
# Bulk fetch notes
api_response = api_instance.post_externalcontacts_bulk_notes(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_notes: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/notes/add Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk add notes
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkNotesRequest() # BulkNotesRequest | Notes
try:
# Bulk add notes
api_response = api_instance.post_externalcontacts_bulk_notes_add(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_notes_add: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/notes/remove Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk remove notes
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Note ids
try:
# Bulk remove notes
api_response = api_instance.post_externalcontacts_bulk_notes_remove(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_notes_remove: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/notes/update Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk update notes
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkNotesRequest() # BulkNotesRequest | Notes
try:
# Bulk update notes
api_response = api_instance.post_externalcontacts_bulk_notes_update(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_notes_update: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/organizations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk fetch organizations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Organizations ids
try:
# Bulk fetch organizations
api_response = api_instance.post_externalcontacts_bulk_organizations(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_organizations: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/organizations/add Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk add organizations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkOrganizationsRequest() # BulkOrganizationsRequest | Organizations
try:
# Bulk add organizations
api_response = api_instance.post_externalcontacts_bulk_organizations_add(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_organizations_add: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/organizations/remove Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk remove organizations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkIdsRequest() # BulkIdsRequest | Organization ids
try:
# Bulk remove organizations
api_response = api_instance.post_externalcontacts_bulk_organizations_remove(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_organizations_remove: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/externalcontacts/bulk/organizations/update Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Bulk update organizations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ExternalContactsApi();
body = PureCloudPlatformClientV2.BulkOrganizationsRequest() # BulkOrganizationsRequest | Organizations
try:
# Bulk update organizations
api_response = api_instance.post_externalcontacts_bulk_organizations_update(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ExternalContactsApi->post_externalcontacts_bulk_organizations_update: %s\n" % e)```
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.