purecloudplatformclientv2 27.1.0 → 28.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -2
- data/docs/AdditionalMessage.md +13 -0
- data/docs/AnalyticsParticipant.md +1 -0
- data/docs/ArchitectApi.md +40 -28
- data/docs/Attachment.md +5 -5
- data/docs/ConversationNotificationAttachment.md +18 -0
- data/docs/ConversationNotificationDraftAttachments.md +18 -0
- data/docs/ConversationNotificationEmail.md +1 -0
- data/docs/ConversationNotificationEmails.md +1 -0
- data/docs/ConversationsApi.md +964 -198
- data/docs/DataTable.md +17 -0
- data/docs/DataTableRowEntityListing.md +22 -0
- data/docs/DataTablesDomainEntityListing.md +22 -0
- data/docs/Document.md +1 -1
- data/docs/DomainEdgeSoftwareVersionDto.md +1 -1
- data/docs/DomainOrganizationRole.md +1 -1
- data/docs/DomainOrganizationRoleCreate.md +1 -1
- data/docs/DomainOrganizationRoleUpdate.md +1 -1
- data/docs/Email.md +1 -0
- data/docs/EmailConversationNotificationAttachment.md +18 -0
- data/docs/EmailConversationNotificationEmailMediaParticipant.md +1 -0
- data/docs/EmailConversationNotificationParticipants.md +1 -0
- data/docs/EmailMediaParticipant.md +1 -0
- data/docs/FaxDocument.md +1 -1
- data/docs/JsonNode.md +4 -4
- data/docs/MessageConversation.md +17 -0
- data/docs/MessageConversationEntityListing.md +22 -0
- data/docs/MessageData.md +25 -0
- data/docs/MessageMediaParticipant.md +44 -0
- data/docs/Question.md +1 -1
- data/docs/Recipient.md +20 -0
- data/docs/RecipientListing.md +22 -0
- data/docs/RoutingApi.md +632 -0
- data/docs/SMSAvailablePhoneNumberEntityListing.md +13 -0
- data/docs/SmsAddressProvision.md +21 -0
- data/docs/SmsAvailablePhoneNumber.md +22 -0
- data/docs/SmsPhoneNumber.md +25 -0
- data/docs/SmsPhoneNumberEntityListing.md +22 -0
- data/docs/SmsPhoneNumberProvision.md +18 -0
- data/docs/TextMessageListing.md +22 -0
- data/lib/purecloudplatformclientv2.rb +20 -0
- data/lib/purecloudplatformclientv2/api/architect_api.rb +108 -34
- data/lib/purecloudplatformclientv2/api/conversations_api.rb +1247 -317
- data/lib/purecloudplatformclientv2/api/routing_api.rb +829 -43
- data/lib/purecloudplatformclientv2/api_client.rb +1 -1
- data/lib/purecloudplatformclientv2/models/additional_message.rb +207 -0
- data/lib/purecloudplatformclientv2/models/aggregate_metric_data.rb +2 -2
- data/lib/purecloudplatformclientv2/models/analytics_participant.rb +41 -1
- data/lib/purecloudplatformclientv2/models/analytics_query_predicate.rb +4 -4
- data/lib/purecloudplatformclientv2/models/attachment.rb +5 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_attachment.rb +326 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_draft_attachments.rb +326 -0
- data/lib/purecloudplatformclientv2/models/conversation_notification_email.rb +28 -1
- data/lib/purecloudplatformclientv2/models/conversation_notification_emails.rb +28 -1
- data/lib/purecloudplatformclientv2/models/data_table.rb +306 -0
- data/lib/purecloudplatformclientv2/models/data_table_row_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/data_tables_domain_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_edge_software_version_dto.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_create.rb +12 -12
- data/lib/purecloudplatformclientv2/models/domain_organization_role_update.rb +12 -12
- data/lib/purecloudplatformclientv2/models/email.rb +32 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_attachment.rb +326 -0
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_email_media_participant.rb +31 -4
- data/lib/purecloudplatformclientv2/models/email_conversation_notification_participants.rb +31 -4
- data/lib/purecloudplatformclientv2/models/email_media_participant.rb +32 -4
- data/lib/purecloudplatformclientv2/models/fax_document.rb +12 -12
- data/lib/purecloudplatformclientv2/models/json_node.rb +72 -72
- data/lib/purecloudplatformclientv2/models/message_conversation.rb +309 -0
- data/lib/purecloudplatformclientv2/models/message_conversation_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/message_data.rb +572 -0
- data/lib/purecloudplatformclientv2/models/message_media_participant.rb +1068 -0
- data/lib/purecloudplatformclientv2/models/question.rb +13 -13
- data/lib/purecloudplatformclientv2/models/recipient.rb +383 -0
- data/lib/purecloudplatformclientv2/models/recipient_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/sms_address_provision.rb +440 -0
- data/lib/purecloudplatformclientv2/models/sms_available_phone_number.rb +465 -0
- data/lib/purecloudplatformclientv2/models/sms_available_phone_number_entity_listing.rb +203 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number.rb +546 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_entity_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/models/sms_phone_number_provision.rb +360 -0
- data/lib/purecloudplatformclientv2/models/text_message_listing.rb +428 -0
- data/lib/purecloudplatformclientv2/version.rb +1 -1
- metadata +42 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b655072af7039e6971af758cb675920b3043dc20
|
|
4
|
+
data.tar.gz: 99c3d085b809cc9fca32291748a1cc5e336d768d
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: f0127d81efc394d62e36abb0375e906f12662711fd9ce6a3bfa0931a52857d23497bf73982d2204489bac147f0e84cd5da0ac26e9b46411bbbf04f8071f1f2c6
|
|
7
|
+
data.tar.gz: ac90c4a35da69f5872fbd07cb161a0fa026595b03770492a0b8ad816216d8b67f619582c2d33cdcae015980d8778cfd9a5444a71b7562770193e8eab680295f7
|
data/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: PureCloud Ruby Gem
|
|
3
3
|
---
|
|
4
|
-
|
|
5
5
|
|
|
6
6
|
Documentation can be found at [https://developer.mypurecloud.com/api/rest/client-libraries/ruby/](https://developer.mypurecloud.com/api/rest/client-libraries/ruby/)
|
|
7
7
|
|
|
@@ -10,7 +10,7 @@ Documentation can be found at [https://developer.mypurecloud.com/api/rest/client
|
|
|
10
10
|
### from rubygems.org
|
|
11
11
|
|
|
12
12
|
~~~ ruby
|
|
13
|
-
gem install 'purecloudplatformclientv2', '~>
|
|
13
|
+
gem install 'purecloudplatformclientv2', '~> 28.0.0'
|
|
14
14
|
~~~
|
|
15
15
|
|
|
16
16
|
### Install from Git
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: AdditionalMessage
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::AdditionalMessage
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **text_body** | **String** | The body of the text message. | |
|
|
11
|
+
{: class="table table-striped"}
|
|
12
|
+
|
|
13
|
+
|
|
@@ -13,6 +13,7 @@ title: AnalyticsParticipant
|
|
|
13
13
|
| **purpose** | **String** | The participant's purpose | [optional] |
|
|
14
14
|
| **external_contact_id** | **String** | External Contact Identifier | [optional] |
|
|
15
15
|
| **external_organization_id** | **String** | External Organization Identifier | [optional] |
|
|
16
|
+
| **flagged_reason** | **String** | Reason for which participant flagged conversation | [optional] |
|
|
16
17
|
| **sessions** | [**Array<AnalyticsSession>**](AnalyticsSession.html) | List of sessions associated to this participant | [optional] |
|
|
17
18
|
{: class="table table-striped"}
|
|
18
19
|
|
data/docs/ArchitectApi.md
CHANGED
|
@@ -51,7 +51,7 @@ Method | Description
|
|
|
51
51
|
[**get_flow_version_configuration**](ArchitectApi.html#get_flow_version_configuration) | Create flow version configuration
|
|
52
52
|
[**get_flow_versions**](ArchitectApi.html#get_flow_versions) | Get flow version list
|
|
53
53
|
[**get_flows**](ArchitectApi.html#get_flows) | Get a pageable list of flows, filtered by query parameters
|
|
54
|
-
[**get_flows_datatable**](ArchitectApi.html#get_flows_datatable) | Returns a specific datatable by
|
|
54
|
+
[**get_flows_datatable**](ArchitectApi.html#get_flows_datatable) | Returns a specific datatable by id
|
|
55
55
|
[**get_flows_datatable_row**](ArchitectApi.html#get_flows_datatable_row) | Returns a specific row for the datatable
|
|
56
56
|
[**get_flows_datatable_rows**](ArchitectApi.html#get_flows_datatable_rows) | Returns the rows for the datatable
|
|
57
57
|
[**get_flows_datatables**](ArchitectApi.html#get_flows_datatables) | Retrieve a list of datatables for the org
|
|
@@ -81,7 +81,7 @@ Method | Description
|
|
|
81
81
|
[**put_architect_schedulegroup**](ArchitectApi.html#put_architect_schedulegroup) | Updates a schedule group by ID
|
|
82
82
|
[**put_architect_systemprompt_resource**](ArchitectApi.html#put_architect_systemprompt_resource) | Updates a system prompt resource override.
|
|
83
83
|
[**put_flow**](ArchitectApi.html#put_flow) | Update flow
|
|
84
|
-
[**put_flows_datatable**](ArchitectApi.html#put_flows_datatable) | Updates a specific datatable by
|
|
84
|
+
[**put_flows_datatable**](ArchitectApi.html#put_flows_datatable) | Updates a specific datatable by id
|
|
85
85
|
[**put_flows_datatable_row**](ArchitectApi.html#put_flows_datatable_row) | Update a row entry
|
|
86
86
|
{: class="table table-striped"}
|
|
87
87
|
|
|
@@ -625,7 +625,7 @@ Name | Type | Description | Notes
|
|
|
625
625
|
|
|
626
626
|
deletes a specific datatable by id
|
|
627
627
|
|
|
628
|
-
deletes an entire datatable (including schema and data) with a given
|
|
628
|
+
deletes an entire datatable (including schema and data) with a given id)
|
|
629
629
|
|
|
630
630
|
Wraps DELETE /api/v2/flows/datatables/{datatableId}
|
|
631
631
|
|
|
@@ -2880,9 +2880,9 @@ Name | Type | Description | Notes
|
|
|
2880
2880
|
|
|
2881
2881
|
<a name="get_flows_datatable"></a>
|
|
2882
2882
|
|
|
2883
|
-
## -[**
|
|
2883
|
+
## -[**DataTable**](DataTable.html) get_flows_datatable(datatable_id, opts)
|
|
2884
2884
|
|
|
2885
|
-
Returns a specific datatable by
|
|
2885
|
+
Returns a specific datatable by id
|
|
2886
2886
|
|
|
2887
2887
|
Given a datableid returns the schema associated with it.
|
|
2888
2888
|
|
|
@@ -2909,11 +2909,11 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
2909
2909
|
datatable_id = "datatable_id_example" # String | id of datatable
|
|
2910
2910
|
|
|
2911
2911
|
opts = {
|
|
2912
|
-
|
|
2912
|
+
expand: "expand_example" # String | Expand instructions for the result
|
|
2913
2913
|
}
|
|
2914
2914
|
|
|
2915
2915
|
begin
|
|
2916
|
-
#Returns a specific datatable by
|
|
2916
|
+
#Returns a specific datatable by id
|
|
2917
2917
|
result = api_instance.get_flows_datatable(datatable_id, opts)
|
|
2918
2918
|
p result
|
|
2919
2919
|
rescue PureCloud::ApiError => e
|
|
@@ -2926,13 +2926,13 @@ end
|
|
|
2926
2926
|
Name | Type | Description | Notes
|
|
2927
2927
|
------------- | ------------- | ------------- | -------------
|
|
2928
2928
|
**datatable_id** | **String**| id of datatable | |
|
|
2929
|
-
**
|
|
2929
|
+
**expand** | **String**| Expand instructions for the result | [optional] <br />**Values**: schema |
|
|
2930
2930
|
{: class="table table-striped"}
|
|
2931
2931
|
|
|
2932
2932
|
|
|
2933
2933
|
### Return type
|
|
2934
2934
|
|
|
2935
|
-
[**
|
|
2935
|
+
[**DataTable**](DataTable.html)
|
|
2936
2936
|
|
|
2937
2937
|
### HTTP request headers
|
|
2938
2938
|
|
|
@@ -3009,7 +3009,7 @@ Name | Type | Description | Notes
|
|
|
3009
3009
|
|
|
3010
3010
|
<a name="get_flows_datatable_rows"></a>
|
|
3011
3011
|
|
|
3012
|
-
## -
|
|
3012
|
+
## -[**DataTableRowEntityListing**](DataTableRowEntityListing.html) get_flows_datatable_rows(datatable_id, opts)
|
|
3013
3013
|
|
|
3014
3014
|
Returns the rows for the datatable
|
|
3015
3015
|
|
|
@@ -3038,6 +3038,8 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
3038
3038
|
datatable_id = "datatable_id_example" # String | id of datatable
|
|
3039
3039
|
|
|
3040
3040
|
opts = {
|
|
3041
|
+
page_size: 25, # Integer | Page size
|
|
3042
|
+
page_number: 1, # Integer | Page number
|
|
3041
3043
|
showbrief: true # BOOLEAN | If true returns just the key value of the row
|
|
3042
3044
|
}
|
|
3043
3045
|
|
|
@@ -3055,13 +3057,15 @@ end
|
|
|
3055
3057
|
Name | Type | Description | Notes
|
|
3056
3058
|
------------- | ------------- | ------------- | -------------
|
|
3057
3059
|
**datatable_id** | **String**| id of datatable | |
|
|
3060
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
3061
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3058
3062
|
**showbrief** | **BOOLEAN**| If true returns just the key value of the row | [optional] [default to true] |
|
|
3059
3063
|
{: class="table table-striped"}
|
|
3060
3064
|
|
|
3061
3065
|
|
|
3062
3066
|
### Return type
|
|
3063
3067
|
|
|
3064
|
-
**
|
|
3068
|
+
[**DataTableRowEntityListing**](DataTableRowEntityListing.html)
|
|
3065
3069
|
|
|
3066
3070
|
### HTTP request headers
|
|
3067
3071
|
|
|
@@ -3072,7 +3076,7 @@ Name | Type | Description | Notes
|
|
|
3072
3076
|
|
|
3073
3077
|
<a name="get_flows_datatables"></a>
|
|
3074
3078
|
|
|
3075
|
-
## -[**
|
|
3079
|
+
## -[**DataTablesDomainEntityListing**](DataTablesDomainEntityListing.html) get_flows_datatables(opts)
|
|
3076
3080
|
|
|
3077
3081
|
Retrieve a list of datatables for the org
|
|
3078
3082
|
|
|
@@ -3099,7 +3103,11 @@ end
|
|
|
3099
3103
|
api_instance = PureCloud::ArchitectApi.new
|
|
3100
3104
|
|
|
3101
3105
|
opts = {
|
|
3102
|
-
|
|
3106
|
+
expand: "expand_example", # String | Expand instructions for the result
|
|
3107
|
+
page_size: 25, # Integer | Page size
|
|
3108
|
+
page_number: 1, # Integer | Page number
|
|
3109
|
+
sort_by: "id", # String | Sort by
|
|
3110
|
+
sort_order: "ascending" # String | Sort order
|
|
3103
3111
|
}
|
|
3104
3112
|
|
|
3105
3113
|
begin
|
|
@@ -3115,13 +3123,17 @@ end
|
|
|
3115
3123
|
|
|
3116
3124
|
Name | Type | Description | Notes
|
|
3117
3125
|
------------- | ------------- | ------------- | -------------
|
|
3118
|
-
**
|
|
3126
|
+
**expand** | **String**| Expand instructions for the result | [optional] <br />**Values**: schema |
|
|
3127
|
+
**page_size** | **Integer**| Page size | [optional] [default to 25] |
|
|
3128
|
+
**page_number** | **Integer**| Page number | [optional] [default to 1] |
|
|
3129
|
+
**sort_by** | **String**| Sort by | [optional] [default to id]<br />**Values**: id, name |
|
|
3130
|
+
**sort_order** | **String**| Sort order | [optional] [default to ascending]<br />**Values**: ascending, descending |
|
|
3119
3131
|
{: class="table table-striped"}
|
|
3120
3132
|
|
|
3121
3133
|
|
|
3122
3134
|
### Return type
|
|
3123
3135
|
|
|
3124
|
-
[**
|
|
3136
|
+
[**DataTablesDomainEntityListing**](DataTablesDomainEntityListing.html)
|
|
3125
3137
|
|
|
3126
3138
|
### HTTP request headers
|
|
3127
3139
|
|
|
@@ -4211,7 +4223,7 @@ Name | Type | Description | Notes
|
|
|
4211
4223
|
|
|
4212
4224
|
<a name="post_flows_datatables"></a>
|
|
4213
4225
|
|
|
4214
|
-
## -[**
|
|
4226
|
+
## -[**DataTable**](DataTable.html) post_flows_datatables(body)
|
|
4215
4227
|
|
|
4216
4228
|
Create a new datatable with the specified json-schema definition
|
|
4217
4229
|
|
|
@@ -4237,7 +4249,7 @@ end
|
|
|
4237
4249
|
|
|
4238
4250
|
api_instance = PureCloud::ArchitectApi.new
|
|
4239
4251
|
|
|
4240
|
-
body = PureCloud::
|
|
4252
|
+
body = PureCloud::DataTable.new # DataTable | datatable json-schema
|
|
4241
4253
|
|
|
4242
4254
|
|
|
4243
4255
|
begin
|
|
@@ -4253,13 +4265,13 @@ end
|
|
|
4253
4265
|
|
|
4254
4266
|
Name | Type | Description | Notes
|
|
4255
4267
|
------------- | ------------- | ------------- | -------------
|
|
4256
|
-
**body** | [**
|
|
4268
|
+
**body** | [**DataTable**](DataTable.html)| datatable json-schema | |
|
|
4257
4269
|
{: class="table table-striped"}
|
|
4258
4270
|
|
|
4259
4271
|
|
|
4260
4272
|
### Return type
|
|
4261
4273
|
|
|
4262
|
-
[**
|
|
4274
|
+
[**DataTable**](DataTable.html)
|
|
4263
4275
|
|
|
4264
4276
|
### HTTP request headers
|
|
4265
4277
|
|
|
@@ -4717,11 +4729,11 @@ Name | Type | Description | Notes
|
|
|
4717
4729
|
|
|
4718
4730
|
<a name="put_flows_datatable"></a>
|
|
4719
4731
|
|
|
4720
|
-
## -[**
|
|
4732
|
+
## -[**DataTable**](DataTable.html) put_flows_datatable(datatable_id, opts)
|
|
4721
4733
|
|
|
4722
|
-
Updates a specific datatable by
|
|
4734
|
+
Updates a specific datatable by id
|
|
4723
4735
|
|
|
4724
|
-
Updates a schema for a datatable with the given
|
|
4736
|
+
Updates a schema for a datatable with the given id - updates are additive only, no changes or removals of existing fields.
|
|
4725
4737
|
|
|
4726
4738
|
Wraps PUT /api/v2/flows/datatables/{datatableId}
|
|
4727
4739
|
|
|
@@ -4746,12 +4758,12 @@ api_instance = PureCloud::ArchitectApi.new
|
|
|
4746
4758
|
datatable_id = "datatable_id_example" # String | id of datatable
|
|
4747
4759
|
|
|
4748
4760
|
opts = {
|
|
4749
|
-
|
|
4750
|
-
body: PureCloud::
|
|
4761
|
+
expand: "expand_example", # String | Expand instructions for the result
|
|
4762
|
+
body: PureCloud::DataTable.new # DataTable | datatable json-schema
|
|
4751
4763
|
}
|
|
4752
4764
|
|
|
4753
4765
|
begin
|
|
4754
|
-
#Updates a specific datatable by
|
|
4766
|
+
#Updates a specific datatable by id
|
|
4755
4767
|
result = api_instance.put_flows_datatable(datatable_id, opts)
|
|
4756
4768
|
p result
|
|
4757
4769
|
rescue PureCloud::ApiError => e
|
|
@@ -4764,14 +4776,14 @@ end
|
|
|
4764
4776
|
Name | Type | Description | Notes
|
|
4765
4777
|
------------- | ------------- | ------------- | -------------
|
|
4766
4778
|
**datatable_id** | **String**| id of datatable | |
|
|
4767
|
-
**
|
|
4768
|
-
**body** | [**
|
|
4779
|
+
**expand** | **String**| Expand instructions for the result | [optional] <br />**Values**: schema |
|
|
4780
|
+
**body** | [**DataTable**](DataTable.html)| datatable json-schema | [optional] |
|
|
4769
4781
|
{: class="table table-striped"}
|
|
4770
4782
|
|
|
4771
4783
|
|
|
4772
4784
|
### Return type
|
|
4773
4785
|
|
|
4774
|
-
[**
|
|
4786
|
+
[**DataTable**](DataTable.html)
|
|
4775
4787
|
|
|
4776
4788
|
### HTTP request headers
|
|
4777
4789
|
|
data/docs/Attachment.md
CHANGED
|
@@ -7,11 +7,11 @@ title: Attachment
|
|
|
7
7
|
|
|
8
8
|
|Name | Type | Description | Notes|
|
|
9
9
|
|------------ | ------------- | ------------- | -------------|
|
|
10
|
-
| **attachment_id** | **String** |
|
|
11
|
-
| **name** | **String** |
|
|
12
|
-
| **content_uri** | **String** |
|
|
13
|
-
| **content_type** | **String** |
|
|
14
|
-
| **content_length** | **Integer** |
|
|
10
|
+
| **attachment_id** | **String** | The unique identifier for the attachment. | [optional] |
|
|
11
|
+
| **name** | **String** | The name of the attachment. | [optional] |
|
|
12
|
+
| **content_uri** | **String** | The content uri of the attachment. If set, this is commonly a public api download location. | [optional] |
|
|
13
|
+
| **content_type** | **String** | The type of file the attachment is. | [optional] |
|
|
14
|
+
| **content_length** | **Integer** | The length of the attachment file. | [optional] |
|
|
15
15
|
{: class="table table-striped"}
|
|
16
16
|
|
|
17
17
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationAttachment
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationAttachment
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **attachment_id** | **String** | | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **content_uri** | **String** | | [optional] |
|
|
13
|
+
| **content_type** | **String** | | [optional] |
|
|
14
|
+
| **content_length** | **Integer** | | [optional] |
|
|
15
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: ConversationNotificationDraftAttachments
|
|
3
|
+
---
|
|
4
|
+
## PureCloud::ConversationNotificationDraftAttachments
|
|
5
|
+
|
|
6
|
+
## Properties
|
|
7
|
+
|
|
8
|
+
|Name | Type | Description | Notes|
|
|
9
|
+
|------------ | ------------- | ------------- | -------------|
|
|
10
|
+
| **attachment_id** | **String** | | [optional] |
|
|
11
|
+
| **name** | **String** | | [optional] |
|
|
12
|
+
| **content_uri** | **String** | | [optional] |
|
|
13
|
+
| **content_type** | **String** | | [optional] |
|
|
14
|
+
| **content_length** | **Integer** | | [optional] |
|
|
15
|
+
| **additional_properties** | **Object** | | [optional] |
|
|
16
|
+
{: class="table table-striped"}
|
|
17
|
+
|
|
18
|
+
|
|
@@ -23,6 +23,7 @@ title: ConversationNotificationEmail
|
|
|
23
23
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **message_id** | **String** | | [optional] |
|
|
25
25
|
| **direction** | **String** | | [optional] |
|
|
26
|
+
| **draft_attachments** | [**Array<ConversationNotificationDraftAttachments>**](ConversationNotificationDraftAttachments.html) | | [optional] |
|
|
26
27
|
| **additional_properties** | **Object** | | [optional] |
|
|
27
28
|
{: class="table table-striped"}
|
|
28
29
|
|
|
@@ -23,6 +23,7 @@ title: ConversationNotificationEmails
|
|
|
23
23
|
| **disconnected_time** | **DateTime** | | [optional] |
|
|
24
24
|
| **message_id** | **String** | | [optional] |
|
|
25
25
|
| **direction** | **String** | | [optional] |
|
|
26
|
+
| **draft_attachments** | [**Array<ConversationNotificationDraftAttachments>**](ConversationNotificationDraftAttachments.html) | | [optional] |
|
|
26
27
|
| **additional_properties** | **Object** | | [optional] |
|
|
27
28
|
{: class="table table-striped"}
|
|
28
29
|
|
data/docs/ConversationsApi.md
CHANGED
|
@@ -17,32 +17,37 @@ Method | Description
|
|
|
17
17
|
[**get_conversation_participant_secureivrsessions**](ConversationsApi.html#get_conversation_participant_secureivrsessions) | Get a list of secure sessions for this participant.
|
|
18
18
|
[**get_conversation_participant_wrapup**](ConversationsApi.html#get_conversation_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
19
19
|
[**get_conversation_participant_wrapupcodes**](ConversationsApi.html#get_conversation_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
20
|
-
[**get_conversations**](ConversationsApi.html#get_conversations) | Get conversations
|
|
20
|
+
[**get_conversations**](ConversationsApi.html#get_conversations) | Get active conversations for the logged in user
|
|
21
21
|
[**get_conversations_call**](ConversationsApi.html#get_conversations_call) | Get call conversation
|
|
22
22
|
[**get_conversations_call_participant_wrapup**](ConversationsApi.html#get_conversations_call_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
23
23
|
[**get_conversations_call_participant_wrapupcodes**](ConversationsApi.html#get_conversations_call_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
24
24
|
[**get_conversations_callback**](ConversationsApi.html#get_conversations_callback) | Get callback conversation
|
|
25
25
|
[**get_conversations_callback_participant_wrapup**](ConversationsApi.html#get_conversations_callback_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
26
26
|
[**get_conversations_callback_participant_wrapupcodes**](ConversationsApi.html#get_conversations_callback_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
27
|
-
[**get_conversations_callbacks**](ConversationsApi.html#get_conversations_callbacks) | Get callback conversations
|
|
28
|
-
[**get_conversations_calls**](ConversationsApi.html#get_conversations_calls) | Get
|
|
27
|
+
[**get_conversations_callbacks**](ConversationsApi.html#get_conversations_callbacks) | Get active callback conversations for the logged in user
|
|
28
|
+
[**get_conversations_calls**](ConversationsApi.html#get_conversations_calls) | Get active call conversations for the logged in user
|
|
29
29
|
[**get_conversations_calls_history**](ConversationsApi.html#get_conversations_calls_history) | Get call history
|
|
30
30
|
[**get_conversations_calls_maximumconferenceparties**](ConversationsApi.html#get_conversations_calls_maximumconferenceparties) | Get the maximum number of participants that this user can have on a conference
|
|
31
31
|
[**get_conversations_chat**](ConversationsApi.html#get_conversations_chat) | Get chat conversation
|
|
32
32
|
[**get_conversations_chat_participant_wrapup**](ConversationsApi.html#get_conversations_chat_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
33
33
|
[**get_conversations_chat_participant_wrapupcodes**](ConversationsApi.html#get_conversations_chat_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
34
|
-
[**get_conversations_chats**](ConversationsApi.html#get_conversations_chats) | Get
|
|
34
|
+
[**get_conversations_chats**](ConversationsApi.html#get_conversations_chats) | Get active chat conversations for the logged in user
|
|
35
35
|
[**get_conversations_cobrowsesession**](ConversationsApi.html#get_conversations_cobrowsesession) | Get cobrowse conversation
|
|
36
36
|
[**get_conversations_cobrowsesession_participant_wrapup**](ConversationsApi.html#get_conversations_cobrowsesession_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
37
37
|
[**get_conversations_cobrowsesession_participant_wrapupcodes**](ConversationsApi.html#get_conversations_cobrowsesession_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
38
|
-
[**get_conversations_cobrowsesessions**](ConversationsApi.html#get_conversations_cobrowsesessions) | Get
|
|
38
|
+
[**get_conversations_cobrowsesessions**](ConversationsApi.html#get_conversations_cobrowsesessions) | Get active cobrowse conversations for the logged in user
|
|
39
39
|
[**get_conversations_email**](ConversationsApi.html#get_conversations_email) | Get email conversation
|
|
40
40
|
[**get_conversations_email_message**](ConversationsApi.html#get_conversations_email_message) | Get conversation message
|
|
41
41
|
[**get_conversations_email_messages**](ConversationsApi.html#get_conversations_email_messages) | Get conversation messages
|
|
42
42
|
[**get_conversations_email_messages_draft**](ConversationsApi.html#get_conversations_email_messages_draft) | Get conversation draft reply
|
|
43
43
|
[**get_conversations_email_participant_wrapup**](ConversationsApi.html#get_conversations_email_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
44
44
|
[**get_conversations_email_participant_wrapupcodes**](ConversationsApi.html#get_conversations_email_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
45
|
-
[**get_conversations_emails**](ConversationsApi.html#get_conversations_emails) | Get
|
|
45
|
+
[**get_conversations_emails**](ConversationsApi.html#get_conversations_emails) | Get active email conversations for the logged in user
|
|
46
|
+
[**get_conversations_message**](ConversationsApi.html#get_conversations_message) | Get message conversation
|
|
47
|
+
[**get_conversations_message_message**](ConversationsApi.html#get_conversations_message_message) | Get message
|
|
48
|
+
[**get_conversations_message_participant_wrapup**](ConversationsApi.html#get_conversations_message_participant_wrapup) | Get the wrap-up for this conversation participant.
|
|
49
|
+
[**get_conversations_message_participant_wrapupcodes**](ConversationsApi.html#get_conversations_message_participant_wrapupcodes) | Get list of wrapup codes for this conversation participant
|
|
50
|
+
[**get_conversations_messages**](ConversationsApi.html#get_conversations_messages) | Get active message conversations for the logged in user
|
|
46
51
|
[**patch_conversation_participant**](ConversationsApi.html#patch_conversation_participant) | Update a participant.
|
|
47
52
|
[**patch_conversation_participant_attributes**](ConversationsApi.html#patch_conversation_participant_attributes) | Update the attributes on a conversation participant.
|
|
48
53
|
[**patch_conversations_call**](ConversationsApi.html#patch_conversations_call) | Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
@@ -66,6 +71,10 @@ Method | Description
|
|
|
66
71
|
[**patch_conversations_email_participant**](ConversationsApi.html#patch_conversations_email_participant) | Update conversation participant
|
|
67
72
|
[**patch_conversations_email_participant_attributes**](ConversationsApi.html#patch_conversations_email_participant_attributes) | Update the attributes on a conversation participant.
|
|
68
73
|
[**patch_conversations_email_participant_communication**](ConversationsApi.html#patch_conversations_email_participant_communication) | Update conversation participant's communication by disconnecting it.
|
|
74
|
+
[**patch_conversations_message**](ConversationsApi.html#patch_conversations_message) | Update a conversation by disconnecting all of the participants
|
|
75
|
+
[**patch_conversations_message_participant**](ConversationsApi.html#patch_conversations_message_participant) | Update conversation participant
|
|
76
|
+
[**patch_conversations_message_participant_attributes**](ConversationsApi.html#patch_conversations_message_participant_attributes) | Update the attributes on a conversation participant.
|
|
77
|
+
[**patch_conversations_message_participant_communication**](ConversationsApi.html#patch_conversations_message_participant_communication) | Update conversation participant's communication by disconnecting it.
|
|
69
78
|
[**post_analytics_conversation_details_properties**](ConversationsApi.html#post_analytics_conversation_details_properties) | Index conversation properties
|
|
70
79
|
[**post_analytics_conversations_aggregates_query**](ConversationsApi.html#post_analytics_conversations_aggregates_query) | Query for conversation aggregates
|
|
71
80
|
[**post_analytics_conversations_details_query**](ConversationsApi.html#post_analytics_conversations_details_query) | Query for conversation details
|
|
@@ -89,6 +98,9 @@ Method | Description
|
|
|
89
98
|
[**post_conversations_email_participant_replace**](ConversationsApi.html#post_conversations_email_participant_replace) | Replace this participant with the specified user and/or address
|
|
90
99
|
[**post_conversations_emails**](ConversationsApi.html#post_conversations_emails) | Create an email conversation
|
|
91
100
|
[**post_conversations_faxes**](ConversationsApi.html#post_conversations_faxes) | Create Fax Conversation
|
|
101
|
+
[**post_conversations_message_communication_messages**](ConversationsApi.html#post_conversations_message_communication_messages) | Send message
|
|
102
|
+
[**post_conversations_message_messages_bulk**](ConversationsApi.html#post_conversations_message_messages_bulk) | Get messages in batch
|
|
103
|
+
[**post_conversations_message_participant_replace**](ConversationsApi.html#post_conversations_message_participant_replace) | Replace this participant with the specified user and/or address
|
|
92
104
|
[**put_conversations_call_participant_communication_uuidata**](ConversationsApi.html#put_conversations_call_participant_communication_uuidata) | Set uuiData to be sent on future commands.
|
|
93
105
|
[**put_conversations_email_messages_draft**](ConversationsApi.html#put_conversations_email_messages_draft) | Update conversation draft reply
|
|
94
106
|
{: class="table table-striped"}
|
|
@@ -656,7 +668,7 @@ Name | Type | Description | Notes
|
|
|
656
668
|
|
|
657
669
|
## -[**ConversationEntityListing**](ConversationEntityListing.html) get_conversations(opts)
|
|
658
670
|
|
|
659
|
-
Get conversations
|
|
671
|
+
Get active conversations for the logged in user
|
|
660
672
|
|
|
661
673
|
|
|
662
674
|
|
|
@@ -685,7 +697,7 @@ opts = {
|
|
|
685
697
|
}
|
|
686
698
|
|
|
687
699
|
begin
|
|
688
|
-
#Get conversations
|
|
700
|
+
#Get active conversations for the logged in user
|
|
689
701
|
result = api_instance.get_conversations(opts)
|
|
690
702
|
p result
|
|
691
703
|
rescue PureCloud::ApiError => e
|
|
@@ -1090,7 +1102,7 @@ Name | Type | Description | Notes
|
|
|
1090
1102
|
|
|
1091
1103
|
## -[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html) get_conversations_callbacks
|
|
1092
1104
|
|
|
1093
|
-
Get callback conversations
|
|
1105
|
+
Get active callback conversations for the logged in user
|
|
1094
1106
|
|
|
1095
1107
|
|
|
1096
1108
|
|
|
@@ -1115,7 +1127,7 @@ end
|
|
|
1115
1127
|
api_instance = PureCloud::ConversationsApi.new
|
|
1116
1128
|
|
|
1117
1129
|
begin
|
|
1118
|
-
#Get callback conversations
|
|
1130
|
+
#Get active callback conversations for the logged in user
|
|
1119
1131
|
result = api_instance.get_conversations_callbacks
|
|
1120
1132
|
p result
|
|
1121
1133
|
rescue PureCloud::ApiError => e
|
|
@@ -1143,7 +1155,7 @@ This endpoint does not need any parameter.
|
|
|
1143
1155
|
|
|
1144
1156
|
## -[**CallConversationEntityListing**](CallConversationEntityListing.html) get_conversations_calls
|
|
1145
1157
|
|
|
1146
|
-
Get
|
|
1158
|
+
Get active call conversations for the logged in user
|
|
1147
1159
|
|
|
1148
1160
|
|
|
1149
1161
|
|
|
@@ -1168,7 +1180,7 @@ end
|
|
|
1168
1180
|
api_instance = PureCloud::ConversationsApi.new
|
|
1169
1181
|
|
|
1170
1182
|
begin
|
|
1171
|
-
#Get
|
|
1183
|
+
#Get active call conversations for the logged in user
|
|
1172
1184
|
result = api_instance.get_conversations_calls
|
|
1173
1185
|
p result
|
|
1174
1186
|
rescue PureCloud::ApiError => e
|
|
@@ -1502,7 +1514,7 @@ Name | Type | Description | Notes
|
|
|
1502
1514
|
|
|
1503
1515
|
## -[**ChatConversationEntityListing**](ChatConversationEntityListing.html) get_conversations_chats
|
|
1504
1516
|
|
|
1505
|
-
Get
|
|
1517
|
+
Get active chat conversations for the logged in user
|
|
1506
1518
|
|
|
1507
1519
|
|
|
1508
1520
|
|
|
@@ -1527,7 +1539,7 @@ end
|
|
|
1527
1539
|
api_instance = PureCloud::ConversationsApi.new
|
|
1528
1540
|
|
|
1529
1541
|
begin
|
|
1530
|
-
#Get
|
|
1542
|
+
#Get active chat conversations for the logged in user
|
|
1531
1543
|
result = api_instance.get_conversations_chats
|
|
1532
1544
|
p result
|
|
1533
1545
|
rescue PureCloud::ApiError => e
|
|
@@ -1742,7 +1754,7 @@ Name | Type | Description | Notes
|
|
|
1742
1754
|
|
|
1743
1755
|
## -[**CobrowseConversationEntityListing**](CobrowseConversationEntityListing.html) get_conversations_cobrowsesessions
|
|
1744
1756
|
|
|
1745
|
-
Get
|
|
1757
|
+
Get active cobrowse conversations for the logged in user
|
|
1746
1758
|
|
|
1747
1759
|
|
|
1748
1760
|
|
|
@@ -1767,7 +1779,7 @@ end
|
|
|
1767
1779
|
api_instance = PureCloud::ConversationsApi.new
|
|
1768
1780
|
|
|
1769
1781
|
begin
|
|
1770
|
-
#Get
|
|
1782
|
+
#Get active cobrowse conversations for the logged in user
|
|
1771
1783
|
result = api_instance.get_conversations_cobrowsesessions
|
|
1772
1784
|
p result
|
|
1773
1785
|
rescue PureCloud::ApiError => e
|
|
@@ -2162,7 +2174,7 @@ Name | Type | Description | Notes
|
|
|
2162
2174
|
|
|
2163
2175
|
## -[**EmailConversationEntityListing**](EmailConversationEntityListing.html) get_conversations_emails
|
|
2164
2176
|
|
|
2165
|
-
Get
|
|
2177
|
+
Get active email conversations for the logged in user
|
|
2166
2178
|
|
|
2167
2179
|
|
|
2168
2180
|
|
|
@@ -2187,7 +2199,7 @@ end
|
|
|
2187
2199
|
api_instance = PureCloud::ConversationsApi.new
|
|
2188
2200
|
|
|
2189
2201
|
begin
|
|
2190
|
-
#Get
|
|
2202
|
+
#Get active email conversations for the logged in user
|
|
2191
2203
|
result = api_instance.get_conversations_emails
|
|
2192
2204
|
p result
|
|
2193
2205
|
rescue PureCloud::ApiError => e
|
|
@@ -2211,6 +2223,308 @@ This endpoint does not need any parameter.
|
|
|
2211
2223
|
|
|
2212
2224
|
|
|
2213
2225
|
|
|
2226
|
+
<a name="get_conversations_message"></a>
|
|
2227
|
+
|
|
2228
|
+
## -[**MessageConversation**](MessageConversation.html) get_conversations_message(conversation_id)
|
|
2229
|
+
|
|
2230
|
+
Get message conversation
|
|
2231
|
+
|
|
2232
|
+
|
|
2233
|
+
|
|
2234
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}
|
|
2235
|
+
|
|
2236
|
+
|
|
2237
|
+
### Example
|
|
2238
|
+
~~~ruby
|
|
2239
|
+
# load the gem
|
|
2240
|
+
require 'purecloudplatformclientv2'
|
|
2241
|
+
# setup authorization
|
|
2242
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2243
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2244
|
+
environment = "mypurecloud.com"
|
|
2245
|
+
|
|
2246
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2247
|
+
|
|
2248
|
+
PureCloud.configure do |config|
|
|
2249
|
+
config.access_token = @authToken
|
|
2250
|
+
end
|
|
2251
|
+
|
|
2252
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2253
|
+
|
|
2254
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2255
|
+
|
|
2256
|
+
|
|
2257
|
+
begin
|
|
2258
|
+
#Get message conversation
|
|
2259
|
+
result = api_instance.get_conversations_message(conversation_id)
|
|
2260
|
+
p result
|
|
2261
|
+
rescue PureCloud::ApiError => e
|
|
2262
|
+
puts "Exception when calling ConversationsApi->get_conversations_message: #{e}"
|
|
2263
|
+
end
|
|
2264
|
+
~~~
|
|
2265
|
+
|
|
2266
|
+
### Parameters
|
|
2267
|
+
|
|
2268
|
+
Name | Type | Description | Notes
|
|
2269
|
+
------------- | ------------- | ------------- | -------------
|
|
2270
|
+
**conversation_id** | **String**| conversationId | |
|
|
2271
|
+
{: class="table table-striped"}
|
|
2272
|
+
|
|
2273
|
+
|
|
2274
|
+
### Return type
|
|
2275
|
+
|
|
2276
|
+
[**MessageConversation**](MessageConversation.html)
|
|
2277
|
+
|
|
2278
|
+
### HTTP request headers
|
|
2279
|
+
|
|
2280
|
+
- **Content-Type**: application/json
|
|
2281
|
+
- **Accept**: application/json
|
|
2282
|
+
|
|
2283
|
+
|
|
2284
|
+
|
|
2285
|
+
<a name="get_conversations_message_message"></a>
|
|
2286
|
+
|
|
2287
|
+
## -[**MessageData**](MessageData.html) get_conversations_message_message(conversation_id, message_id)
|
|
2288
|
+
|
|
2289
|
+
Get message
|
|
2290
|
+
|
|
2291
|
+
|
|
2292
|
+
|
|
2293
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}/messages/{messageId}
|
|
2294
|
+
|
|
2295
|
+
|
|
2296
|
+
### Example
|
|
2297
|
+
~~~ruby
|
|
2298
|
+
# load the gem
|
|
2299
|
+
require 'purecloudplatformclientv2'
|
|
2300
|
+
# setup authorization
|
|
2301
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2302
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2303
|
+
environment = "mypurecloud.com"
|
|
2304
|
+
|
|
2305
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2306
|
+
|
|
2307
|
+
PureCloud.configure do |config|
|
|
2308
|
+
config.access_token = @authToken
|
|
2309
|
+
end
|
|
2310
|
+
|
|
2311
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2312
|
+
|
|
2313
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2314
|
+
|
|
2315
|
+
message_id = "message_id_example" # String | messageId
|
|
2316
|
+
|
|
2317
|
+
|
|
2318
|
+
begin
|
|
2319
|
+
#Get message
|
|
2320
|
+
result = api_instance.get_conversations_message_message(conversation_id, message_id)
|
|
2321
|
+
p result
|
|
2322
|
+
rescue PureCloud::ApiError => e
|
|
2323
|
+
puts "Exception when calling ConversationsApi->get_conversations_message_message: #{e}"
|
|
2324
|
+
end
|
|
2325
|
+
~~~
|
|
2326
|
+
|
|
2327
|
+
### Parameters
|
|
2328
|
+
|
|
2329
|
+
Name | Type | Description | Notes
|
|
2330
|
+
------------- | ------------- | ------------- | -------------
|
|
2331
|
+
**conversation_id** | **String**| conversationId | |
|
|
2332
|
+
**message_id** | **String**| messageId | |
|
|
2333
|
+
{: class="table table-striped"}
|
|
2334
|
+
|
|
2335
|
+
|
|
2336
|
+
### Return type
|
|
2337
|
+
|
|
2338
|
+
[**MessageData**](MessageData.html)
|
|
2339
|
+
|
|
2340
|
+
### HTTP request headers
|
|
2341
|
+
|
|
2342
|
+
- **Content-Type**: application/json
|
|
2343
|
+
- **Accept**: application/json
|
|
2344
|
+
|
|
2345
|
+
|
|
2346
|
+
|
|
2347
|
+
<a name="get_conversations_message_participant_wrapup"></a>
|
|
2348
|
+
|
|
2349
|
+
## -[**Wrapup**](Wrapup.html) get_conversations_message_participant_wrapup(conversation_id, participant_id, opts)
|
|
2350
|
+
|
|
2351
|
+
Get the wrap-up for this conversation participant.
|
|
2352
|
+
|
|
2353
|
+
|
|
2354
|
+
|
|
2355
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapup
|
|
2356
|
+
|
|
2357
|
+
|
|
2358
|
+
### Example
|
|
2359
|
+
~~~ruby
|
|
2360
|
+
# load the gem
|
|
2361
|
+
require 'purecloudplatformclientv2'
|
|
2362
|
+
# setup authorization
|
|
2363
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2364
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2365
|
+
environment = "mypurecloud.com"
|
|
2366
|
+
|
|
2367
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2368
|
+
|
|
2369
|
+
PureCloud.configure do |config|
|
|
2370
|
+
config.access_token = @authToken
|
|
2371
|
+
end
|
|
2372
|
+
|
|
2373
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2374
|
+
|
|
2375
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2376
|
+
|
|
2377
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2378
|
+
|
|
2379
|
+
opts = {
|
|
2380
|
+
provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
|
|
2381
|
+
}
|
|
2382
|
+
|
|
2383
|
+
begin
|
|
2384
|
+
#Get the wrap-up for this conversation participant.
|
|
2385
|
+
result = api_instance.get_conversations_message_participant_wrapup(conversation_id, participant_id, opts)
|
|
2386
|
+
p result
|
|
2387
|
+
rescue PureCloud::ApiError => e
|
|
2388
|
+
puts "Exception when calling ConversationsApi->get_conversations_message_participant_wrapup: #{e}"
|
|
2389
|
+
end
|
|
2390
|
+
~~~
|
|
2391
|
+
|
|
2392
|
+
### Parameters
|
|
2393
|
+
|
|
2394
|
+
Name | Type | Description | Notes
|
|
2395
|
+
------------- | ------------- | ------------- | -------------
|
|
2396
|
+
**conversation_id** | **String**| conversationId | |
|
|
2397
|
+
**participant_id** | **String**| participantId | |
|
|
2398
|
+
**provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false] |
|
|
2399
|
+
{: class="table table-striped"}
|
|
2400
|
+
|
|
2401
|
+
|
|
2402
|
+
### Return type
|
|
2403
|
+
|
|
2404
|
+
[**Wrapup**](Wrapup.html)
|
|
2405
|
+
|
|
2406
|
+
### HTTP request headers
|
|
2407
|
+
|
|
2408
|
+
- **Content-Type**: application/json
|
|
2409
|
+
- **Accept**: application/json
|
|
2410
|
+
|
|
2411
|
+
|
|
2412
|
+
|
|
2413
|
+
<a name="get_conversations_message_participant_wrapupcodes"></a>
|
|
2414
|
+
|
|
2415
|
+
## -[**Array<WrapupCode>**](WrapupCode.html) get_conversations_message_participant_wrapupcodes(conversation_id, participant_id)
|
|
2416
|
+
|
|
2417
|
+
Get list of wrapup codes for this conversation participant
|
|
2418
|
+
|
|
2419
|
+
|
|
2420
|
+
|
|
2421
|
+
Wraps GET /api/v2/conversations/messages/{conversationId}/participants/{participantId}/wrapupcodes
|
|
2422
|
+
|
|
2423
|
+
|
|
2424
|
+
### Example
|
|
2425
|
+
~~~ruby
|
|
2426
|
+
# load the gem
|
|
2427
|
+
require 'purecloudplatformclientv2'
|
|
2428
|
+
# setup authorization
|
|
2429
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2430
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2431
|
+
environment = "mypurecloud.com"
|
|
2432
|
+
|
|
2433
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2434
|
+
|
|
2435
|
+
PureCloud.configure do |config|
|
|
2436
|
+
config.access_token = @authToken
|
|
2437
|
+
end
|
|
2438
|
+
|
|
2439
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2440
|
+
|
|
2441
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2442
|
+
|
|
2443
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2444
|
+
|
|
2445
|
+
|
|
2446
|
+
begin
|
|
2447
|
+
#Get list of wrapup codes for this conversation participant
|
|
2448
|
+
result = api_instance.get_conversations_message_participant_wrapupcodes(conversation_id, participant_id)
|
|
2449
|
+
p result
|
|
2450
|
+
rescue PureCloud::ApiError => e
|
|
2451
|
+
puts "Exception when calling ConversationsApi->get_conversations_message_participant_wrapupcodes: #{e}"
|
|
2452
|
+
end
|
|
2453
|
+
~~~
|
|
2454
|
+
|
|
2455
|
+
### Parameters
|
|
2456
|
+
|
|
2457
|
+
Name | Type | Description | Notes
|
|
2458
|
+
------------- | ------------- | ------------- | -------------
|
|
2459
|
+
**conversation_id** | **String**| conversationId | |
|
|
2460
|
+
**participant_id** | **String**| participantId | |
|
|
2461
|
+
{: class="table table-striped"}
|
|
2462
|
+
|
|
2463
|
+
|
|
2464
|
+
### Return type
|
|
2465
|
+
|
|
2466
|
+
[**Array<WrapupCode>**](WrapupCode.html)
|
|
2467
|
+
|
|
2468
|
+
### HTTP request headers
|
|
2469
|
+
|
|
2470
|
+
- **Content-Type**: application/json
|
|
2471
|
+
- **Accept**: application/json
|
|
2472
|
+
|
|
2473
|
+
|
|
2474
|
+
|
|
2475
|
+
<a name="get_conversations_messages"></a>
|
|
2476
|
+
|
|
2477
|
+
## -[**MessageConversationEntityListing**](MessageConversationEntityListing.html) get_conversations_messages
|
|
2478
|
+
|
|
2479
|
+
Get active message conversations for the logged in user
|
|
2480
|
+
|
|
2481
|
+
|
|
2482
|
+
|
|
2483
|
+
Wraps GET /api/v2/conversations/messages
|
|
2484
|
+
|
|
2485
|
+
|
|
2486
|
+
### Example
|
|
2487
|
+
~~~ruby
|
|
2488
|
+
# load the gem
|
|
2489
|
+
require 'purecloudplatformclientv2'
|
|
2490
|
+
# setup authorization
|
|
2491
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2492
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2493
|
+
environment = "mypurecloud.com"
|
|
2494
|
+
|
|
2495
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2496
|
+
|
|
2497
|
+
PureCloud.configure do |config|
|
|
2498
|
+
config.access_token = @authToken
|
|
2499
|
+
end
|
|
2500
|
+
|
|
2501
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2502
|
+
|
|
2503
|
+
begin
|
|
2504
|
+
#Get active message conversations for the logged in user
|
|
2505
|
+
result = api_instance.get_conversations_messages
|
|
2506
|
+
p result
|
|
2507
|
+
rescue PureCloud::ApiError => e
|
|
2508
|
+
puts "Exception when calling ConversationsApi->get_conversations_messages: #{e}"
|
|
2509
|
+
end
|
|
2510
|
+
~~~
|
|
2511
|
+
|
|
2512
|
+
### Parameters
|
|
2513
|
+
This endpoint does not need any parameter.
|
|
2514
|
+
{: class="table table-striped"}
|
|
2515
|
+
|
|
2516
|
+
|
|
2517
|
+
### Return type
|
|
2518
|
+
|
|
2519
|
+
[**MessageConversationEntityListing**](MessageConversationEntityListing.html)
|
|
2520
|
+
|
|
2521
|
+
### HTTP request headers
|
|
2522
|
+
|
|
2523
|
+
- **Content-Type**: application/json
|
|
2524
|
+
- **Accept**: application/json
|
|
2525
|
+
|
|
2526
|
+
|
|
2527
|
+
|
|
2214
2528
|
<a name="patch_conversation_participant"></a>
|
|
2215
2529
|
|
|
2216
2530
|
## - patch_conversation_participant(conversation_id, participant_id, body)
|
|
@@ -2275,15 +2589,269 @@ nil (empty response body)
|
|
|
2275
2589
|
|
|
2276
2590
|
|
|
2277
2591
|
|
|
2278
|
-
<a name="patch_conversation_participant_attributes"></a>
|
|
2592
|
+
<a name="patch_conversation_participant_attributes"></a>
|
|
2593
|
+
|
|
2594
|
+
## - patch_conversation_participant_attributes(conversation_id, participant_id, body)
|
|
2595
|
+
|
|
2596
|
+
Update the attributes on a conversation participant.
|
|
2597
|
+
|
|
2598
|
+
|
|
2599
|
+
|
|
2600
|
+
Wraps PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/attributes
|
|
2601
|
+
|
|
2602
|
+
|
|
2603
|
+
### Example
|
|
2604
|
+
~~~ruby
|
|
2605
|
+
# load the gem
|
|
2606
|
+
require 'purecloudplatformclientv2'
|
|
2607
|
+
# setup authorization
|
|
2608
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2609
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2610
|
+
environment = "mypurecloud.com"
|
|
2611
|
+
|
|
2612
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2613
|
+
|
|
2614
|
+
PureCloud.configure do |config|
|
|
2615
|
+
config.access_token = @authToken
|
|
2616
|
+
end
|
|
2617
|
+
|
|
2618
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2619
|
+
|
|
2620
|
+
conversation_id = "conversation_id_example" # String | conversation ID
|
|
2621
|
+
|
|
2622
|
+
participant_id = "participant_id_example" # String | participant ID
|
|
2623
|
+
|
|
2624
|
+
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
2625
|
+
|
|
2626
|
+
|
|
2627
|
+
begin
|
|
2628
|
+
#Update the attributes on a conversation participant.
|
|
2629
|
+
api_instance.patch_conversation_participant_attributes(conversation_id, participant_id, body)
|
|
2630
|
+
rescue PureCloud::ApiError => e
|
|
2631
|
+
puts "Exception when calling ConversationsApi->patch_conversation_participant_attributes: #{e}"
|
|
2632
|
+
end
|
|
2633
|
+
~~~
|
|
2634
|
+
|
|
2635
|
+
### Parameters
|
|
2636
|
+
|
|
2637
|
+
Name | Type | Description | Notes
|
|
2638
|
+
------------- | ------------- | ------------- | -------------
|
|
2639
|
+
**conversation_id** | **String**| conversation ID | |
|
|
2640
|
+
**participant_id** | **String**| participant ID | |
|
|
2641
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes | |
|
|
2642
|
+
{: class="table table-striped"}
|
|
2643
|
+
|
|
2644
|
+
|
|
2645
|
+
### Return type
|
|
2646
|
+
|
|
2647
|
+
nil (empty response body)
|
|
2648
|
+
|
|
2649
|
+
### HTTP request headers
|
|
2650
|
+
|
|
2651
|
+
- **Content-Type**: application/json
|
|
2652
|
+
- **Accept**: application/json
|
|
2653
|
+
|
|
2654
|
+
|
|
2655
|
+
|
|
2656
|
+
<a name="patch_conversations_call"></a>
|
|
2657
|
+
|
|
2658
|
+
## -[**Conversation**](Conversation.html) patch_conversations_call(conversation_id, body)
|
|
2659
|
+
|
|
2660
|
+
Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
2661
|
+
|
|
2662
|
+
|
|
2663
|
+
|
|
2664
|
+
Wraps PATCH /api/v2/conversations/calls/{conversationId}
|
|
2665
|
+
|
|
2666
|
+
|
|
2667
|
+
### Example
|
|
2668
|
+
~~~ruby
|
|
2669
|
+
# load the gem
|
|
2670
|
+
require 'purecloudplatformclientv2'
|
|
2671
|
+
# setup authorization
|
|
2672
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2673
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2674
|
+
environment = "mypurecloud.com"
|
|
2675
|
+
|
|
2676
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2677
|
+
|
|
2678
|
+
PureCloud.configure do |config|
|
|
2679
|
+
config.access_token = @authToken
|
|
2680
|
+
end
|
|
2681
|
+
|
|
2682
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2683
|
+
|
|
2684
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2685
|
+
|
|
2686
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2687
|
+
|
|
2688
|
+
|
|
2689
|
+
begin
|
|
2690
|
+
#Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
|
|
2691
|
+
result = api_instance.patch_conversations_call(conversation_id, body)
|
|
2692
|
+
p result
|
|
2693
|
+
rescue PureCloud::ApiError => e
|
|
2694
|
+
puts "Exception when calling ConversationsApi->patch_conversations_call: #{e}"
|
|
2695
|
+
end
|
|
2696
|
+
~~~
|
|
2697
|
+
|
|
2698
|
+
### Parameters
|
|
2699
|
+
|
|
2700
|
+
Name | Type | Description | Notes
|
|
2701
|
+
------------- | ------------- | ------------- | -------------
|
|
2702
|
+
**conversation_id** | **String**| conversationId | |
|
|
2703
|
+
**body** | [**Conversation**](Conversation.html)| Conversation | |
|
|
2704
|
+
{: class="table table-striped"}
|
|
2705
|
+
|
|
2706
|
+
|
|
2707
|
+
### Return type
|
|
2708
|
+
|
|
2709
|
+
[**Conversation**](Conversation.html)
|
|
2710
|
+
|
|
2711
|
+
### HTTP request headers
|
|
2712
|
+
|
|
2713
|
+
- **Content-Type**: application/json
|
|
2714
|
+
- **Accept**: application/json
|
|
2715
|
+
|
|
2716
|
+
|
|
2717
|
+
|
|
2718
|
+
<a name="patch_conversations_call_participant"></a>
|
|
2719
|
+
|
|
2720
|
+
## - patch_conversations_call_participant(conversation_id, participant_id, body)
|
|
2721
|
+
|
|
2722
|
+
Update conversation participant
|
|
2723
|
+
|
|
2724
|
+
|
|
2725
|
+
|
|
2726
|
+
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}
|
|
2727
|
+
|
|
2728
|
+
|
|
2729
|
+
### Example
|
|
2730
|
+
~~~ruby
|
|
2731
|
+
# load the gem
|
|
2732
|
+
require 'purecloudplatformclientv2'
|
|
2733
|
+
# setup authorization
|
|
2734
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2735
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2736
|
+
environment = "mypurecloud.com"
|
|
2737
|
+
|
|
2738
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2739
|
+
|
|
2740
|
+
PureCloud.configure do |config|
|
|
2741
|
+
config.access_token = @authToken
|
|
2742
|
+
end
|
|
2743
|
+
|
|
2744
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2745
|
+
|
|
2746
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2747
|
+
|
|
2748
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2749
|
+
|
|
2750
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant request
|
|
2751
|
+
|
|
2752
|
+
|
|
2753
|
+
begin
|
|
2754
|
+
#Update conversation participant
|
|
2755
|
+
api_instance.patch_conversations_call_participant(conversation_id, participant_id, body)
|
|
2756
|
+
rescue PureCloud::ApiError => e
|
|
2757
|
+
puts "Exception when calling ConversationsApi->patch_conversations_call_participant: #{e}"
|
|
2758
|
+
end
|
|
2759
|
+
~~~
|
|
2760
|
+
|
|
2761
|
+
### Parameters
|
|
2762
|
+
|
|
2763
|
+
Name | Type | Description | Notes
|
|
2764
|
+
------------- | ------------- | ------------- | -------------
|
|
2765
|
+
**conversation_id** | **String**| conversationId | |
|
|
2766
|
+
**participant_id** | **String**| participantId | |
|
|
2767
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant request | |
|
|
2768
|
+
{: class="table table-striped"}
|
|
2769
|
+
|
|
2770
|
+
|
|
2771
|
+
### Return type
|
|
2772
|
+
|
|
2773
|
+
nil (empty response body)
|
|
2774
|
+
|
|
2775
|
+
### HTTP request headers
|
|
2776
|
+
|
|
2777
|
+
- **Content-Type**: application/json
|
|
2778
|
+
- **Accept**: application/json
|
|
2779
|
+
|
|
2780
|
+
|
|
2781
|
+
|
|
2782
|
+
<a name="patch_conversations_call_participant_attributes"></a>
|
|
2783
|
+
|
|
2784
|
+
## - patch_conversations_call_participant_attributes(conversation_id, participant_id, body)
|
|
2785
|
+
|
|
2786
|
+
Update the attributes on a conversation participant.
|
|
2787
|
+
|
|
2788
|
+
|
|
2789
|
+
|
|
2790
|
+
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/attributes
|
|
2791
|
+
|
|
2792
|
+
|
|
2793
|
+
### Example
|
|
2794
|
+
~~~ruby
|
|
2795
|
+
# load the gem
|
|
2796
|
+
require 'purecloudplatformclientv2'
|
|
2797
|
+
# setup authorization
|
|
2798
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
2799
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
2800
|
+
environment = "mypurecloud.com"
|
|
2801
|
+
|
|
2802
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
2803
|
+
|
|
2804
|
+
PureCloud.configure do |config|
|
|
2805
|
+
config.access_token = @authToken
|
|
2806
|
+
end
|
|
2807
|
+
|
|
2808
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
2809
|
+
|
|
2810
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2811
|
+
|
|
2812
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2813
|
+
|
|
2814
|
+
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
2815
|
+
|
|
2816
|
+
|
|
2817
|
+
begin
|
|
2818
|
+
#Update the attributes on a conversation participant.
|
|
2819
|
+
api_instance.patch_conversations_call_participant_attributes(conversation_id, participant_id, body)
|
|
2820
|
+
rescue PureCloud::ApiError => e
|
|
2821
|
+
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_attributes: #{e}"
|
|
2822
|
+
end
|
|
2823
|
+
~~~
|
|
2824
|
+
|
|
2825
|
+
### Parameters
|
|
2826
|
+
|
|
2827
|
+
Name | Type | Description | Notes
|
|
2828
|
+
------------- | ------------- | ------------- | -------------
|
|
2829
|
+
**conversation_id** | **String**| conversationId | |
|
|
2830
|
+
**participant_id** | **String**| participantId | |
|
|
2831
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes | |
|
|
2832
|
+
{: class="table table-striped"}
|
|
2833
|
+
|
|
2834
|
+
|
|
2835
|
+
### Return type
|
|
2836
|
+
|
|
2837
|
+
nil (empty response body)
|
|
2838
|
+
|
|
2839
|
+
### HTTP request headers
|
|
2840
|
+
|
|
2841
|
+
- **Content-Type**: application/json
|
|
2842
|
+
- **Accept**: application/json
|
|
2843
|
+
|
|
2844
|
+
|
|
2845
|
+
|
|
2846
|
+
<a name="patch_conversations_call_participant_communication"></a>
|
|
2279
2847
|
|
|
2280
|
-
## -
|
|
2848
|
+
## -[**Empty**](Empty.html) patch_conversations_call_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2281
2849
|
|
|
2282
|
-
Update
|
|
2850
|
+
Update conversation participant's communication by disconnecting it.
|
|
2283
2851
|
|
|
2284
2852
|
|
|
2285
2853
|
|
|
2286
|
-
Wraps PATCH /api/v2/conversations/{conversationId}/participants/{participantId}/
|
|
2854
|
+
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
2287
2855
|
|
|
2288
2856
|
|
|
2289
2857
|
### Example
|
|
@@ -2303,18 +2871,21 @@ end
|
|
|
2303
2871
|
|
|
2304
2872
|
api_instance = PureCloud::ConversationsApi.new
|
|
2305
2873
|
|
|
2306
|
-
conversation_id = "conversation_id_example" # String |
|
|
2874
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
2307
2875
|
|
|
2308
|
-
participant_id = "participant_id_example" # String |
|
|
2876
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2309
2877
|
|
|
2310
|
-
|
|
2878
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
2879
|
+
|
|
2880
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
2311
2881
|
|
|
2312
2882
|
|
|
2313
2883
|
begin
|
|
2314
|
-
#Update
|
|
2315
|
-
api_instance.
|
|
2884
|
+
#Update conversation participant's communication by disconnecting it.
|
|
2885
|
+
result = api_instance.patch_conversations_call_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2886
|
+
p result
|
|
2316
2887
|
rescue PureCloud::ApiError => e
|
|
2317
|
-
puts "Exception when calling ConversationsApi->
|
|
2888
|
+
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_communication: #{e}"
|
|
2318
2889
|
end
|
|
2319
2890
|
~~~
|
|
2320
2891
|
|
|
@@ -2322,15 +2893,16 @@ end
|
|
|
2322
2893
|
|
|
2323
2894
|
Name | Type | Description | Notes
|
|
2324
2895
|
------------- | ------------- | ------------- | -------------
|
|
2325
|
-
**conversation_id** | **String**|
|
|
2326
|
-
**participant_id** | **String**|
|
|
2327
|
-
**
|
|
2896
|
+
**conversation_id** | **String**| conversationId | |
|
|
2897
|
+
**participant_id** | **String**| participantId | |
|
|
2898
|
+
**communication_id** | **String**| communicationId | |
|
|
2899
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant | |
|
|
2328
2900
|
{: class="table table-striped"}
|
|
2329
2901
|
|
|
2330
2902
|
|
|
2331
2903
|
### Return type
|
|
2332
2904
|
|
|
2333
|
-
|
|
2905
|
+
[**Empty**](Empty.html)
|
|
2334
2906
|
|
|
2335
2907
|
### HTTP request headers
|
|
2336
2908
|
|
|
@@ -2339,15 +2911,15 @@ nil (empty response body)
|
|
|
2339
2911
|
|
|
2340
2912
|
|
|
2341
2913
|
|
|
2342
|
-
<a name="
|
|
2914
|
+
<a name="patch_conversations_call_participant_consult"></a>
|
|
2343
2915
|
|
|
2344
|
-
## -[**
|
|
2916
|
+
## -[**ConsultTransferResponse**](ConsultTransferResponse.html) patch_conversations_call_participant_consult(conversation_id, participant_id, body)
|
|
2345
2917
|
|
|
2346
|
-
|
|
2918
|
+
Change who can speak
|
|
2347
2919
|
|
|
2348
2920
|
|
|
2349
2921
|
|
|
2350
|
-
Wraps PATCH /api/v2/conversations/calls/{conversationId}
|
|
2922
|
+
Wraps PATCH /api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult
|
|
2351
2923
|
|
|
2352
2924
|
|
|
2353
2925
|
### Example
|
|
@@ -2369,15 +2941,17 @@ api_instance = PureCloud::ConversationsApi.new
|
|
|
2369
2941
|
|
|
2370
2942
|
conversation_id = "conversation_id_example" # String | conversationId
|
|
2371
2943
|
|
|
2372
|
-
|
|
2944
|
+
participant_id = "participant_id_example" # String | participantId
|
|
2945
|
+
|
|
2946
|
+
body = PureCloud::ConsultTransferUpdate.new # ConsultTransferUpdate | new speak to
|
|
2373
2947
|
|
|
2374
2948
|
|
|
2375
2949
|
begin
|
|
2376
|
-
#
|
|
2377
|
-
result = api_instance.
|
|
2950
|
+
#Change who can speak
|
|
2951
|
+
result = api_instance.patch_conversations_call_participant_consult(conversation_id, participant_id, body)
|
|
2378
2952
|
p result
|
|
2379
2953
|
rescue PureCloud::ApiError => e
|
|
2380
|
-
puts "Exception when calling ConversationsApi->
|
|
2954
|
+
puts "Exception when calling ConversationsApi->patch_conversations_call_participant_consult: #{e}"
|
|
2381
2955
|
end
|
|
2382
2956
|
~~~
|
|
2383
2957
|
|
|
@@ -2386,13 +2960,14 @@ end
|
|
|
2386
2960
|
Name | Type | Description | Notes
|
|
2387
2961
|
------------- | ------------- | ------------- | -------------
|
|
2388
2962
|
**conversation_id** | **String**| conversationId | |
|
|
2389
|
-
**
|
|
2963
|
+
**participant_id** | **String**| participantId | |
|
|
2964
|
+
**body** | [**ConsultTransferUpdate**](ConsultTransferUpdate.html)| new speak to | |
|
|
2390
2965
|
{: class="table table-striped"}
|
|
2391
2966
|
|
|
2392
2967
|
|
|
2393
2968
|
### Return type
|
|
2394
2969
|
|
|
2395
|
-
[**
|
|
2970
|
+
[**ConsultTransferResponse**](ConsultTransferResponse.html)
|
|
2396
2971
|
|
|
2397
2972
|
### HTTP request headers
|
|
2398
2973
|
|
|
@@ -2401,15 +2976,15 @@ Name | Type | Description | Notes
|
|
|
2401
2976
|
|
|
2402
2977
|
|
|
2403
2978
|
|
|
2404
|
-
<a name="
|
|
2979
|
+
<a name="patch_conversations_callback"></a>
|
|
2405
2980
|
|
|
2406
|
-
## -
|
|
2981
|
+
## -[**Conversation**](Conversation.html) patch_conversations_callback(conversation_id, body)
|
|
2407
2982
|
|
|
2408
|
-
Update conversation
|
|
2983
|
+
Update a conversation by disconnecting all of the participants
|
|
2409
2984
|
|
|
2410
2985
|
|
|
2411
2986
|
|
|
2412
|
-
Wraps PATCH /api/v2/conversations/
|
|
2987
|
+
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}
|
|
2413
2988
|
|
|
2414
2989
|
|
|
2415
2990
|
### Example
|
|
@@ -2431,16 +3006,15 @@ api_instance = PureCloud::ConversationsApi.new
|
|
|
2431
3006
|
|
|
2432
3007
|
conversation_id = "conversation_id_example" # String | conversationId
|
|
2433
3008
|
|
|
2434
|
-
|
|
2435
|
-
|
|
2436
|
-
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant request
|
|
3009
|
+
body = PureCloud::Conversation.new # Conversation | Conversation
|
|
2437
3010
|
|
|
2438
3011
|
|
|
2439
3012
|
begin
|
|
2440
|
-
#Update conversation
|
|
2441
|
-
api_instance.
|
|
3013
|
+
#Update a conversation by disconnecting all of the participants
|
|
3014
|
+
result = api_instance.patch_conversations_callback(conversation_id, body)
|
|
3015
|
+
p result
|
|
2442
3016
|
rescue PureCloud::ApiError => e
|
|
2443
|
-
puts "Exception when calling ConversationsApi->
|
|
3017
|
+
puts "Exception when calling ConversationsApi->patch_conversations_callback: #{e}"
|
|
2444
3018
|
end
|
|
2445
3019
|
~~~
|
|
2446
3020
|
|
|
@@ -2449,14 +3023,13 @@ end
|
|
|
2449
3023
|
Name | Type | Description | Notes
|
|
2450
3024
|
------------- | ------------- | ------------- | -------------
|
|
2451
3025
|
**conversation_id** | **String**| conversationId | |
|
|
2452
|
-
**
|
|
2453
|
-
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant request | |
|
|
3026
|
+
**body** | [**Conversation**](Conversation.html)| Conversation | |
|
|
2454
3027
|
{: class="table table-striped"}
|
|
2455
3028
|
|
|
2456
3029
|
|
|
2457
3030
|
### Return type
|
|
2458
3031
|
|
|
2459
|
-
|
|
3032
|
+
[**Conversation**](Conversation.html)
|
|
2460
3033
|
|
|
2461
3034
|
### HTTP request headers
|
|
2462
3035
|
|
|
@@ -2465,15 +3038,15 @@ nil (empty response body)
|
|
|
2465
3038
|
|
|
2466
3039
|
|
|
2467
3040
|
|
|
2468
|
-
<a name="
|
|
3041
|
+
<a name="patch_conversations_callback_participant"></a>
|
|
2469
3042
|
|
|
2470
|
-
## -
|
|
3043
|
+
## - patch_conversations_callback_participant(conversation_id, participant_id, body)
|
|
2471
3044
|
|
|
2472
|
-
Update
|
|
3045
|
+
Update conversation participant
|
|
2473
3046
|
|
|
2474
3047
|
|
|
2475
3048
|
|
|
2476
|
-
Wraps PATCH /api/v2/conversations/
|
|
3049
|
+
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}
|
|
2477
3050
|
|
|
2478
3051
|
|
|
2479
3052
|
### Example
|
|
@@ -2497,14 +3070,14 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
2497
3070
|
|
|
2498
3071
|
participant_id = "participant_id_example" # String | participantId
|
|
2499
3072
|
|
|
2500
|
-
body = PureCloud::
|
|
3073
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
2501
3074
|
|
|
2502
3075
|
|
|
2503
3076
|
begin
|
|
2504
|
-
#Update
|
|
2505
|
-
api_instance.
|
|
3077
|
+
#Update conversation participant
|
|
3078
|
+
api_instance.patch_conversations_callback_participant(conversation_id, participant_id, body)
|
|
2506
3079
|
rescue PureCloud::ApiError => e
|
|
2507
|
-
puts "Exception when calling ConversationsApi->
|
|
3080
|
+
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant: #{e}"
|
|
2508
3081
|
end
|
|
2509
3082
|
~~~
|
|
2510
3083
|
|
|
@@ -2514,7 +3087,7 @@ Name | Type | Description | Notes
|
|
|
2514
3087
|
------------- | ------------- | ------------- | -------------
|
|
2515
3088
|
**conversation_id** | **String**| conversationId | |
|
|
2516
3089
|
**participant_id** | **String**| participantId | |
|
|
2517
|
-
**body** | [**
|
|
3090
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant | |
|
|
2518
3091
|
{: class="table table-striped"}
|
|
2519
3092
|
|
|
2520
3093
|
|
|
@@ -2529,15 +3102,15 @@ nil (empty response body)
|
|
|
2529
3102
|
|
|
2530
3103
|
|
|
2531
3104
|
|
|
2532
|
-
<a name="
|
|
3105
|
+
<a name="patch_conversations_callback_participant_attributes"></a>
|
|
2533
3106
|
|
|
2534
|
-
## -
|
|
3107
|
+
## - patch_conversations_callback_participant_attributes(conversation_id, participant_id, body)
|
|
2535
3108
|
|
|
2536
|
-
Update
|
|
3109
|
+
Update the attributes on a conversation participant.
|
|
2537
3110
|
|
|
2538
3111
|
|
|
2539
3112
|
|
|
2540
|
-
Wraps PATCH /api/v2/conversations/
|
|
3113
|
+
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/attributes
|
|
2541
3114
|
|
|
2542
3115
|
|
|
2543
3116
|
### Example
|
|
@@ -2561,17 +3134,14 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
2561
3134
|
|
|
2562
3135
|
participant_id = "participant_id_example" # String | participantId
|
|
2563
3136
|
|
|
2564
|
-
|
|
2565
|
-
|
|
2566
|
-
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
3137
|
+
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Attributes
|
|
2567
3138
|
|
|
2568
3139
|
|
|
2569
3140
|
begin
|
|
2570
|
-
#Update
|
|
2571
|
-
|
|
2572
|
-
p result
|
|
3141
|
+
#Update the attributes on a conversation participant.
|
|
3142
|
+
api_instance.patch_conversations_callback_participant_attributes(conversation_id, participant_id, body)
|
|
2573
3143
|
rescue PureCloud::ApiError => e
|
|
2574
|
-
puts "Exception when calling ConversationsApi->
|
|
3144
|
+
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant_attributes: #{e}"
|
|
2575
3145
|
end
|
|
2576
3146
|
~~~
|
|
2577
3147
|
|
|
@@ -2581,14 +3151,13 @@ Name | Type | Description | Notes
|
|
|
2581
3151
|
------------- | ------------- | ------------- | -------------
|
|
2582
3152
|
**conversation_id** | **String**| conversationId | |
|
|
2583
3153
|
**participant_id** | **String**| participantId | |
|
|
2584
|
-
**
|
|
2585
|
-
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant | |
|
|
3154
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Attributes | |
|
|
2586
3155
|
{: class="table table-striped"}
|
|
2587
3156
|
|
|
2588
3157
|
|
|
2589
3158
|
### Return type
|
|
2590
3159
|
|
|
2591
|
-
|
|
3160
|
+
nil (empty response body)
|
|
2592
3161
|
|
|
2593
3162
|
### HTTP request headers
|
|
2594
3163
|
|
|
@@ -2597,15 +3166,15 @@ Name | Type | Description | Notes
|
|
|
2597
3166
|
|
|
2598
3167
|
|
|
2599
3168
|
|
|
2600
|
-
<a name="
|
|
3169
|
+
<a name="patch_conversations_callback_participant_communication"></a>
|
|
2601
3170
|
|
|
2602
|
-
## -[**
|
|
3171
|
+
## -[**Empty**](Empty.html) patch_conversations_callback_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2603
3172
|
|
|
2604
|
-
|
|
3173
|
+
Update conversation participant's communication by disconnecting it.
|
|
2605
3174
|
|
|
2606
3175
|
|
|
2607
3176
|
|
|
2608
|
-
Wraps PATCH /api/v2/conversations/
|
|
3177
|
+
Wraps PATCH /api/v2/conversations/callbacks/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
2609
3178
|
|
|
2610
3179
|
|
|
2611
3180
|
### Example
|
|
@@ -2629,15 +3198,17 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
2629
3198
|
|
|
2630
3199
|
participant_id = "participant_id_example" # String | participantId
|
|
2631
3200
|
|
|
2632
|
-
|
|
3201
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
3202
|
+
|
|
3203
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant
|
|
2633
3204
|
|
|
2634
3205
|
|
|
2635
3206
|
begin
|
|
2636
|
-
#
|
|
2637
|
-
result = api_instance.
|
|
3207
|
+
#Update conversation participant's communication by disconnecting it.
|
|
3208
|
+
result = api_instance.patch_conversations_callback_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2638
3209
|
p result
|
|
2639
3210
|
rescue PureCloud::ApiError => e
|
|
2640
|
-
puts "Exception when calling ConversationsApi->
|
|
3211
|
+
puts "Exception when calling ConversationsApi->patch_conversations_callback_participant_communication: #{e}"
|
|
2641
3212
|
end
|
|
2642
3213
|
~~~
|
|
2643
3214
|
|
|
@@ -2647,13 +3218,14 @@ Name | Type | Description | Notes
|
|
|
2647
3218
|
------------- | ------------- | ------------- | -------------
|
|
2648
3219
|
**conversation_id** | **String**| conversationId | |
|
|
2649
3220
|
**participant_id** | **String**| participantId | |
|
|
2650
|
-
**
|
|
3221
|
+
**communication_id** | **String**| communicationId | |
|
|
3222
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant | |
|
|
2651
3223
|
{: class="table table-striped"}
|
|
2652
3224
|
|
|
2653
3225
|
|
|
2654
3226
|
### Return type
|
|
2655
3227
|
|
|
2656
|
-
[**
|
|
3228
|
+
[**Empty**](Empty.html)
|
|
2657
3229
|
|
|
2658
3230
|
### HTTP request headers
|
|
2659
3231
|
|
|
@@ -2662,15 +3234,15 @@ Name | Type | Description | Notes
|
|
|
2662
3234
|
|
|
2663
3235
|
|
|
2664
3236
|
|
|
2665
|
-
<a name="
|
|
3237
|
+
<a name="patch_conversations_chat"></a>
|
|
2666
3238
|
|
|
2667
|
-
## -[**Conversation**](Conversation.html)
|
|
3239
|
+
## -[**Conversation**](Conversation.html) patch_conversations_chat(conversation_id, body)
|
|
2668
3240
|
|
|
2669
3241
|
Update a conversation by disconnecting all of the participants
|
|
2670
3242
|
|
|
2671
3243
|
|
|
2672
3244
|
|
|
2673
|
-
Wraps PATCH /api/v2/conversations/
|
|
3245
|
+
Wraps PATCH /api/v2/conversations/chats/{conversationId}
|
|
2674
3246
|
|
|
2675
3247
|
|
|
2676
3248
|
### Example
|
|
@@ -2697,10 +3269,10 @@ body = PureCloud::Conversation.new # Conversation | Conversation
|
|
|
2697
3269
|
|
|
2698
3270
|
begin
|
|
2699
3271
|
#Update a conversation by disconnecting all of the participants
|
|
2700
|
-
result = api_instance.
|
|
3272
|
+
result = api_instance.patch_conversations_chat(conversation_id, body)
|
|
2701
3273
|
p result
|
|
2702
3274
|
rescue PureCloud::ApiError => e
|
|
2703
|
-
puts "Exception when calling ConversationsApi->
|
|
3275
|
+
puts "Exception when calling ConversationsApi->patch_conversations_chat: #{e}"
|
|
2704
3276
|
end
|
|
2705
3277
|
~~~
|
|
2706
3278
|
|
|
@@ -2724,15 +3296,15 @@ Name | Type | Description | Notes
|
|
|
2724
3296
|
|
|
2725
3297
|
|
|
2726
3298
|
|
|
2727
|
-
<a name="
|
|
3299
|
+
<a name="patch_conversations_chat_participant"></a>
|
|
2728
3300
|
|
|
2729
|
-
## -
|
|
3301
|
+
## - patch_conversations_chat_participant(conversation_id, participant_id, body)
|
|
2730
3302
|
|
|
2731
3303
|
Update conversation participant
|
|
2732
3304
|
|
|
2733
3305
|
|
|
2734
3306
|
|
|
2735
|
-
Wraps PATCH /api/v2/conversations/
|
|
3307
|
+
Wraps PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}
|
|
2736
3308
|
|
|
2737
3309
|
|
|
2738
3310
|
### Example
|
|
@@ -2756,14 +3328,14 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
2756
3328
|
|
|
2757
3329
|
participant_id = "participant_id_example" # String | participantId
|
|
2758
3330
|
|
|
2759
|
-
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest |
|
|
3331
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update request
|
|
2760
3332
|
|
|
2761
3333
|
|
|
2762
3334
|
begin
|
|
2763
3335
|
#Update conversation participant
|
|
2764
|
-
api_instance.
|
|
3336
|
+
api_instance.patch_conversations_chat_participant(conversation_id, participant_id, body)
|
|
2765
3337
|
rescue PureCloud::ApiError => e
|
|
2766
|
-
puts "Exception when calling ConversationsApi->
|
|
3338
|
+
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant: #{e}"
|
|
2767
3339
|
end
|
|
2768
3340
|
~~~
|
|
2769
3341
|
|
|
@@ -2773,7 +3345,7 @@ Name | Type | Description | Notes
|
|
|
2773
3345
|
------------- | ------------- | ------------- | -------------
|
|
2774
3346
|
**conversation_id** | **String**| conversationId | |
|
|
2775
3347
|
**participant_id** | **String**| participantId | |
|
|
2776
|
-
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)|
|
|
3348
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request | |
|
|
2777
3349
|
{: class="table table-striped"}
|
|
2778
3350
|
|
|
2779
3351
|
|
|
@@ -2788,15 +3360,15 @@ nil (empty response body)
|
|
|
2788
3360
|
|
|
2789
3361
|
|
|
2790
3362
|
|
|
2791
|
-
<a name="
|
|
3363
|
+
<a name="patch_conversations_chat_participant_attributes"></a>
|
|
2792
3364
|
|
|
2793
|
-
## -
|
|
3365
|
+
## - patch_conversations_chat_participant_attributes(conversation_id, participant_id, body)
|
|
2794
3366
|
|
|
2795
3367
|
Update the attributes on a conversation participant.
|
|
2796
3368
|
|
|
2797
3369
|
|
|
2798
3370
|
|
|
2799
|
-
Wraps PATCH /api/v2/conversations/
|
|
3371
|
+
Wraps PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/attributes
|
|
2800
3372
|
|
|
2801
3373
|
|
|
2802
3374
|
### Example
|
|
@@ -2820,14 +3392,14 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
2820
3392
|
|
|
2821
3393
|
participant_id = "participant_id_example" # String | participantId
|
|
2822
3394
|
|
|
2823
|
-
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes |
|
|
3395
|
+
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
2824
3396
|
|
|
2825
3397
|
|
|
2826
3398
|
begin
|
|
2827
3399
|
#Update the attributes on a conversation participant.
|
|
2828
|
-
api_instance.
|
|
3400
|
+
api_instance.patch_conversations_chat_participant_attributes(conversation_id, participant_id, body)
|
|
2829
3401
|
rescue PureCloud::ApiError => e
|
|
2830
|
-
puts "Exception when calling ConversationsApi->
|
|
3402
|
+
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant_attributes: #{e}"
|
|
2831
3403
|
end
|
|
2832
3404
|
~~~
|
|
2833
3405
|
|
|
@@ -2837,7 +3409,7 @@ Name | Type | Description | Notes
|
|
|
2837
3409
|
------------- | ------------- | ------------- | -------------
|
|
2838
3410
|
**conversation_id** | **String**| conversationId | |
|
|
2839
3411
|
**participant_id** | **String**| participantId | |
|
|
2840
|
-
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)|
|
|
3412
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes | |
|
|
2841
3413
|
{: class="table table-striped"}
|
|
2842
3414
|
|
|
2843
3415
|
|
|
@@ -2852,15 +3424,15 @@ nil (empty response body)
|
|
|
2852
3424
|
|
|
2853
3425
|
|
|
2854
3426
|
|
|
2855
|
-
<a name="
|
|
3427
|
+
<a name="patch_conversations_chat_participant_communication"></a>
|
|
2856
3428
|
|
|
2857
|
-
## -[**Empty**](Empty.html)
|
|
3429
|
+
## -[**Empty**](Empty.html) patch_conversations_chat_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2858
3430
|
|
|
2859
3431
|
Update conversation participant's communication by disconnecting it.
|
|
2860
3432
|
|
|
2861
3433
|
|
|
2862
3434
|
|
|
2863
|
-
Wraps PATCH /api/v2/conversations/
|
|
3435
|
+
Wraps PATCH /api/v2/conversations/chats/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
2864
3436
|
|
|
2865
3437
|
|
|
2866
3438
|
### Example
|
|
@@ -2891,10 +3463,10 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
2891
3463
|
|
|
2892
3464
|
begin
|
|
2893
3465
|
#Update conversation participant's communication by disconnecting it.
|
|
2894
|
-
result = api_instance.
|
|
3466
|
+
result = api_instance.patch_conversations_chat_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
2895
3467
|
p result
|
|
2896
3468
|
rescue PureCloud::ApiError => e
|
|
2897
|
-
puts "Exception when calling ConversationsApi->
|
|
3469
|
+
puts "Exception when calling ConversationsApi->patch_conversations_chat_participant_communication: #{e}"
|
|
2898
3470
|
end
|
|
2899
3471
|
~~~
|
|
2900
3472
|
|
|
@@ -2920,15 +3492,15 @@ Name | Type | Description | Notes
|
|
|
2920
3492
|
|
|
2921
3493
|
|
|
2922
3494
|
|
|
2923
|
-
<a name="
|
|
3495
|
+
<a name="patch_conversations_cobrowsesession"></a>
|
|
2924
3496
|
|
|
2925
|
-
## -[**Conversation**](Conversation.html)
|
|
3497
|
+
## -[**Conversation**](Conversation.html) patch_conversations_cobrowsesession(conversation_id, body)
|
|
2926
3498
|
|
|
2927
3499
|
Update a conversation by disconnecting all of the participants
|
|
2928
3500
|
|
|
2929
3501
|
|
|
2930
3502
|
|
|
2931
|
-
Wraps PATCH /api/v2/conversations/
|
|
3503
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}
|
|
2932
3504
|
|
|
2933
3505
|
|
|
2934
3506
|
### Example
|
|
@@ -2955,10 +3527,10 @@ body = PureCloud::Conversation.new # Conversation | Conversation
|
|
|
2955
3527
|
|
|
2956
3528
|
begin
|
|
2957
3529
|
#Update a conversation by disconnecting all of the participants
|
|
2958
|
-
result = api_instance.
|
|
3530
|
+
result = api_instance.patch_conversations_cobrowsesession(conversation_id, body)
|
|
2959
3531
|
p result
|
|
2960
3532
|
rescue PureCloud::ApiError => e
|
|
2961
|
-
puts "Exception when calling ConversationsApi->
|
|
3533
|
+
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession: #{e}"
|
|
2962
3534
|
end
|
|
2963
3535
|
~~~
|
|
2964
3536
|
|
|
@@ -2982,15 +3554,15 @@ Name | Type | Description | Notes
|
|
|
2982
3554
|
|
|
2983
3555
|
|
|
2984
3556
|
|
|
2985
|
-
<a name="
|
|
3557
|
+
<a name="patch_conversations_cobrowsesession_participant"></a>
|
|
2986
3558
|
|
|
2987
|
-
## -
|
|
3559
|
+
## - patch_conversations_cobrowsesession_participant(conversation_id, participant_id, opts)
|
|
2988
3560
|
|
|
2989
3561
|
Update conversation participant
|
|
2990
3562
|
|
|
2991
3563
|
|
|
2992
3564
|
|
|
2993
|
-
Wraps PATCH /api/v2/conversations/
|
|
3565
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}
|
|
2994
3566
|
|
|
2995
3567
|
|
|
2996
3568
|
### Example
|
|
@@ -3014,14 +3586,15 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
3014
3586
|
|
|
3015
3587
|
participant_id = "participant_id_example" # String | participantId
|
|
3016
3588
|
|
|
3017
|
-
|
|
3018
|
-
|
|
3589
|
+
opts = {
|
|
3590
|
+
body: PureCloud::MediaParticipantRequest.new # MediaParticipantRequest |
|
|
3591
|
+
}
|
|
3019
3592
|
|
|
3020
3593
|
begin
|
|
3021
3594
|
#Update conversation participant
|
|
3022
|
-
api_instance.
|
|
3595
|
+
api_instance.patch_conversations_cobrowsesession_participant(conversation_id, participant_id, opts)
|
|
3023
3596
|
rescue PureCloud::ApiError => e
|
|
3024
|
-
puts "Exception when calling ConversationsApi->
|
|
3597
|
+
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant: #{e}"
|
|
3025
3598
|
end
|
|
3026
3599
|
~~~
|
|
3027
3600
|
|
|
@@ -3031,7 +3604,7 @@ Name | Type | Description | Notes
|
|
|
3031
3604
|
------------- | ------------- | ------------- | -------------
|
|
3032
3605
|
**conversation_id** | **String**| conversationId | |
|
|
3033
3606
|
**participant_id** | **String**| participantId | |
|
|
3034
|
-
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)|
|
|
3607
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| | [optional] |
|
|
3035
3608
|
{: class="table table-striped"}
|
|
3036
3609
|
|
|
3037
3610
|
|
|
@@ -3046,15 +3619,15 @@ nil (empty response body)
|
|
|
3046
3619
|
|
|
3047
3620
|
|
|
3048
3621
|
|
|
3049
|
-
<a name="
|
|
3622
|
+
<a name="patch_conversations_cobrowsesession_participant_attributes"></a>
|
|
3050
3623
|
|
|
3051
|
-
## -
|
|
3624
|
+
## - patch_conversations_cobrowsesession_participant_attributes(conversation_id, participant_id, opts)
|
|
3052
3625
|
|
|
3053
3626
|
Update the attributes on a conversation participant.
|
|
3054
3627
|
|
|
3055
3628
|
|
|
3056
3629
|
|
|
3057
|
-
Wraps PATCH /api/v2/conversations/
|
|
3630
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/attributes
|
|
3058
3631
|
|
|
3059
3632
|
|
|
3060
3633
|
### Example
|
|
@@ -3078,14 +3651,15 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
3078
3651
|
|
|
3079
3652
|
participant_id = "participant_id_example" # String | participantId
|
|
3080
3653
|
|
|
3081
|
-
|
|
3082
|
-
|
|
3654
|
+
opts = {
|
|
3655
|
+
body: PureCloud::ParticipantAttributes.new # ParticipantAttributes |
|
|
3656
|
+
}
|
|
3083
3657
|
|
|
3084
3658
|
begin
|
|
3085
3659
|
#Update the attributes on a conversation participant.
|
|
3086
|
-
api_instance.
|
|
3660
|
+
api_instance.patch_conversations_cobrowsesession_participant_attributes(conversation_id, participant_id, opts)
|
|
3087
3661
|
rescue PureCloud::ApiError => e
|
|
3088
|
-
puts "Exception when calling ConversationsApi->
|
|
3662
|
+
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant_attributes: #{e}"
|
|
3089
3663
|
end
|
|
3090
3664
|
~~~
|
|
3091
3665
|
|
|
@@ -3095,7 +3669,7 @@ Name | Type | Description | Notes
|
|
|
3095
3669
|
------------- | ------------- | ------------- | -------------
|
|
3096
3670
|
**conversation_id** | **String**| conversationId | |
|
|
3097
3671
|
**participant_id** | **String**| participantId | |
|
|
3098
|
-
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)|
|
|
3672
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| | [optional] |
|
|
3099
3673
|
{: class="table table-striped"}
|
|
3100
3674
|
|
|
3101
3675
|
|
|
@@ -3110,15 +3684,15 @@ nil (empty response body)
|
|
|
3110
3684
|
|
|
3111
3685
|
|
|
3112
3686
|
|
|
3113
|
-
<a name="
|
|
3687
|
+
<a name="patch_conversations_cobrowsesession_participant_communication"></a>
|
|
3114
3688
|
|
|
3115
|
-
## -[**Empty**](Empty.html)
|
|
3689
|
+
## -[**Empty**](Empty.html) patch_conversations_cobrowsesession_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3116
3690
|
|
|
3117
3691
|
Update conversation participant's communication by disconnecting it.
|
|
3118
3692
|
|
|
3119
3693
|
|
|
3120
3694
|
|
|
3121
|
-
Wraps PATCH /api/v2/conversations/
|
|
3695
|
+
Wraps PATCH /api/v2/conversations/cobrowsesessions/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
3122
3696
|
|
|
3123
3697
|
|
|
3124
3698
|
### Example
|
|
@@ -3149,10 +3723,10 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
3149
3723
|
|
|
3150
3724
|
begin
|
|
3151
3725
|
#Update conversation participant's communication by disconnecting it.
|
|
3152
|
-
result = api_instance.
|
|
3726
|
+
result = api_instance.patch_conversations_cobrowsesession_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3153
3727
|
p result
|
|
3154
3728
|
rescue PureCloud::ApiError => e
|
|
3155
|
-
puts "Exception when calling ConversationsApi->
|
|
3729
|
+
puts "Exception when calling ConversationsApi->patch_conversations_cobrowsesession_participant_communication: #{e}"
|
|
3156
3730
|
end
|
|
3157
3731
|
~~~
|
|
3158
3732
|
|
|
@@ -3178,15 +3752,15 @@ Name | Type | Description | Notes
|
|
|
3178
3752
|
|
|
3179
3753
|
|
|
3180
3754
|
|
|
3181
|
-
<a name="
|
|
3755
|
+
<a name="patch_conversations_email"></a>
|
|
3182
3756
|
|
|
3183
|
-
## -[**Conversation**](Conversation.html)
|
|
3757
|
+
## -[**Conversation**](Conversation.html) patch_conversations_email(conversation_id, body)
|
|
3184
3758
|
|
|
3185
3759
|
Update a conversation by disconnecting all of the participants
|
|
3186
3760
|
|
|
3187
3761
|
|
|
3188
3762
|
|
|
3189
|
-
Wraps PATCH /api/v2/conversations/
|
|
3763
|
+
Wraps PATCH /api/v2/conversations/emails/{conversationId}
|
|
3190
3764
|
|
|
3191
3765
|
|
|
3192
3766
|
### Example
|
|
@@ -3213,10 +3787,10 @@ body = PureCloud::Conversation.new # Conversation | Conversation
|
|
|
3213
3787
|
|
|
3214
3788
|
begin
|
|
3215
3789
|
#Update a conversation by disconnecting all of the participants
|
|
3216
|
-
result = api_instance.
|
|
3790
|
+
result = api_instance.patch_conversations_email(conversation_id, body)
|
|
3217
3791
|
p result
|
|
3218
3792
|
rescue PureCloud::ApiError => e
|
|
3219
|
-
puts "Exception when calling ConversationsApi->
|
|
3793
|
+
puts "Exception when calling ConversationsApi->patch_conversations_email: #{e}"
|
|
3220
3794
|
end
|
|
3221
3795
|
~~~
|
|
3222
3796
|
|
|
@@ -3240,15 +3814,15 @@ Name | Type | Description | Notes
|
|
|
3240
3814
|
|
|
3241
3815
|
|
|
3242
3816
|
|
|
3243
|
-
<a name="
|
|
3817
|
+
<a name="patch_conversations_email_participant"></a>
|
|
3244
3818
|
|
|
3245
|
-
## -
|
|
3819
|
+
## - patch_conversations_email_participant(conversation_id, participant_id, body)
|
|
3246
3820
|
|
|
3247
3821
|
Update conversation participant
|
|
3248
3822
|
|
|
3249
3823
|
|
|
3250
3824
|
|
|
3251
|
-
Wraps PATCH /api/v2/conversations/
|
|
3825
|
+
Wraps PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}
|
|
3252
3826
|
|
|
3253
3827
|
|
|
3254
3828
|
### Example
|
|
@@ -3272,15 +3846,14 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
3272
3846
|
|
|
3273
3847
|
participant_id = "participant_id_example" # String | participantId
|
|
3274
3848
|
|
|
3275
|
-
|
|
3276
|
-
|
|
3277
|
-
}
|
|
3849
|
+
body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update request
|
|
3850
|
+
|
|
3278
3851
|
|
|
3279
3852
|
begin
|
|
3280
3853
|
#Update conversation participant
|
|
3281
|
-
api_instance.
|
|
3854
|
+
api_instance.patch_conversations_email_participant(conversation_id, participant_id, body)
|
|
3282
3855
|
rescue PureCloud::ApiError => e
|
|
3283
|
-
puts "Exception when calling ConversationsApi->
|
|
3856
|
+
puts "Exception when calling ConversationsApi->patch_conversations_email_participant: #{e}"
|
|
3284
3857
|
end
|
|
3285
3858
|
~~~
|
|
3286
3859
|
|
|
@@ -3290,7 +3863,7 @@ Name | Type | Description | Notes
|
|
|
3290
3863
|
------------- | ------------- | ------------- | -------------
|
|
3291
3864
|
**conversation_id** | **String**| conversationId | |
|
|
3292
3865
|
**participant_id** | **String**| participantId | |
|
|
3293
|
-
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)|
|
|
3866
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request | |
|
|
3294
3867
|
{: class="table table-striped"}
|
|
3295
3868
|
|
|
3296
3869
|
|
|
@@ -3305,15 +3878,15 @@ nil (empty response body)
|
|
|
3305
3878
|
|
|
3306
3879
|
|
|
3307
3880
|
|
|
3308
|
-
<a name="
|
|
3881
|
+
<a name="patch_conversations_email_participant_attributes"></a>
|
|
3309
3882
|
|
|
3310
|
-
## -
|
|
3883
|
+
## - patch_conversations_email_participant_attributes(conversation_id, participant_id, body)
|
|
3311
3884
|
|
|
3312
3885
|
Update the attributes on a conversation participant.
|
|
3313
3886
|
|
|
3314
3887
|
|
|
3315
3888
|
|
|
3316
|
-
Wraps PATCH /api/v2/conversations/
|
|
3889
|
+
Wraps PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/attributes
|
|
3317
3890
|
|
|
3318
3891
|
|
|
3319
3892
|
### Example
|
|
@@ -3337,15 +3910,14 @@ conversation_id = "conversation_id_example" # String | conversationId
|
|
|
3337
3910
|
|
|
3338
3911
|
participant_id = "participant_id_example" # String | participantId
|
|
3339
3912
|
|
|
3340
|
-
|
|
3341
|
-
|
|
3342
|
-
}
|
|
3913
|
+
body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes
|
|
3914
|
+
|
|
3343
3915
|
|
|
3344
3916
|
begin
|
|
3345
3917
|
#Update the attributes on a conversation participant.
|
|
3346
|
-
api_instance.
|
|
3918
|
+
api_instance.patch_conversations_email_participant_attributes(conversation_id, participant_id, body)
|
|
3347
3919
|
rescue PureCloud::ApiError => e
|
|
3348
|
-
puts "Exception when calling ConversationsApi->
|
|
3920
|
+
puts "Exception when calling ConversationsApi->patch_conversations_email_participant_attributes: #{e}"
|
|
3349
3921
|
end
|
|
3350
3922
|
~~~
|
|
3351
3923
|
|
|
@@ -3355,7 +3927,7 @@ Name | Type | Description | Notes
|
|
|
3355
3927
|
------------- | ------------- | ------------- | -------------
|
|
3356
3928
|
**conversation_id** | **String**| conversationId | |
|
|
3357
3929
|
**participant_id** | **String**| participantId | |
|
|
3358
|
-
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)|
|
|
3930
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes | |
|
|
3359
3931
|
{: class="table table-striped"}
|
|
3360
3932
|
|
|
3361
3933
|
|
|
@@ -3370,15 +3942,15 @@ nil (empty response body)
|
|
|
3370
3942
|
|
|
3371
3943
|
|
|
3372
3944
|
|
|
3373
|
-
<a name="
|
|
3945
|
+
<a name="patch_conversations_email_participant_communication"></a>
|
|
3374
3946
|
|
|
3375
|
-
## -[**Empty**](Empty.html)
|
|
3947
|
+
## -[**Empty**](Empty.html) patch_conversations_email_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3376
3948
|
|
|
3377
3949
|
Update conversation participant's communication by disconnecting it.
|
|
3378
3950
|
|
|
3379
3951
|
|
|
3380
3952
|
|
|
3381
|
-
Wraps PATCH /api/v2/conversations/
|
|
3953
|
+
Wraps PATCH /api/v2/conversations/emails/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
3382
3954
|
|
|
3383
3955
|
|
|
3384
3956
|
### Example
|
|
@@ -3409,10 +3981,10 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
3409
3981
|
|
|
3410
3982
|
begin
|
|
3411
3983
|
#Update conversation participant's communication by disconnecting it.
|
|
3412
|
-
result = api_instance.
|
|
3984
|
+
result = api_instance.patch_conversations_email_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3413
3985
|
p result
|
|
3414
3986
|
rescue PureCloud::ApiError => e
|
|
3415
|
-
puts "Exception when calling ConversationsApi->
|
|
3987
|
+
puts "Exception when calling ConversationsApi->patch_conversations_email_participant_communication: #{e}"
|
|
3416
3988
|
end
|
|
3417
3989
|
~~~
|
|
3418
3990
|
|
|
@@ -3438,15 +4010,15 @@ Name | Type | Description | Notes
|
|
|
3438
4010
|
|
|
3439
4011
|
|
|
3440
4012
|
|
|
3441
|
-
<a name="
|
|
4013
|
+
<a name="patch_conversations_message"></a>
|
|
3442
4014
|
|
|
3443
|
-
## -[**Conversation**](Conversation.html)
|
|
4015
|
+
## -[**Conversation**](Conversation.html) patch_conversations_message(conversation_id, body)
|
|
3444
4016
|
|
|
3445
4017
|
Update a conversation by disconnecting all of the participants
|
|
3446
4018
|
|
|
3447
4019
|
|
|
3448
4020
|
|
|
3449
|
-
Wraps PATCH /api/v2/conversations/
|
|
4021
|
+
Wraps PATCH /api/v2/conversations/messages/{conversationId}
|
|
3450
4022
|
|
|
3451
4023
|
|
|
3452
4024
|
### Example
|
|
@@ -3473,10 +4045,10 @@ body = PureCloud::Conversation.new # Conversation | Conversation
|
|
|
3473
4045
|
|
|
3474
4046
|
begin
|
|
3475
4047
|
#Update a conversation by disconnecting all of the participants
|
|
3476
|
-
result = api_instance.
|
|
4048
|
+
result = api_instance.patch_conversations_message(conversation_id, body)
|
|
3477
4049
|
p result
|
|
3478
4050
|
rescue PureCloud::ApiError => e
|
|
3479
|
-
puts "Exception when calling ConversationsApi->
|
|
4051
|
+
puts "Exception when calling ConversationsApi->patch_conversations_message: #{e}"
|
|
3480
4052
|
end
|
|
3481
4053
|
~~~
|
|
3482
4054
|
|
|
@@ -3500,15 +4072,15 @@ Name | Type | Description | Notes
|
|
|
3500
4072
|
|
|
3501
4073
|
|
|
3502
4074
|
|
|
3503
|
-
<a name="
|
|
4075
|
+
<a name="patch_conversations_message_participant"></a>
|
|
3504
4076
|
|
|
3505
|
-
## -
|
|
4077
|
+
## - patch_conversations_message_participant(conversation_id, participant_id, opts)
|
|
3506
4078
|
|
|
3507
4079
|
Update conversation participant
|
|
3508
4080
|
|
|
3509
4081
|
|
|
3510
4082
|
|
|
3511
|
-
Wraps PATCH /api/v2/conversations/
|
|
4083
|
+
Wraps PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}
|
|
3512
4084
|
|
|
3513
4085
|
|
|
3514
4086
|
### Example
|
|
@@ -3528,18 +4100,19 @@ end
|
|
|
3528
4100
|
|
|
3529
4101
|
api_instance = PureCloud::ConversationsApi.new
|
|
3530
4102
|
|
|
3531
|
-
conversation_id = "conversation_id_example" # String |
|
|
4103
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3532
4104
|
|
|
3533
4105
|
participant_id = "participant_id_example" # String | participantId
|
|
3534
4106
|
|
|
3535
|
-
|
|
3536
|
-
|
|
4107
|
+
opts = {
|
|
4108
|
+
body: PureCloud::MediaParticipantRequest.new # MediaParticipantRequest |
|
|
4109
|
+
}
|
|
3537
4110
|
|
|
3538
4111
|
begin
|
|
3539
4112
|
#Update conversation participant
|
|
3540
|
-
api_instance.
|
|
4113
|
+
api_instance.patch_conversations_message_participant(conversation_id, participant_id, opts)
|
|
3541
4114
|
rescue PureCloud::ApiError => e
|
|
3542
|
-
puts "Exception when calling ConversationsApi->
|
|
4115
|
+
puts "Exception when calling ConversationsApi->patch_conversations_message_participant: #{e}"
|
|
3543
4116
|
end
|
|
3544
4117
|
~~~
|
|
3545
4118
|
|
|
@@ -3547,9 +4120,9 @@ end
|
|
|
3547
4120
|
|
|
3548
4121
|
Name | Type | Description | Notes
|
|
3549
4122
|
------------- | ------------- | ------------- | -------------
|
|
3550
|
-
**conversation_id** | **String**|
|
|
4123
|
+
**conversation_id** | **String**| conversationId | |
|
|
3551
4124
|
**participant_id** | **String**| participantId | |
|
|
3552
|
-
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)|
|
|
4125
|
+
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| | [optional] |
|
|
3553
4126
|
{: class="table table-striped"}
|
|
3554
4127
|
|
|
3555
4128
|
|
|
@@ -3564,15 +4137,15 @@ nil (empty response body)
|
|
|
3564
4137
|
|
|
3565
4138
|
|
|
3566
4139
|
|
|
3567
|
-
<a name="
|
|
4140
|
+
<a name="patch_conversations_message_participant_attributes"></a>
|
|
3568
4141
|
|
|
3569
|
-
## -
|
|
4142
|
+
## - patch_conversations_message_participant_attributes(conversation_id, participant_id, opts)
|
|
3570
4143
|
|
|
3571
4144
|
Update the attributes on a conversation participant.
|
|
3572
4145
|
|
|
3573
4146
|
|
|
3574
4147
|
|
|
3575
|
-
Wraps PATCH /api/v2/conversations/
|
|
4148
|
+
Wraps PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/attributes
|
|
3576
4149
|
|
|
3577
4150
|
|
|
3578
4151
|
### Example
|
|
@@ -3592,18 +4165,19 @@ end
|
|
|
3592
4165
|
|
|
3593
4166
|
api_instance = PureCloud::ConversationsApi.new
|
|
3594
4167
|
|
|
3595
|
-
conversation_id = "conversation_id_example" # String |
|
|
4168
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3596
4169
|
|
|
3597
4170
|
participant_id = "participant_id_example" # String | participantId
|
|
3598
4171
|
|
|
3599
|
-
|
|
3600
|
-
|
|
4172
|
+
opts = {
|
|
4173
|
+
body: PureCloud::ParticipantAttributes.new # ParticipantAttributes |
|
|
4174
|
+
}
|
|
3601
4175
|
|
|
3602
4176
|
begin
|
|
3603
4177
|
#Update the attributes on a conversation participant.
|
|
3604
|
-
api_instance.
|
|
4178
|
+
api_instance.patch_conversations_message_participant_attributes(conversation_id, participant_id, opts)
|
|
3605
4179
|
rescue PureCloud::ApiError => e
|
|
3606
|
-
puts "Exception when calling ConversationsApi->
|
|
4180
|
+
puts "Exception when calling ConversationsApi->patch_conversations_message_participant_attributes: #{e}"
|
|
3607
4181
|
end
|
|
3608
4182
|
~~~
|
|
3609
4183
|
|
|
@@ -3611,9 +4185,9 @@ end
|
|
|
3611
4185
|
|
|
3612
4186
|
Name | Type | Description | Notes
|
|
3613
4187
|
------------- | ------------- | ------------- | -------------
|
|
3614
|
-
**conversation_id** | **String**|
|
|
4188
|
+
**conversation_id** | **String**| conversationId | |
|
|
3615
4189
|
**participant_id** | **String**| participantId | |
|
|
3616
|
-
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)|
|
|
4190
|
+
**body** | [**ParticipantAttributes**](ParticipantAttributes.html)| | [optional] |
|
|
3617
4191
|
{: class="table table-striped"}
|
|
3618
4192
|
|
|
3619
4193
|
|
|
@@ -3628,15 +4202,15 @@ nil (empty response body)
|
|
|
3628
4202
|
|
|
3629
4203
|
|
|
3630
4204
|
|
|
3631
|
-
<a name="
|
|
4205
|
+
<a name="patch_conversations_message_participant_communication"></a>
|
|
3632
4206
|
|
|
3633
|
-
## -[**Empty**](Empty.html)
|
|
4207
|
+
## -[**Empty**](Empty.html) patch_conversations_message_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3634
4208
|
|
|
3635
4209
|
Update conversation participant's communication by disconnecting it.
|
|
3636
4210
|
|
|
3637
4211
|
|
|
3638
4212
|
|
|
3639
|
-
Wraps PATCH /api/v2/conversations/
|
|
4213
|
+
Wraps PATCH /api/v2/conversations/messages/{conversationId}/participants/{participantId}/communications/{communicationId}
|
|
3640
4214
|
|
|
3641
4215
|
|
|
3642
4216
|
### Example
|
|
@@ -3656,7 +4230,7 @@ end
|
|
|
3656
4230
|
|
|
3657
4231
|
api_instance = PureCloud::ConversationsApi.new
|
|
3658
4232
|
|
|
3659
|
-
conversation_id = "conversation_id_example" # String |
|
|
4233
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
3660
4234
|
|
|
3661
4235
|
participant_id = "participant_id_example" # String | participantId
|
|
3662
4236
|
|
|
@@ -3667,10 +4241,10 @@ body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Partic
|
|
|
3667
4241
|
|
|
3668
4242
|
begin
|
|
3669
4243
|
#Update conversation participant's communication by disconnecting it.
|
|
3670
|
-
result = api_instance.
|
|
4244
|
+
result = api_instance.patch_conversations_message_participant_communication(conversation_id, participant_id, communication_id, body)
|
|
3671
4245
|
p result
|
|
3672
4246
|
rescue PureCloud::ApiError => e
|
|
3673
|
-
puts "Exception when calling ConversationsApi->
|
|
4247
|
+
puts "Exception when calling ConversationsApi->patch_conversations_message_participant_communication: #{e}"
|
|
3674
4248
|
end
|
|
3675
4249
|
~~~
|
|
3676
4250
|
|
|
@@ -3678,7 +4252,7 @@ end
|
|
|
3678
4252
|
|
|
3679
4253
|
Name | Type | Description | Notes
|
|
3680
4254
|
------------- | ------------- | ------------- | -------------
|
|
3681
|
-
**conversation_id** | **String**|
|
|
4255
|
+
**conversation_id** | **String**| conversationId | |
|
|
3682
4256
|
**participant_id** | **String**| participantId | |
|
|
3683
4257
|
**communication_id** | **String**| communicationId | |
|
|
3684
4258
|
**body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant | |
|
|
@@ -5126,6 +5700,198 @@ Name | Type | Description | Notes
|
|
|
5126
5700
|
|
|
5127
5701
|
|
|
5128
5702
|
|
|
5703
|
+
<a name="post_conversations_message_communication_messages"></a>
|
|
5704
|
+
|
|
5705
|
+
## -[**MessageData**](MessageData.html) post_conversations_message_communication_messages(conversation_id, communication_id, body)
|
|
5706
|
+
|
|
5707
|
+
Send message
|
|
5708
|
+
|
|
5709
|
+
|
|
5710
|
+
|
|
5711
|
+
Wraps POST /api/v2/conversations/messages/{conversationId}/communications/{communicationId}/messages
|
|
5712
|
+
|
|
5713
|
+
|
|
5714
|
+
### Example
|
|
5715
|
+
~~~ruby
|
|
5716
|
+
# load the gem
|
|
5717
|
+
require 'purecloudplatformclientv2'
|
|
5718
|
+
# setup authorization
|
|
5719
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
5720
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
5721
|
+
environment = "mypurecloud.com"
|
|
5722
|
+
|
|
5723
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
5724
|
+
|
|
5725
|
+
PureCloud.configure do |config|
|
|
5726
|
+
config.access_token = @authToken
|
|
5727
|
+
end
|
|
5728
|
+
|
|
5729
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
5730
|
+
|
|
5731
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
5732
|
+
|
|
5733
|
+
communication_id = "communication_id_example" # String | communicationId
|
|
5734
|
+
|
|
5735
|
+
body = PureCloud::AdditionalMessage.new # AdditionalMessage | Message
|
|
5736
|
+
|
|
5737
|
+
|
|
5738
|
+
begin
|
|
5739
|
+
#Send message
|
|
5740
|
+
result = api_instance.post_conversations_message_communication_messages(conversation_id, communication_id, body)
|
|
5741
|
+
p result
|
|
5742
|
+
rescue PureCloud::ApiError => e
|
|
5743
|
+
puts "Exception when calling ConversationsApi->post_conversations_message_communication_messages: #{e}"
|
|
5744
|
+
end
|
|
5745
|
+
~~~
|
|
5746
|
+
|
|
5747
|
+
### Parameters
|
|
5748
|
+
|
|
5749
|
+
Name | Type | Description | Notes
|
|
5750
|
+
------------- | ------------- | ------------- | -------------
|
|
5751
|
+
**conversation_id** | **String**| conversationId | |
|
|
5752
|
+
**communication_id** | **String**| communicationId | |
|
|
5753
|
+
**body** | [**AdditionalMessage**](AdditionalMessage.html)| Message | |
|
|
5754
|
+
{: class="table table-striped"}
|
|
5755
|
+
|
|
5756
|
+
|
|
5757
|
+
### Return type
|
|
5758
|
+
|
|
5759
|
+
[**MessageData**](MessageData.html)
|
|
5760
|
+
|
|
5761
|
+
### HTTP request headers
|
|
5762
|
+
|
|
5763
|
+
- **Content-Type**: application/json
|
|
5764
|
+
- **Accept**: application/json
|
|
5765
|
+
|
|
5766
|
+
|
|
5767
|
+
|
|
5768
|
+
<a name="post_conversations_message_messages_bulk"></a>
|
|
5769
|
+
|
|
5770
|
+
## -[**TextMessageListing**](TextMessageListing.html) post_conversations_message_messages_bulk(conversation_id, opts)
|
|
5771
|
+
|
|
5772
|
+
Get messages in batch
|
|
5773
|
+
|
|
5774
|
+
|
|
5775
|
+
|
|
5776
|
+
Wraps POST /api/v2/conversations/messages/{conversationId}/messages/bulk
|
|
5777
|
+
|
|
5778
|
+
|
|
5779
|
+
### Example
|
|
5780
|
+
~~~ruby
|
|
5781
|
+
# load the gem
|
|
5782
|
+
require 'purecloudplatformclientv2'
|
|
5783
|
+
# setup authorization
|
|
5784
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
5785
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
5786
|
+
environment = "mypurecloud.com"
|
|
5787
|
+
|
|
5788
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
5789
|
+
|
|
5790
|
+
PureCloud.configure do |config|
|
|
5791
|
+
config.access_token = @authToken
|
|
5792
|
+
end
|
|
5793
|
+
|
|
5794
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
5795
|
+
|
|
5796
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
5797
|
+
|
|
5798
|
+
opts = {
|
|
5799
|
+
body: [PureCloud::Array<String>.new] # Array<String> | messageIds
|
|
5800
|
+
}
|
|
5801
|
+
|
|
5802
|
+
begin
|
|
5803
|
+
#Get messages in batch
|
|
5804
|
+
result = api_instance.post_conversations_message_messages_bulk(conversation_id, opts)
|
|
5805
|
+
p result
|
|
5806
|
+
rescue PureCloud::ApiError => e
|
|
5807
|
+
puts "Exception when calling ConversationsApi->post_conversations_message_messages_bulk: #{e}"
|
|
5808
|
+
end
|
|
5809
|
+
~~~
|
|
5810
|
+
|
|
5811
|
+
### Parameters
|
|
5812
|
+
|
|
5813
|
+
Name | Type | Description | Notes
|
|
5814
|
+
------------- | ------------- | ------------- | -------------
|
|
5815
|
+
**conversation_id** | **String**| conversationId | |
|
|
5816
|
+
**body** | **Array<String>**| messageIds | [optional] |
|
|
5817
|
+
{: class="table table-striped"}
|
|
5818
|
+
|
|
5819
|
+
|
|
5820
|
+
### Return type
|
|
5821
|
+
|
|
5822
|
+
[**TextMessageListing**](TextMessageListing.html)
|
|
5823
|
+
|
|
5824
|
+
### HTTP request headers
|
|
5825
|
+
|
|
5826
|
+
- **Content-Type**: application/json
|
|
5827
|
+
- **Accept**: application/json
|
|
5828
|
+
|
|
5829
|
+
|
|
5830
|
+
|
|
5831
|
+
<a name="post_conversations_message_participant_replace"></a>
|
|
5832
|
+
|
|
5833
|
+
## - post_conversations_message_participant_replace(conversation_id, participant_id, body)
|
|
5834
|
+
|
|
5835
|
+
Replace this participant with the specified user and/or address
|
|
5836
|
+
|
|
5837
|
+
|
|
5838
|
+
|
|
5839
|
+
Wraps POST /api/v2/conversations/messages/{conversationId}/participants/{participantId}/replace
|
|
5840
|
+
|
|
5841
|
+
|
|
5842
|
+
### Example
|
|
5843
|
+
~~~ruby
|
|
5844
|
+
# load the gem
|
|
5845
|
+
require 'purecloudplatformclientv2'
|
|
5846
|
+
# setup authorization
|
|
5847
|
+
@secret = ENV['PURECLOUD_SECRET']
|
|
5848
|
+
@id = ENV['PURECLOUD_CLIENT_ID']
|
|
5849
|
+
environment = "mypurecloud.com"
|
|
5850
|
+
|
|
5851
|
+
@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment
|
|
5852
|
+
|
|
5853
|
+
PureCloud.configure do |config|
|
|
5854
|
+
config.access_token = @authToken
|
|
5855
|
+
end
|
|
5856
|
+
|
|
5857
|
+
api_instance = PureCloud::ConversationsApi.new
|
|
5858
|
+
|
|
5859
|
+
conversation_id = "conversation_id_example" # String | conversationId
|
|
5860
|
+
|
|
5861
|
+
participant_id = "participant_id_example" # String | participantId
|
|
5862
|
+
|
|
5863
|
+
body = PureCloud::TransferRequest.new # TransferRequest | Transfer request
|
|
5864
|
+
|
|
5865
|
+
|
|
5866
|
+
begin
|
|
5867
|
+
#Replace this participant with the specified user and/or address
|
|
5868
|
+
api_instance.post_conversations_message_participant_replace(conversation_id, participant_id, body)
|
|
5869
|
+
rescue PureCloud::ApiError => e
|
|
5870
|
+
puts "Exception when calling ConversationsApi->post_conversations_message_participant_replace: #{e}"
|
|
5871
|
+
end
|
|
5872
|
+
~~~
|
|
5873
|
+
|
|
5874
|
+
### Parameters
|
|
5875
|
+
|
|
5876
|
+
Name | Type | Description | Notes
|
|
5877
|
+
------------- | ------------- | ------------- | -------------
|
|
5878
|
+
**conversation_id** | **String**| conversationId | |
|
|
5879
|
+
**participant_id** | **String**| participantId | |
|
|
5880
|
+
**body** | [**TransferRequest**](TransferRequest.html)| Transfer request | |
|
|
5881
|
+
{: class="table table-striped"}
|
|
5882
|
+
|
|
5883
|
+
|
|
5884
|
+
### Return type
|
|
5885
|
+
|
|
5886
|
+
nil (empty response body)
|
|
5887
|
+
|
|
5888
|
+
### HTTP request headers
|
|
5889
|
+
|
|
5890
|
+
- **Content-Type**: application/json
|
|
5891
|
+
- **Accept**: application/json
|
|
5892
|
+
|
|
5893
|
+
|
|
5894
|
+
|
|
5129
5895
|
<a name="put_conversations_call_participant_communication_uuidata"></a>
|
|
5130
5896
|
|
|
5131
5897
|
## -[**Empty**](Empty.html) put_conversations_call_participant_communication_uuidata(conversation_id, participant_id, communication_id, body)
|