instruction
stringlengths 81
221
| input
stringlengths 50
1.19k
| output
stringlengths 525
3.61k
|
|---|---|---|
Provide a Python example that uses the GET /api/v2/chats/users/{userId}/messages/{messageIds} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get messages by id(s) from a 1on1
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ChatApi();
user_id = 'user_id_example' # str | userId
message_ids = 'message_ids_example' # str | messageIds, comma separated
try:
# Get messages by id(s) from a 1on1
api_response = api_instance.get_chats_user_message(user_id, message_ids)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChatApi->get_chats_user_message: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/chats/users/{userId}/messages/{messageId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a message to a user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ChatApi();
user_id = 'user_id_example' # str | userId
message_id = 'message_id_example' # str | messageId
try:
# Delete a message to a user
api_instance.delete_chats_user_message(user_id, message_id)
except ApiException as e:
print("Exception when calling ChatApi->delete_chats_user_message: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/chats/users/{userId}/messages/{messageId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Edit a message to a user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ChatApi();
user_id = 'user_id_example' # str | userId
message_id = 'message_id_example' # str | messageId
body = PureCloudPlatformClientV2.SendMessageBody() # SendMessageBody | message body
try:
# Edit a message to a user
api_response = api_instance.patch_chats_user_message(user_id, message_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ChatApi->patch_chats_user_message: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/coaching/appointments Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get appointments for users and optional date range
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
user_ids = ['user_ids_example'] # list[str] | The user IDs for which to retrieve appointments
interval = 'interval_example' # str | Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
statuses = ['statuses_example'] # list[str] | Appointment Statuses to filter by (optional)
facilitator_ids = ['facilitator_ids_example'] # list[str] | The facilitator IDs for which to retrieve appointments (optional)
sort_order = 'sort_order_example' # str | Sort (by due date) either Asc or Desc (optional)
relationships = ['relationships_example'] # list[str] | Relationships to filter by (optional)
completion_interval = 'completion_interval_example' # str | Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
overdue = 'overdue_example' # str | Overdue status to filter by (optional)
interval_condition = 'interval_condition_example' # str | Filter condition for interval (optional)
try:
# Get appointments for users and optional date range
api_response = api_instance.get_coaching_appointments(user_ids, interval=interval, page_number=page_number, page_size=page_size, statuses=statuses, facilitator_ids=facilitator_ids, sort_order=sort_order, relationships=relationships, completion_interval=completion_interval, overdue=overdue, interval_condition=interval_condition)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->get_coaching_appointments: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/coaching/appointments Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a new appointment
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
body = PureCloudPlatformClientV2.CreateCoachingAppointmentRequest() # CreateCoachingAppointmentRequest | The appointment to add
try:
# Create a new appointment
api_response = api_instance.post_coaching_appointments(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->post_coaching_appointments: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/coaching/appointments/aggregates/query Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve aggregated appointment data
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
body = PureCloudPlatformClientV2.CoachingAppointmentAggregateRequest() # CoachingAppointmentAggregateRequest | Aggregate Request
try:
# Retrieve aggregated appointment data
api_response = api_instance.post_coaching_appointments_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->post_coaching_appointments_aggregates_query: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/coaching/appointments/me Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get my appointments for a given date range
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
interval = 'interval_example' # str | Interval to filter data by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
statuses = ['statuses_example'] # list[str] | Appointment Statuses to filter by (optional)
facilitator_ids = ['facilitator_ids_example'] # list[str] | The facilitator IDs for which to retrieve appointments (optional)
sort_order = 'sort_order_example' # str | Sort (by due date) either Asc or Desc (optional)
relationships = ['relationships_example'] # list[str] | Relationships to filter by (optional)
completion_interval = 'completion_interval_example' # str | Appointment completion start and end to filter by. End date is not inclusive. Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss (optional)
overdue = 'overdue_example' # str | Overdue status to filter by (optional)
interval_condition = 'interval_condition_example' # str | Filter condition for interval (optional)
try:
# Get my appointments for a given date range
api_response = api_instance.get_coaching_appointments_me(interval=interval, page_number=page_number, page_size=page_size, statuses=statuses, facilitator_ids=facilitator_ids, sort_order=sort_order, relationships=relationships, completion_interval=completion_interval, overdue=overdue, interval_condition=interval_condition)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->get_coaching_appointments_me: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/coaching/appointments/{appointmentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete an existing appointment. Permission not required if you are the creator of the appointment
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
try:
# Delete an existing appointment
api_response = api_instance.delete_coaching_appointment(appointment_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->delete_coaching_appointment: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/coaching/appointments/{appointmentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve an appointment. Permission not required if you are the attendee, creator or facilitator of the appointment
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
try:
# Retrieve an appointment
api_response = api_instance.get_coaching_appointment(appointment_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->get_coaching_appointment: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/coaching/appointments/{appointmentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update an existing appointment. Permission not required if you are the creator or facilitator of the appointment
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
body = PureCloudPlatformClientV2.UpdateCoachingAppointmentRequest() # UpdateCoachingAppointmentRequest | The new version of the appointment
try:
# Update an existing appointment
api_response = api_instance.patch_coaching_appointment(appointment_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->patch_coaching_appointment: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/coaching/appointments/{appointmentId}/annotations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of annotations. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get a list of annotations.
api_response = api_instance.get_coaching_appointment_annotations(appointment_id, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->get_coaching_appointment_annotations: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/coaching/appointments/{appointmentId}/annotations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a new annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can create private annotations).
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
body = PureCloudPlatformClientV2.CoachingAnnotationCreateRequest() # CoachingAnnotationCreateRequest | The annotation to add
try:
# Create a new annotation.
api_response = api_instance.post_coaching_appointment_annotations(appointment_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->post_coaching_appointment_annotations: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete an existing annotation. You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
annotation_id = 'annotation_id_example' # str | The ID of the annotation.
try:
# Delete an existing annotation
api_instance.delete_coaching_appointment_annotation(appointment_id, annotation_id)
except ApiException as e:
print("Exception when calling CoachingApi->delete_coaching_appointment_annotation: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve an annotation. You must have the appropriate permission for the type of annotation you are creating. Permission not required if you are related to the appointment (only the creator or facilitator can view private annotations).
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
annotation_id = 'annotation_id_example' # str | The ID of the annotation.
try:
# Retrieve an annotation.
api_response = api_instance.get_coaching_appointment_annotation(appointment_id, annotation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->get_coaching_appointment_annotation: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/coaching/appointments/{appointmentId}/annotations/{annotationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update an existing annotation. You must have the appropriate permission for the type of annotation you are updating. Permission not required if you are the creator or facilitator of the appointment
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
annotation_id = 'annotation_id_example' # str | The ID of the annotation.
body = PureCloudPlatformClientV2.CoachingAnnotation() # CoachingAnnotation | The new version of the annotation
try:
# Update an existing annotation.
api_response = api_instance.patch_coaching_appointment_annotation(appointment_id, annotation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->patch_coaching_appointment_annotation: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/coaching/appointments/{appointmentId}/conversations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add a conversation to an appointment. Permission not required if you are the creator or facilitator of the appointment
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
body = PureCloudPlatformClientV2.AddConversationRequest() # AddConversationRequest | body
try:
# Add a conversation to an appointment
api_response = api_instance.post_coaching_appointment_conversations(appointment_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->post_coaching_appointment_conversations: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/coaching/appointments/{appointmentId}/status Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update the status of a coaching appointment. Permission not required if you are an attendee, creator or facilitator of the appointment
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
body = PureCloudPlatformClientV2.CoachingAppointmentStatusRequest() # CoachingAppointmentStatusRequest | Updated status of the coaching appointment
try:
# Update the status of a coaching appointment
api_response = api_instance.patch_coaching_appointment_status(appointment_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->patch_coaching_appointment_status: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/coaching/appointments/{appointmentId}/statuses Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the list of status changes for a coaching appointment. Permission not required if you are an attendee, creator or facilitator of the appointment
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
appointment_id = 'appointment_id_example' # str | The ID of the coaching appointment.
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
try:
# Get the list of status changes for a coaching appointment.
api_response = api_instance.get_coaching_appointment_statuses(appointment_id, page_number=page_number, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->get_coaching_appointment_statuses: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/coaching/notifications Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve the list of your notifications.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
page_number = 1 # int | Page number (optional) (default to 1)
page_size = 25 # int | Page size (optional) (default to 25)
expand = ['expand_example'] # list[str] | Indicates a field in the response which should be expanded. (optional)
try:
# Retrieve the list of your notifications.
api_response = api_instance.get_coaching_notifications(page_number=page_number, page_size=page_size, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->get_coaching_notifications: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/coaching/notifications/{notificationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get an existing notification. Permission not required if you are the owner of the notification.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
notification_id = 'notification_id_example' # str | The ID of the notification.
expand = ['expand_example'] # list[str] | Indicates a field in the response which should be expanded. (optional)
try:
# Get an existing notification
api_response = api_instance.get_coaching_notification(notification_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->get_coaching_notification: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/coaching/notifications/{notificationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update an existing notification. Can only update your own notifications.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
notification_id = 'notification_id_example' # str | The ID of the notification.
body = PureCloudPlatformClientV2.CoachingNotification() # CoachingNotification | Change the read state of a notification
try:
# Update an existing notification.
api_response = api_instance.patch_coaching_notification(notification_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->patch_coaching_notification: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/coaching/scheduleslots/query Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get list of possible slots where a coaching appointment can be scheduled.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.CoachingApi();
body = PureCloudPlatformClientV2.CoachingSlotsRequest() # CoachingSlotsRequest | The slot search request
try:
# Get list of possible slots where a coaching appointment can be scheduled.
api_response = api_instance.post_coaching_scheduleslots_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling CoachingApi->post_coaching_scheduleslots_query: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/contentmanagement/documents Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add a document.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
body = PureCloudPlatformClientV2.DocumentUpload() # DocumentUpload | Document
copy_source = 'copy_source_example' # str | Copy a document within a workspace or to a new workspace. Provide a document ID as the copy source. (optional)
move_source = 'move_source_example' # str | Move a document to a new workspace. Provide a document ID as the move source. (optional)
override = True # bool | Override any lock on the source document (optional)
try:
# Add a document.
api_response = api_instance.post_contentmanagement_documents(body, copy_source=copy_source, move_source=move_source, override=override)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->post_contentmanagement_documents: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/contentmanagement/documents/{documentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a document.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
document_id = 'document_id_example' # str | Document ID
override = True # bool | Override any lock on the document (optional)
try:
# Delete a document.
api_instance.delete_contentmanagement_document(document_id, override=override)
except ApiException as e:
print("Exception when calling ContentManagementApi->delete_contentmanagement_document: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/documents/{documentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a document.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
document_id = 'document_id_example' # str | Document ID
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Get a document.
api_response = api_instance.get_contentmanagement_document(document_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_document: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/contentmanagement/documents/{documentId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a document.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
document_id = 'document_id_example' # str | Document ID
body = PureCloudPlatformClientV2.DocumentUpdate() # DocumentUpdate | Document
expand = 'expand_example' # str | Expand some document fields (optional)
override = True # bool | Override any lock on the document (optional)
try:
# Update a document.
api_response = api_instance.post_contentmanagement_document(document_id, body, expand=expand, override=override)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->post_contentmanagement_document: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/documents/{documentId}/content Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Download a document.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
document_id = 'document_id_example' # str | Document ID
disposition = 'disposition_example' # str | Request how the content will be downloaded: a file attachment or inline. Default is attachment. (optional)
content_type = 'content_type_example' # str | The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav (optional)
try:
# Download a document.
api_response = api_instance.get_contentmanagement_document_content(document_id, disposition=disposition, content_type=content_type)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_document_content: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/contentmanagement/documents/{documentId}/content Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Replace the contents of a document.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
document_id = 'document_id_example' # str | Document ID
body = PureCloudPlatformClientV2.ReplaceRequest() # ReplaceRequest | Replace Request
override = True # bool | Override any lock on the document (optional)
try:
# Replace the contents of a document.
api_response = api_instance.post_contentmanagement_document_content(document_id, body, override=override)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->post_contentmanagement_document_content: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/query Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query content
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
query_phrase = 'query_phrase_example' # str | Phrase tokens are ANDed together over all searchable fields
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
sort_by = ''name'' # str | name or dateCreated (optional) (default to 'name')
sort_order = ''ascending'' # str | ascending or descending (optional) (default to 'ascending')
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Query content
api_response = api_instance.get_contentmanagement_query(query_phrase, page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_query: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/contentmanagement/query Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query content
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
body = PureCloudPlatformClientV2.QueryRequest() # QueryRequest | Allows for a filtered query returning facet information
expand = 'expand_example' # str | Expand some document fields (optional)
try:
# Query content
api_response = api_instance.post_contentmanagement_query(body, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->post_contentmanagement_query: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/securityprofiles Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a List of Security Profiles
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
try:
# Get a List of Security Profiles
api_response = api_instance.get_contentmanagement_securityprofiles()
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_securityprofiles: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/securityprofiles/{securityProfileId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a Security Profile
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
security_profile_id = 'security_profile_id_example' # str | Security Profile Id
try:
# Get a Security Profile
api_response = api_instance.get_contentmanagement_securityprofile(security_profile_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_securityprofile: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/shared/{sharedId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get shared documents. Securely download a shared document. This method requires the download sharing URI obtained in the get document response (downloadSharingUri). Documents may be shared between users in the same workspace. Documents may also be shared between any user by creating a content management share.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
shared_id = 'shared_id_example' # str | Shared ID
redirect = True # bool | Turn on or off redirect (optional) (default to True)
disposition = ''attachment'' # str | Request how the share content will be downloaded: attached as a file or inline. Default is attachment. (optional) (default to 'attachment')
content_type = 'content_type_example' # str | The requested format for the specified document. If supported, the document will be returned in that format. Example contentType=audio/wav (optional)
expand = 'expand_example' # str | Expand some document fields (optional)
try:
# Get shared documents. Securely download a shared document.
api_response = api_instance.get_contentmanagement_shared_shared_id(shared_id, redirect=redirect, disposition=disposition, content_type=content_type, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_shared_shared_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/shares Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Gets a list of shares. You must specify at least one filter (e.g. entityId). Failing to specify a filter will return 400.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
entity_id = 'entity_id_example' # str | Filters the shares returned to only the entity specified by the value of this parameter. (optional)
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
try:
# Gets a list of shares. You must specify at least one filter (e.g. entityId).
api_response = api_instance.get_contentmanagement_shares(entity_id=entity_id, expand=expand, page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_shares: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/contentmanagement/shares Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Creates a new share or updates an existing share if the entity has already been shared
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
body = PureCloudPlatformClientV2.CreateShareRequest() # CreateShareRequest | CreateShareRequest - entity id and type and a single member or list of members are required
try:
# Creates a new share or updates an existing share if the entity has already been shared
api_response = api_instance.post_contentmanagement_shares(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->post_contentmanagement_shares: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/contentmanagement/shares/{shareId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Deletes an existing share. This revokes sharing rights specified in the share record
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
share_id = 'share_id_example' # str | Share ID
try:
# Deletes an existing share.
api_instance.delete_contentmanagement_share(share_id)
except ApiException as e:
print("Exception when calling ContentManagementApi->delete_contentmanagement_share: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/shares/{shareId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Retrieve details about an existing share.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
share_id = 'share_id_example' # str | Share ID
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Retrieve details about an existing share.
api_response = api_instance.get_contentmanagement_share(share_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_share: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/status Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of statuses for pending operations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
try:
# Get a list of statuses for pending operations
api_response = api_instance.get_contentmanagement_status(page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_status: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/contentmanagement/status/{statusId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Cancel the command for this status
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
status_id = 'status_id_example' # str | Status ID
try:
# Cancel the command for this status
api_instance.delete_contentmanagement_status_status_id(status_id)
except ApiException as e:
print("Exception when calling ContentManagementApi->delete_contentmanagement_status_status_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/status/{statusId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a status.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
status_id = 'status_id_example' # str | Status ID
try:
# Get a status.
api_response = api_instance.get_contentmanagement_status_status_id(status_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_status_status_id: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/usage Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get usage details.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
try:
# Get usage details.
api_response = api_instance.get_contentmanagement_usage()
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_usage: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of workspaces. Specifying 'content' access will return all workspaces the user has document access to, while 'admin' access will return all group workspaces the user has administrative rights to.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
access = ['access_example'] # list[str] | Requested access level. (optional)
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Get a list of workspaces.
api_response = api_instance.get_contentmanagement_workspaces(page_size=page_size, page_number=page_number, access=access, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_workspaces: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/contentmanagement/workspaces Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a group workspace
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
body = PureCloudPlatformClientV2.WorkspaceCreate() # WorkspaceCreate | Workspace
try:
# Create a group workspace
api_response = api_instance.post_contentmanagement_workspaces(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->post_contentmanagement_workspaces: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/contentmanagement/workspaces/{workspaceId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a workspace
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
move_children_to_workspace_id = 'move_children_to_workspace_id_example' # str | New location for objects in deleted workspace. (optional)
try:
# Delete a workspace
api_instance.delete_contentmanagement_workspace(workspace_id, move_children_to_workspace_id=move_children_to_workspace_id)
except ApiException as e:
print("Exception when calling ContentManagementApi->delete_contentmanagement_workspace: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a workspace.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Get a workspace.
api_response = api_instance.get_contentmanagement_workspace(workspace_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_workspace: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/contentmanagement/workspaces/{workspaceId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a workspace
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
body = PureCloudPlatformClientV2.Workspace() # Workspace | Workspace
try:
# Update a workspace
api_response = api_instance.put_contentmanagement_workspace(workspace_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->put_contentmanagement_workspace: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId}/documents Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of documents.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
sort_by = 'sort_by_example' # str | name or dateCreated (optional)
sort_order = ''ascending'' # str | ascending or descending (optional) (default to 'ascending')
try:
# Get a list of documents.
api_response = api_instance.get_contentmanagement_workspace_documents(workspace_id, expand=expand, page_size=page_size, page_number=page_number, sort_by=sort_by, sort_order=sort_order)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_workspace_documents: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId}/members Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list workspace members
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Get a list workspace members
api_response = api_instance.get_contentmanagement_workspace_members(workspace_id, page_size=page_size, page_number=page_number, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_workspace_members: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete a member from a workspace
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
member_id = 'member_id_example' # str | Member ID
try:
# Delete a member from a workspace
api_instance.delete_contentmanagement_workspace_member(workspace_id, member_id)
except ApiException as e:
print("Exception when calling ContentManagementApi->delete_contentmanagement_workspace_member: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a workspace member
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
member_id = 'member_id_example' # str | Member ID
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Get a workspace member
api_response = api_instance.get_contentmanagement_workspace_member(workspace_id, member_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_workspace_member: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/contentmanagement/workspaces/{workspaceId}/members/{memberId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add a member to a workspace
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
member_id = 'member_id_example' # str | Member ID
body = PureCloudPlatformClientV2.WorkspaceMember() # WorkspaceMember | Workspace Member
try:
# Add a member to a workspace
api_response = api_instance.put_contentmanagement_workspace_member(workspace_id, member_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->put_contentmanagement_workspace_member: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a list of workspace tags
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
value = 'value_example' # str | filter the list of tags returned (optional)
page_size = 25 # int | Page size (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Get a list of workspace tags
api_response = api_instance.get_contentmanagement_workspace_tagvalues(workspace_id, value=value, page_size=page_size, page_number=page_number, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_workspace_tagvalues: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a workspace tag
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
body = PureCloudPlatformClientV2.TagValue() # TagValue | tag
try:
# Create a workspace tag
api_response = api_instance.post_contentmanagement_workspace_tagvalues(workspace_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->post_contentmanagement_workspace_tagvalues: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/query Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Perform a prefix query on tags in the workspace
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
body = PureCloudPlatformClientV2.TagQueryRequest() # TagQueryRequest | query
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Perform a prefix query on tags in the workspace
api_response = api_instance.post_contentmanagement_workspace_tagvalues_query(workspace_id, body, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->post_contentmanagement_workspace_tagvalues_query: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete workspace tag. Delete a tag from a workspace. Will remove this tag from all documents.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
tag_id = 'tag_id_example' # str | Tag ID
try:
# Delete workspace tag
api_instance.delete_contentmanagement_workspace_tagvalue(workspace_id, tag_id)
except ApiException as e:
print("Exception when calling ContentManagementApi->delete_contentmanagement_workspace_tagvalue: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a workspace tag
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
tag_id = 'tag_id_example' # str | Tag ID
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Get a workspace tag
api_response = api_instance.get_contentmanagement_workspace_tagvalue(workspace_id, tag_id, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->get_contentmanagement_workspace_tagvalue: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/contentmanagement/workspaces/{workspaceId}/tagvalues/{tagId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a workspace tag. Will update all documents with the new tag value.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ContentManagementApi();
workspace_id = 'workspace_id_example' # str | Workspace ID
tag_id = 'tag_id_example' # str | Tag ID
body = PureCloudPlatformClientV2.TagValue() # TagValue | Workspace
try:
# Update a workspace tag. Will update all documents with the new tag value.
api_response = api_instance.put_contentmanagement_workspace_tagvalue(workspace_id, tag_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ContentManagementApi->put_contentmanagement_workspace_tagvalue: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/analytics/conversations/activity/query Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query for conversation activity observations
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.ConversationActivityQuery() # ConversationActivityQuery | query
page_size = 56 # int | The desired page size (optional)
page_number = 56 # int | The desired page number (optional)
try:
# Query for conversation activity observations
api_response = api_instance.post_analytics_conversations_activity_query(body, page_size=page_size, page_number=page_number)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_analytics_conversations_activity_query: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/analytics/conversations/aggregates/query Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query for conversation aggregates
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.ConversationAggregationQuery() # ConversationAggregationQuery | query
try:
# Query for conversation aggregates
api_response = api_instance.post_analytics_conversations_aggregates_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_analytics_conversations_aggregates_query: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/analytics/conversations/details Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Gets multiple conversations by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
id = ['id_example'] # list[str] | Comma-separated conversation ids (optional)
try:
# Gets multiple conversations by id
api_response = api_instance.get_analytics_conversations_details(id=id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_analytics_conversations_details: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/analytics/conversations/details/jobs Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query for conversation details asynchronously
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.AsyncConversationQuery() # AsyncConversationQuery | query
try:
# Query for conversation details asynchronously
api_response = api_instance.post_analytics_conversations_details_jobs(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_analytics_conversations_details_jobs: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/availability Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Lookup the datalake availability date and time
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
try:
# Lookup the datalake availability date and time
api_response = api_instance.get_analytics_conversations_details_jobs_availability()
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_analytics_conversations_details_jobs_availability: %s\n" % e)```
|
Provide a Python example that uses the DELETE /api/v2/analytics/conversations/details/jobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Delete/cancel an async details job
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
job_id = 'job_id_example' # str | jobId
try:
# Delete/cancel an async details job
api_instance.delete_analytics_conversations_details_job(job_id)
except ApiException as e:
print("Exception when calling ConversationsApi->delete_analytics_conversations_details_job: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/{jobId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get status for async query for conversation details
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
job_id = 'job_id_example' # str | jobId
try:
# Get status for async query for conversation details
api_response = api_instance.get_analytics_conversations_details_job(job_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_analytics_conversations_details_job: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/analytics/conversations/details/jobs/{jobId}/results Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Fetch a page of results for an async details job
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
job_id = 'job_id_example' # str | jobId
cursor = 'cursor_example' # str | Indicates where to resume query results (not required for first page) (optional)
page_size = 56 # int | The desired maximum number of results (optional)
try:
# Fetch a page of results for an async details job
api_response = api_instance.get_analytics_conversations_details_job_results(job_id, cursor=cursor, page_size=page_size)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_analytics_conversations_details_job_results: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/analytics/conversations/details/query Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Query for conversation details
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.ConversationQuery() # ConversationQuery | query
try:
# Query for conversation details
api_response = api_instance.post_analytics_conversations_details_query(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_analytics_conversations_details_query: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/analytics/conversations/{conversationId}/details Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get a conversation by id
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
try:
# Get a conversation by id
api_response = api_instance.get_analytics_conversation_details(conversation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_analytics_conversation_details: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/analytics/conversations/{conversationId}/details/properties Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Index conversation properties
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
body = PureCloudPlatformClientV2.PropertyIndexRequest() # PropertyIndexRequest | request
try:
# Index conversation properties
api_response = api_instance.post_analytics_conversation_details_properties(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_analytics_conversation_details_properties: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get active conversations for the logged in user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
communication_type = 'communication_type_example' # str | Call or Chat communication filtering (optional)
try:
# Get active conversations for the logged in user
api_response = api_instance.get_conversations(communication_type=communication_type)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/aftercallwork/{conversationId}/participants/{participantId}/communications/{communicationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update after-call work for this conversation communication.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
communication_id = 'communication_id_example' # str | communicationId
body = PureCloudPlatformClientV2.AfterCallWorkUpdate() # AfterCallWorkUpdate | AfterCallWorkUpdate
try:
# Update after-call work for this conversation communication.
api_response = api_instance.patch_conversations_aftercallwork_conversation_id_participant_communication(conversation_id, participant_id, communication_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_aftercallwork_conversation_id_participant_communication: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/callbacks Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get active callback conversations for the logged in user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
try:
# Get active callback conversations for the logged in user
api_response = api_instance.get_conversations_callbacks()
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_callbacks: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/callbacks Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a scheduled callback
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.PatchCallbackRequest() # PatchCallbackRequest | PatchCallbackRequest
try:
# Update a scheduled callback
api_response = api_instance.patch_conversations_callbacks(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_callbacks: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/callbacks Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a Callback
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.CreateCallbackCommand() # CreateCallbackCommand | Callback
try:
# Create a Callback
api_response = api_instance.post_conversations_callbacks(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_callbacks: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/callbacks/bulk/disconnect Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Disconnect multiple scheduled callbacks
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.BulkCallbackDisconnectRequest() # BulkCallbackDisconnectRequest | BulkCallbackDisconnectRequest
try:
# Disconnect multiple scheduled callbacks
api_instance.post_conversations_callbacks_bulk_disconnect(body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_callbacks_bulk_disconnect: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/callbacks/bulk/update Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update multiple scheduled callbacks
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.BulkCallbackPatchRequest() # BulkCallbackPatchRequest | BulkCallbackPatchRequest
try:
# Update multiple scheduled callbacks
api_response = api_instance.post_conversations_callbacks_bulk_update(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_callbacks_bulk_update: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/callbacks/{conversationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get callback conversation
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
try:
# Get callback conversation
api_response = api_instance.get_conversations_callback(conversation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_callback: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/callbacks/{conversationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a conversation by disconnecting all of the participants
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
body = PureCloudPlatformClientV2.Conversation() # Conversation | Conversation
try:
# Update a conversation by disconnecting all of the participants
api_response = api_instance.patch_conversations_callback(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_callback: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update conversation participant
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant
try:
# Update conversation participant
api_instance.patch_conversations_callback_participant(conversation_id, participant_id, body)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_callback_participant: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update the attributes on a conversation participant.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
body = PureCloudPlatformClientV2.ParticipantAttributes() # ParticipantAttributes | Attributes
try:
# Update the attributes on a conversation participant.
api_response = api_instance.patch_conversations_callback_participant_attributes(conversation_id, participant_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_callback_participant_attributes: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update conversation participant's communication by disconnecting it.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
communication_id = 'communication_id_example' # str | communicationId
body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant
try:
# Update conversation participant's communication by disconnecting it.
api_response = api_instance.patch_conversations_callback_participant_communication(conversation_id, participant_id, communication_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_callback_participant_communication: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the wrap-up for this conversation communication.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
communication_id = 'communication_id_example' # str | communicationId
provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False)
try:
# Get the wrap-up for this conversation communication.
api_response = api_instance.get_conversations_callback_participant_communication_wrapup(conversation_id, participant_id, communication_id, provisional=provisional)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_callback_participant_communication_wrapup: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}/wrapup Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Apply wrap-up for this conversation communication
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
communication_id = 'communication_id_example' # str | communicationId
body = PureCloudPlatformClientV2.WrapupInput() # WrapupInput | Wrap-up (optional)
try:
# Apply wrap-up for this conversation communication
api_instance.post_conversations_callback_participant_communication_wrapup(conversation_id, participant_id, communication_id, body=body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_callback_participant_communication_wrapup: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/replace Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Replace this participant with the specified user and/or address
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
body = PureCloudPlatformClientV2.TransferRequest() # TransferRequest | Transfer request
try:
# Replace this participant with the specified user and/or address
api_instance.post_conversations_callback_participant_replace(conversation_id, participant_id, body)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_callback_participant_replace: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapup Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the wrap-up for this conversation participant.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
provisional = False # bool | Indicates if the wrap-up code is provisional. (optional) (default to False)
try:
# Get the wrap-up for this conversation participant.
api_response = api_instance.get_conversations_callback_participant_wrapup(conversation_id, participant_id, provisional=provisional)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_callback_participant_wrapup: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/wrapupcodes Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get list of wrapup codes for this conversation participant
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
try:
# Get list of wrapup codes for this conversation participant
api_response = api_instance.get_conversations_callback_participant_wrapupcodes(conversation_id, participant_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_callback_participant_wrapupcodes: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/conversations/callbacks/{conversationId}/recordingstate Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a conversation by setting its recording state
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
body = PureCloudPlatformClientV2.SetRecordingState() # SetRecordingState | SetRecordingState
try:
# Update a conversation by setting its recording state
api_response = api_instance.put_conversations_callback_recordingstate(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->put_conversations_callback_recordingstate: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/calls Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get active call conversations for the logged in user
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
try:
# Get active call conversations for the logged in user
api_response = api_instance.get_conversations_calls()
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_calls: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/calls Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Create a call conversation
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
body = PureCloudPlatformClientV2.CreateCallRequest() # CreateCallRequest | Call request
try:
# Create a call conversation
api_response = api_instance.post_conversations_calls(body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_calls: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/calls/history Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get call history
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
page_size = 25 # int | Page size, maximum 50 (optional) (default to 25)
page_number = 1 # int | Page number (optional) (default to 1)
interval = 'interval_example' # str | Interval string; format is ISO-8601. Separate start and end times with forward slash '/' (optional)
expand = ['expand_example'] # list[str] | Which fields, if any, to expand. (optional)
try:
# Get call history
api_response = api_instance.get_conversations_calls_history(page_size=page_size, page_number=page_number, interval=interval, expand=expand)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_calls_history: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/calls/maximumconferenceparties Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get the maximum number of participants that this user can have on a conference
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
try:
# Get the maximum number of participants that this user can have on a conference
api_response = api_instance.get_conversations_calls_maximumconferenceparties()
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_calls_maximumconferenceparties: %s\n" % e)```
|
Provide a Python example that uses the GET /api/v2/conversations/calls/{conversationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Get call conversation
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
try:
# Get call conversation
api_response = api_instance.get_conversations_call(conversation_id)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->get_conversations_call: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/calls/{conversationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
body = PureCloudPlatformClientV2.Conversation() # Conversation | Conversation
try:
# Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
api_response = api_instance.patch_conversations_call(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_call: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Place a new call as part of a callback conversation.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
body = PureCloudPlatformClientV2.CallCommand() # CallCommand | Conversation
try:
# Place a new call as part of a callback conversation.
api_response = api_instance.post_conversations_call(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_call: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Add participants to a conversation
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
body = PureCloudPlatformClientV2.Conversation() # Conversation | Conversation
try:
# Add participants to a conversation
api_response = api_instance.post_conversations_call_participants(conversation_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_call_participants: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update conversation participant
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant request
try:
# Update conversation participant
api_instance.patch_conversations_call_participant(conversation_id, participant_id, body)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_call_participant: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update the attributes on a conversation participant.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
body = PureCloudPlatformClientV2.ParticipantAttributes() # ParticipantAttributes | Participant attributes
try:
# Update the attributes on a conversation participant.
api_response = api_instance.patch_conversations_call_participant_attributes(conversation_id, participant_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_call_participant_attributes: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Barge a given participant's call creating a barged in conference of connected participants.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
try:
# Barge a given participant's call creating a barged in conference of connected participants.
api_instance.post_conversations_call_participant_barge(conversation_id, participant_id)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_call_participant_barge: %s\n" % e)```
|
Provide a Python example that uses the POST /api/v2/conversations/calls/{conversationId}/participants/{participantId}/coach Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
try:
# Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
api_instance.post_conversations_call_participant_coach(conversation_id, participant_id)
except ApiException as e:
print("Exception when calling ConversationsApi->post_conversations_call_participant_coach: %s\n" % e)```
|
Provide a Python example that uses the PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId} Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Update conversation participant's communication by disconnecting it.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
communication_id = 'communication_id_example' # str | communicationId
body = PureCloudPlatformClientV2.MediaParticipantRequest() # MediaParticipantRequest | Participant
try:
# Update conversation participant's communication by disconnecting it.
api_response = api_instance.patch_conversations_call_participant_communication(conversation_id, participant_id, communication_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->patch_conversations_call_participant_communication: %s\n" % e)```
|
Provide a Python example that uses the PUT /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}/uuidata Genesys Cloud Python SDK.
|
Genesys describes this as an API used to: Set uuiData to be sent on future commands.
|
```import PureCloudPlatformClientV2
from PureCloudPlatformClientV2.rest import ApiException
from pprint import pprint
# Configure OAuth2 access token for authorization: PureCloud OAuth
PureCloudPlatformClientV2.configuration.access_token = 'your_access_token'
# or use get_client_credentials_token(...), get_saml2bearer_token(...), get_code_authorization_token(...) or get_pkce_token(...)
# create an instance of the API class
api_instance = PureCloudPlatformClientV2.ConversationsApi();
conversation_id = 'conversation_id_example' # str | conversationId
participant_id = 'participant_id_example' # str | participantId
communication_id = 'communication_id_example' # str | communicationId
body = PureCloudPlatformClientV2.SetUuiDataRequest() # SetUuiDataRequest | UUIData Request
try:
# Set uuiData to be sent on future commands.
api_response = api_instance.put_conversations_call_participant_communication_uuidata(conversation_id, participant_id, communication_id, body)
pprint(api_response)
except ApiException as e:
print("Exception when calling ConversationsApi->put_conversations_call_participant_communication_uuidata: %s\n" % e)```
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.