---
title: ConversationsApi
---

## PureCloud::ConversationsApi

All URIs are relative to *https://api.mypurecloud.com*

Method | HTTP request | Description
------------- | ------------- | -------------
|[**delete_calls_call_id_participants_participant_id_consult**](ConversationsApi.html#delete_calls_call_id_participants_participant_id_consult) | **DELETE** /api/v2/conversations/calls/{callId}/participants/{participantId}/consult | Cancel the transfer|
|[**delete_conversation_id_participants_participant_id_codes_addcommunicationcode**](ConversationsApi.html#delete_conversation_id_participants_participant_id_codes_addcommunicationcode) | **DELETE** /api/v2/conversations/{conversationId}/participants/{participantId}/codes/{addCommunicationCode} | Delete a code used to add a communication to this participant|
|[**delete_emails_email_id_messages_draft_attachments_attachment_id**](ConversationsApi.html#delete_emails_email_id_messages_draft_attachments_attachment_id) | **DELETE** /api/v2/conversations/emails/{emailId}/messages/draft/attachments/{attachmentId} | Delete attachment from draft|
|[**get_callbacks**](ConversationsApi.html#get_callbacks) | **GET** /api/v2/conversations/callbacks | Get callback conversations|
|[**get_callbacks_callback_id**](ConversationsApi.html#get_callbacks_callback_id) | **GET** /api/v2/conversations/callbacks/{callbackId} | Get callback conversation|
|[**get_callbacks_callback_id_participants_participant_id_wrapup**](ConversationsApi.html#get_callbacks_callback_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|[**get_callbacks_callback_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_callbacks_callback_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|[**get_calls**](ConversationsApi.html#get_calls) | **GET** /api/v2/conversations/calls | Get recent conversations|
|[**get_calls_call_id**](ConversationsApi.html#get_calls_call_id) | **GET** /api/v2/conversations/calls/{callId} | Get call conversation|
|[**get_calls_call_id_participants_participant_id_wrapup**](ConversationsApi.html#get_calls_call_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/calls/{callId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|[**get_calls_call_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_calls_call_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/calls/{callId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|[**get_calls_history**](ConversationsApi.html#get_calls_history) | **GET** /api/v2/conversations/calls/history | Get call history|
|[**get_calls_maximumconferenceparties**](ConversationsApi.html#get_calls_maximumconferenceparties) | **GET** /api/v2/conversations/calls/maximumconferenceparties | Get the maximum number of participants that this user can have on a conference|
|[**get_chats**](ConversationsApi.html#get_chats) | **GET** /api/v2/conversations/chats | Get recent chat conversations|
|[**get_chats_chat_id**](ConversationsApi.html#get_chats_chat_id) | **GET** /api/v2/conversations/chats/{chatId} | Get chat conversation|
|[**get_chats_chat_id_participants_participant_id_wrapup**](ConversationsApi.html#get_chats_chat_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|[**get_chats_chat_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_chats_chat_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/chats/{chatId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|[**get_conversation_id**](ConversationsApi.html#get_conversation_id) | **GET** /api/v2/conversations/{conversationId} | Get conversation|
|[**get_conversation_id_participants_participant_id_wrapup**](ConversationsApi.html#get_conversation_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/{conversationId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|[**get_conversation_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_conversation_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/{conversationId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|[**get_conversations**](ConversationsApi.html#get_conversations) | **GET** /api/v2/conversations | Get conversations|
|[**get_conversations_conversation_id_details**](ConversationsApi.html#get_conversations_conversation_id_details) | **GET** /api/v2/analytics/conversations/{conversationId}/details | Get a conversation by id|
|[**get_emails**](ConversationsApi.html#get_emails) | **GET** /api/v2/conversations/emails | Get recent email conversations|
|[**get_emails_email_id**](ConversationsApi.html#get_emails_email_id) | **GET** /api/v2/conversations/emails/{emailId} | Get email conversation|
|[**get_emails_email_id_messages**](ConversationsApi.html#get_emails_email_id_messages) | **GET** /api/v2/conversations/emails/{emailId}/messages | Get conversation messages|
|[**get_emails_email_id_messages_draft**](ConversationsApi.html#get_emails_email_id_messages_draft) | **GET** /api/v2/conversations/emails/{emailId}/messages/draft | Get conversation draft reply|
|[**get_emails_email_id_messages_message_id**](ConversationsApi.html#get_emails_email_id_messages_message_id) | **GET** /api/v2/conversations/emails/{emailId}/messages/{messageId} | Get conversation message|
|[**get_emails_email_id_participants_participant_id_wrapup**](ConversationsApi.html#get_emails_email_id_participants_participant_id_wrapup) | **GET** /api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapup | Get the wrap-up for this conversation participant. |
|[**get_emails_email_id_participants_participant_id_wrapupcodes**](ConversationsApi.html#get_emails_email_id_participants_participant_id_wrapupcodes) | **GET** /api/v2/conversations/emails/{emailId}/participants/{participantId}/wrapupcodes | Get list of wrapup codes for this conversation participant|
|[**patch_callbacks_callback_id_participants_participant_id**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id) | **PATCH** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId} | Update conversation participant|
|[**patch_callbacks_callback_id_participants_participant_id_attributes**](ConversationsApi.html#patch_callbacks_callback_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|[**patch_calls_call_id**](ConversationsApi.html#patch_calls_call_id) | **PATCH** /api/v2/conversations/calls/{callId} | Update conversation|
|[**patch_calls_call_id_participants_participant_id**](ConversationsApi.html#patch_calls_call_id_participants_participant_id) | **PATCH** /api/v2/conversations/calls/{callId}/participants/{participantId} | Update conversation participant|
|[**patch_calls_call_id_participants_participant_id_attributes**](ConversationsApi.html#patch_calls_call_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/calls/{callId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|[**patch_calls_call_id_participants_participant_id_consult**](ConversationsApi.html#patch_calls_call_id_participants_participant_id_consult) | **PATCH** /api/v2/conversations/calls/{callId}/participants/{participantId}/consult | Change who can speak|
|[**patch_chats_chat_id_participants_participant_id**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id) | **PATCH** /api/v2/conversations/chats/{chatId}/participants/{participantId} | Update conversation participant|
|[**patch_chats_chat_id_participants_participant_id_attributes**](ConversationsApi.html#patch_chats_chat_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/chats/{chatId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|[**patch_conversation_id_participants_participant_id**](ConversationsApi.html#patch_conversation_id_participants_participant_id) | **PATCH** /api/v2/conversations/{conversationId}/participants/{participantId} | Update a participant.|
|[**patch_conversation_id_participants_participant_id_attributes**](ConversationsApi.html#patch_conversation_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/{conversationId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|[**patch_emails_email_id_participants_participant_id**](ConversationsApi.html#patch_emails_email_id_participants_participant_id) | **PATCH** /api/v2/conversations/emails/{emailId}/participants/{participantId} | Update conversation participant|
|[**patch_emails_email_id_participants_participant_id_attributes**](ConversationsApi.html#patch_emails_email_id_participants_participant_id_attributes) | **PATCH** /api/v2/conversations/emails/{emailId}/participants/{participantId}/attributes | Update the attributes on a conversation participant.|
|[**post_callbacks**](ConversationsApi.html#post_callbacks) | **POST** /api/v2/conversations/callbacks | Create a Callback|
|[**post_callbacks_callback_id_participants_participant_id_replace**](ConversationsApi.html#post_callbacks_callback_id_participants_participant_id_replace) | **POST** /api/v2/conversations/callbacks/{callbackId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|[**post_calls**](ConversationsApi.html#post_calls) | **POST** /api/v2/conversations/calls | Create a call conversation|
|[**post_calls_call_id**](ConversationsApi.html#post_calls_call_id) | **POST** /api/v2/conversations/calls/{callId} | Add a new call to a conversation|
|[**post_calls_call_id_participants**](ConversationsApi.html#post_calls_call_id_participants) | **POST** /api/v2/conversations/calls/{callId}/participants | Add participants to a conversation|
|[**post_calls_call_id_participants_participant_id_consult**](ConversationsApi.html#post_calls_call_id_participants_participant_id_consult) | **POST** /api/v2/conversations/calls/{callId}/participants/{participantId}/consult | Initiate and update consult transfer|
|[**post_calls_call_id_participants_participant_id_monitor**](ConversationsApi.html#post_calls_call_id_participants_participant_id_monitor) | **POST** /api/v2/conversations/calls/{callId}/participants/{participantId}/monitor | Listen in on the conversation from the point of view of a given participant.|
|[**post_calls_call_id_participants_participant_id_replace**](ConversationsApi.html#post_calls_call_id_participants_participant_id_replace) | **POST** /api/v2/conversations/calls/{callId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|[**post_chats_chat_id_participants_participant_id_replace**](ConversationsApi.html#post_chats_chat_id_participants_participant_id_replace) | **POST** /api/v2/conversations/chats/{chatId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|[**post_conversation_id_participants_participant_id_callbacks**](ConversationsApi.html#post_conversation_id_participants_participant_id_callbacks) | **POST** /api/v2/conversations/{conversationId}/participants/{participantId}/callbacks | Create a new callback for the specified participant on the conversation.|
|[**post_conversation_id_participants_participant_id_replace**](ConversationsApi.html#post_conversation_id_participants_participant_id_replace) | **POST** /api/v2/conversations/{conversationId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|[**post_conversations_aggregates_query**](ConversationsApi.html#post_conversations_aggregates_query) | **POST** /api/v2/analytics/conversations/aggregates/query | Query for conversation aggregates|
|[**post_conversations_conversation_id_details_properties**](ConversationsApi.html#post_conversations_conversation_id_details_properties) | **POST** /api/v2/analytics/conversations/{conversationId}/details/properties | Index conversation properties|
|[**post_conversations_details_query**](ConversationsApi.html#post_conversations_details_query) | **POST** /api/v2/analytics/conversations/details/query | Query for conversation details|
|[**post_emails_email_id_messages**](ConversationsApi.html#post_emails_email_id_messages) | **POST** /api/v2/conversations/emails/{emailId}/messages | Send an email reply|
|[**post_emails_email_id_participants_participant_id_replace**](ConversationsApi.html#post_emails_email_id_participants_participant_id_replace) | **POST** /api/v2/conversations/emails/{emailId}/participants/{participantId}/replace | Replace this participant with the specified user and/or address|
|[**post_faxes**](ConversationsApi.html#post_faxes) | **POST** /api/v2/conversations/faxes | Create Fax Conversation|
|[**put_emails_email_id_messages_draft**](ConversationsApi.html#put_emails_email_id_messages_draft) | **PUT** /api/v2/conversations/emails/{emailId}/messages/draft | Update conversation draft reply|
{: class="table table-striped"}

<a name="delete_calls_call_id_participants_participant_id_consult"></a>

## -String** delete_calls_call_id_participants_participant_id_consult(call_id, participant_id)

Cancel the transfer



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

participant_id = "participant_id_example" # String | 


begin
  #Cancel the transfer
  result = api_instance.delete_calls_call_id_participants_participant_id_consult(call_id, participant_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->delete_calls_call_id_participants_participant_id_consult: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **participant_id** | **String**|  | 
{: class="table table-striped"}


### Return type

**String**

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_conversation_id_participants_participant_id_codes_addcommunicationcode"></a>

## - delete_conversation_id_participants_participant_id_codes_addcommunicationcode(conversation_id, participant_id, add_communication_code)

Delete a code used to add a communication to this participant



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

conversation_id = "conversation_id_example" # String | conversation ID

participant_id = "participant_id_example" # String | participant ID

add_communication_code = "add_communication_code_example" # String | addCommunicationCode


begin
  #Delete a code used to add a communication to this participant
  api_instance.delete_conversation_id_participants_participant_id_codes_addcommunicationcode(conversation_id, participant_id, add_communication_code)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->delete_conversation_id_participants_participant_id_codes_addcommunicationcode: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversation ID | 
 **participant_id** | **String**| participant ID | 
 **add_communication_code** | **String**| addCommunicationCode | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="delete_emails_email_id_messages_draft_attachments_attachment_id"></a>

## -String** delete_emails_email_id_messages_draft_attachments_attachment_id(email_id, attachment_id)

Delete attachment from draft



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 

attachment_id = "attachment_id_example" # String | 


begin
  #Delete attachment from draft
  result = api_instance.delete_emails_email_id_messages_draft_attachments_attachment_id(email_id, attachment_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->delete_emails_email_id_messages_draft_attachments_attachment_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
 **attachment_id** | **String**|  | 
{: class="table table-striped"}


### Return type

**String**

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_callbacks"></a>

## -[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html) get_callbacks

Get callback conversations



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

begin
  #Get callback conversations
  result = api_instance.get_callbacks
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_callbacks: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

[**CallbackConversationEntityListing**](CallbackConversationEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_callbacks_callback_id"></a>

## -[**CallbackConversation**](CallbackConversation.html) get_callbacks_callback_id(callback_id)

Get callback conversation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

callback_id = "callback_id_example" # String | 


begin
  #Get callback conversation
  result = api_instance.get_callbacks_callback_id(callback_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_callbacks_callback_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **callback_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**CallbackConversation**](CallbackConversation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_callbacks_callback_id_participants_participant_id_wrapup"></a>

## -[**WrapupCode**](WrapupCode.html) get_callbacks_callback_id_participants_participant_id_wrapup(callback_id, participant_id, opts)

Get the wrap-up for this conversation participant. 



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

callback_id = "callback_id_example" # String | 

participant_id = "participant_id_example" # String | 

opts = { 
  provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
}

begin
  #Get the wrap-up for this conversation participant. 
  result = api_instance.get_callbacks_callback_id_participants_participant_id_wrapup(callback_id, participant_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_callbacks_callback_id_participants_participant_id_wrapup: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **callback_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
{: class="table table-striped"}


### Return type

[**WrapupCode**](WrapupCode.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_callbacks_callback_id_participants_participant_id_wrapupcodes"></a>

## -[**WrapupCode**](WrapupCode.html) get_callbacks_callback_id_participants_participant_id_wrapupcodes(callback_id, participant_id)

Get list of wrapup codes for this conversation participant



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

callback_id = "callback_id_example" # String | 

participant_id = "participant_id_example" # String | 


begin
  #Get list of wrapup codes for this conversation participant
  result = api_instance.get_callbacks_callback_id_participants_participant_id_wrapupcodes(callback_id, participant_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_callbacks_callback_id_participants_participant_id_wrapupcodes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **callback_id** | **String**|  | 
 **participant_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**WrapupCode**](WrapupCode.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_calls"></a>

## -[**CallConversationEntityListing**](CallConversationEntityListing.html) get_calls

Get recent conversations



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

begin
  #Get recent conversations
  result = api_instance.get_calls
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_calls: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

[**CallConversationEntityListing**](CallConversationEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_calls_call_id"></a>

## -[**CallConversation**](CallConversation.html) get_calls_call_id(call_id)

Get call conversation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 


begin
  #Get call conversation
  result = api_instance.get_calls_call_id(call_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_calls_call_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**CallConversation**](CallConversation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_calls_call_id_participants_participant_id_wrapup"></a>

## -[**WrapupCode**](WrapupCode.html) get_calls_call_id_participants_participant_id_wrapup(call_id, participant_id, opts)

Get the wrap-up for this conversation participant. 



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

participant_id = "participant_id_example" # String | 

opts = { 
  provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
}

begin
  #Get the wrap-up for this conversation participant. 
  result = api_instance.get_calls_call_id_participants_participant_id_wrapup(call_id, participant_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_calls_call_id_participants_participant_id_wrapup: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
{: class="table table-striped"}


### Return type

[**WrapupCode**](WrapupCode.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_calls_call_id_participants_participant_id_wrapupcodes"></a>

## -[**WrapupCode**](WrapupCode.html) get_calls_call_id_participants_participant_id_wrapupcodes(call_id, participant_id)

Get list of wrapup codes for this conversation participant



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

participant_id = "participant_id_example" # String | 


begin
  #Get list of wrapup codes for this conversation participant
  result = api_instance.get_calls_call_id_participants_participant_id_wrapupcodes(call_id, participant_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_calls_call_id_participants_participant_id_wrapupcodes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **participant_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**WrapupCode**](WrapupCode.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_calls_history"></a>

## -[**CallConversationEntityListing**](CallConversationEntityListing.html) get_calls_history(opts)

Get call history



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

opts = { 
  page_size: 25, # Integer | Page size
  page_number: 1, # Integer | Page number
  interval: "interval_example" # String | Interval string; format is ISO-8601. Separate start and end times with forward slash '/'
}

begin
  #Get call history
  result = api_instance.get_calls_history(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_calls_history: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **page_size** | **Integer**| Page size | [optional] [default to 25]
 **page_number** | **Integer**| Page number | [optional] [default to 1]
 **interval** | **String**| Interval string; format is ISO-8601. Separate start and end times with forward slash &#39;/&#39; | [optional] 
{: class="table table-striped"}


### Return type

[**CallConversationEntityListing**](CallConversationEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_calls_maximumconferenceparties"></a>

## -[**MaxParticipants**](MaxParticipants.html) get_calls_maximumconferenceparties

Get the maximum number of participants that this user can have on a conference



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

begin
  #Get the maximum number of participants that this user can have on a conference
  result = api_instance.get_calls_maximumconferenceparties
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_calls_maximumconferenceparties: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

[**MaxParticipants**](MaxParticipants.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_chats"></a>

## -[**ChatConversationEntityListing**](ChatConversationEntityListing.html) get_chats

Get recent chat conversations



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

begin
  #Get recent chat conversations
  result = api_instance.get_chats
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_chats: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

[**ChatConversationEntityListing**](ChatConversationEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_chats_chat_id"></a>

## -[**ChatConversation**](ChatConversation.html) get_chats_chat_id(chat_id)

Get chat conversation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

chat_id = "chat_id_example" # String | 


begin
  #Get chat conversation
  result = api_instance.get_chats_chat_id(chat_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_chats_chat_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **chat_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**ChatConversation**](ChatConversation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_chats_chat_id_participants_participant_id_wrapup"></a>

## -[**WrapupCode**](WrapupCode.html) get_chats_chat_id_participants_participant_id_wrapup(chat_id, participant_id, opts)

Get the wrap-up for this conversation participant. 



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

chat_id = "chat_id_example" # String | 

participant_id = "participant_id_example" # String | 

opts = { 
  provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
}

begin
  #Get the wrap-up for this conversation participant. 
  result = api_instance.get_chats_chat_id_participants_participant_id_wrapup(chat_id, participant_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_chats_chat_id_participants_participant_id_wrapup: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **chat_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
{: class="table table-striped"}


### Return type

[**WrapupCode**](WrapupCode.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_chats_chat_id_participants_participant_id_wrapupcodes"></a>

## -[**WrapupCode**](WrapupCode.html) get_chats_chat_id_participants_participant_id_wrapupcodes(chat_id, participant_id)

Get list of wrapup codes for this conversation participant



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

chat_id = "chat_id_example" # String | 

participant_id = "participant_id_example" # String | 


begin
  #Get list of wrapup codes for this conversation participant
  result = api_instance.get_chats_chat_id_participants_participant_id_wrapupcodes(chat_id, participant_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_chats_chat_id_participants_participant_id_wrapupcodes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **chat_id** | **String**|  | 
 **participant_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**WrapupCode**](WrapupCode.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_conversation_id"></a>

## -[**Conversation**](Conversation.html) get_conversation_id(conversation_id)

Get conversation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

conversation_id = "conversation_id_example" # String | conversation ID


begin
  #Get conversation
  result = api_instance.get_conversation_id(conversation_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_conversation_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversation ID | 
{: class="table table-striped"}


### Return type

[**Conversation**](Conversation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_conversation_id_participants_participant_id_wrapup"></a>

## -[**WrapupCode**](WrapupCode.html) get_conversation_id_participants_participant_id_wrapup(conversation_id, participant_id, opts)

Get the wrap-up for this conversation participant. 



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

conversation_id = "conversation_id_example" # String | conversation ID

participant_id = "participant_id_example" # String | participant ID

opts = { 
  provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
}

begin
  #Get the wrap-up for this conversation participant. 
  result = api_instance.get_conversation_id_participants_participant_id_wrapup(conversation_id, participant_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_conversation_id_participants_participant_id_wrapup: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversation ID | 
 **participant_id** | **String**| participant ID | 
 **provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
{: class="table table-striped"}


### Return type

[**WrapupCode**](WrapupCode.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_conversation_id_participants_participant_id_wrapupcodes"></a>

## -[**WrapupCode**](WrapupCode.html) get_conversation_id_participants_participant_id_wrapupcodes(conversation_id, participant_id)

Get list of wrapup codes for this conversation participant



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

conversation_id = "conversation_id_example" # String | conversation ID

participant_id = "participant_id_example" # String | participant ID


begin
  #Get list of wrapup codes for this conversation participant
  result = api_instance.get_conversation_id_participants_participant_id_wrapupcodes(conversation_id, participant_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_conversation_id_participants_participant_id_wrapupcodes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversation ID | 
 **participant_id** | **String**| participant ID | 
{: class="table table-striped"}


### Return type

[**WrapupCode**](WrapupCode.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_conversations"></a>

## -[**ConversationEntityListing**](ConversationEntityListing.html) get_conversations(opts)

Get conversations



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

opts = { 
  communication_type: "communication_type_example" # String | Call or Chat communication filtering
}

begin
  #Get conversations
  result = api_instance.get_conversations(opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_conversations: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **communication_type** | **String**| Call or Chat communication filtering | [optional] 
{: class="table table-striped"}


### Return type

[**ConversationEntityListing**](ConversationEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_conversations_conversation_id_details"></a>

## -[**AnalyticsConversation**](AnalyticsConversation.html) get_conversations_conversation_id_details(conversation_id)

Get a conversation by id



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

conversation_id = "conversation_id_example" # String | conversationId


begin
  #Get a conversation by id
  result = api_instance.get_conversations_conversation_id_details(conversation_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_conversations_conversation_id_details: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversationId | 
{: class="table table-striped"}


### Return type

[**AnalyticsConversation**](AnalyticsConversation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_emails"></a>

## -[**EmailConversationEntityListing**](EmailConversationEntityListing.html) get_emails

Get recent email conversations



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

begin
  #Get recent email conversations
  result = api_instance.get_emails
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_emails: #{e}"
end
~~~

### Parameters
This endpoint does not need any parameter.
{: class="table table-striped"}


### Return type

[**EmailConversationEntityListing**](EmailConversationEntityListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_emails_email_id"></a>

## -[**EmailConversation**](EmailConversation.html) get_emails_email_id(email_id)

Get email conversation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 


begin
  #Get email conversation
  result = api_instance.get_emails_email_id(email_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_emails_email_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**EmailConversation**](EmailConversation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_emails_email_id_messages"></a>

## -[**EmailMessageListing**](EmailMessageListing.html) get_emails_email_id_messages(email_id)

Get conversation messages



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 


begin
  #Get conversation messages
  result = api_instance.get_emails_email_id_messages(email_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_emails_email_id_messages: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**EmailMessageListing**](EmailMessageListing.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_emails_email_id_messages_draft"></a>

## -[**EmailMessage**](EmailMessage.html) get_emails_email_id_messages_draft(email_id)

Get conversation draft reply



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 


begin
  #Get conversation draft reply
  result = api_instance.get_emails_email_id_messages_draft(email_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_emails_email_id_messages_draft: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**EmailMessage**](EmailMessage.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_emails_email_id_messages_message_id"></a>

## -[**EmailMessage**](EmailMessage.html) get_emails_email_id_messages_message_id(email_id, message_id)

Get conversation message



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 

message_id = "message_id_example" # String | 


begin
  #Get conversation message
  result = api_instance.get_emails_email_id_messages_message_id(email_id, message_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_emails_email_id_messages_message_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
 **message_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**EmailMessage**](EmailMessage.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_emails_email_id_participants_participant_id_wrapup"></a>

## -[**WrapupCode**](WrapupCode.html) get_emails_email_id_participants_participant_id_wrapup(email_id, participant_id, opts)

Get the wrap-up for this conversation participant. 



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 

participant_id = "participant_id_example" # String | 

opts = { 
  provisional: false # BOOLEAN | Indicates if the wrap-up code is provisional.
}

begin
  #Get the wrap-up for this conversation participant. 
  result = api_instance.get_emails_email_id_participants_participant_id_wrapup(email_id, participant_id, opts)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_emails_email_id_participants_participant_id_wrapup: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **provisional** | **BOOLEAN**| Indicates if the wrap-up code is provisional. | [optional] [default to false]
{: class="table table-striped"}


### Return type

[**WrapupCode**](WrapupCode.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="get_emails_email_id_participants_participant_id_wrapupcodes"></a>

## -[**WrapupCode**](WrapupCode.html) get_emails_email_id_participants_participant_id_wrapupcodes(email_id, participant_id)

Get list of wrapup codes for this conversation participant



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 

participant_id = "participant_id_example" # String | 


begin
  #Get list of wrapup codes for this conversation participant
  result = api_instance.get_emails_email_id_participants_participant_id_wrapupcodes(email_id, participant_id)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->get_emails_email_id_participants_participant_id_wrapupcodes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
 **participant_id** | **String**|  | 
{: class="table table-striped"}


### Return type

[**WrapupCode**](WrapupCode.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_callbacks_callback_id_participants_participant_id"></a>

## - patch_callbacks_callback_id_participants_participant_id(callback_id, participant_id, body)

Update conversation participant



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

callback_id = "callback_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant


begin
  #Update conversation participant
  api_instance.patch_callbacks_callback_id_participants_participant_id(callback_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_callbacks_callback_id_participants_participant_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **callback_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_callbacks_callback_id_participants_participant_id_attributes"></a>

## - patch_callbacks_callback_id_participants_participant_id_attributes(callback_id, participant_id, body)

Update the attributes on a conversation participant.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

callback_id = "callback_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Attributes


begin
  #Update the attributes on a conversation participant.
  api_instance.patch_callbacks_callback_id_participants_participant_id_attributes(callback_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_callbacks_callback_id_participants_participant_id_attributes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **callback_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Attributes | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_calls_call_id"></a>

## -[**Conversation**](Conversation.html) patch_calls_call_id(call_id, body)

Update conversation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

body = PureCloud::Conversation.new # Conversation | Conversation


begin
  #Update conversation
  result = api_instance.patch_calls_call_id(call_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_calls_call_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **body** | [**Conversation**](Conversation.html)| Conversation | 
{: class="table table-striped"}


### Return type

[**Conversation**](Conversation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_calls_call_id_participants_participant_id"></a>

## - patch_calls_call_id_participants_participant_id(call_id, participant_id, body)

Update conversation participant



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Participant request


begin
  #Update conversation participant
  api_instance.patch_calls_call_id_participants_participant_id(call_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_calls_call_id_participants_participant_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Participant request | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_calls_call_id_participants_participant_id_attributes"></a>

## - patch_calls_call_id_participants_participant_id_attributes(call_id, participant_id, body)

Update the attributes on a conversation participant.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes


begin
  #Update the attributes on a conversation participant.
  api_instance.patch_calls_call_id_participants_participant_id_attributes(call_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_calls_call_id_participants_participant_id_attributes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_calls_call_id_participants_participant_id_consult"></a>

## -[**ConsultTransferResponse**](ConsultTransferResponse.html) patch_calls_call_id_participants_participant_id_consult(call_id, participant_id, body)

Change who can speak



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::ConsultTransferUpdate.new # ConsultTransferUpdate | new speak to


begin
  #Change who can speak
  result = api_instance.patch_calls_call_id_participants_participant_id_consult(call_id, participant_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_calls_call_id_participants_participant_id_consult: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**ConsultTransferUpdate**](ConsultTransferUpdate.html)| new speak to | 
{: class="table table-striped"}


### Return type

[**ConsultTransferResponse**](ConsultTransferResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_chats_chat_id_participants_participant_id"></a>

## - patch_chats_chat_id_participants_participant_id(chat_id, participant_id, body)

Update conversation participant



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

chat_id = "chat_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update request


begin
  #Update conversation participant
  api_instance.patch_chats_chat_id_participants_participant_id(chat_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_chats_chat_id_participants_participant_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **chat_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_chats_chat_id_participants_participant_id_attributes"></a>

## - patch_chats_chat_id_participants_participant_id_attributes(chat_id, participant_id, body)

Update the attributes on a conversation participant.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

chat_id = "chat_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes


begin
  #Update the attributes on a conversation participant.
  api_instance.patch_chats_chat_id_participants_participant_id_attributes(chat_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_chats_chat_id_participants_participant_id_attributes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **chat_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_conversation_id_participants_participant_id"></a>

## - patch_conversation_id_participants_participant_id(conversation_id, participant_id, body)

Update a participant.

Update conversation participant.

### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

conversation_id = "conversation_id_example" # String | conversation ID

participant_id = "participant_id_example" # String | participant ID

body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update request


begin
  #Update a participant.
  api_instance.patch_conversation_id_participants_participant_id(conversation_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_conversation_id_participants_participant_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversation ID | 
 **participant_id** | **String**| participant ID | 
 **body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_conversation_id_participants_participant_id_attributes"></a>

## - patch_conversation_id_participants_participant_id_attributes(conversation_id, participant_id, body)

Update the attributes on a conversation participant.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

conversation_id = "conversation_id_example" # String | conversation ID

participant_id = "participant_id_example" # String | participant ID

body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes


begin
  #Update the attributes on a conversation participant.
  api_instance.patch_conversation_id_participants_participant_id_attributes(conversation_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_conversation_id_participants_participant_id_attributes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversation ID | 
 **participant_id** | **String**| participant ID | 
 **body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_emails_email_id_participants_participant_id"></a>

## - patch_emails_email_id_participants_participant_id(email_id, participant_id, body)

Update conversation participant



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::MediaParticipantRequest.new # MediaParticipantRequest | Update request


begin
  #Update conversation participant
  api_instance.patch_emails_email_id_participants_participant_id(email_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_emails_email_id_participants_participant_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**MediaParticipantRequest**](MediaParticipantRequest.html)| Update request | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="patch_emails_email_id_participants_participant_id_attributes"></a>

## - patch_emails_email_id_participants_participant_id_attributes(email_id, participant_id, body)

Update the attributes on a conversation participant.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::ParticipantAttributes.new # ParticipantAttributes | Participant attributes


begin
  #Update the attributes on a conversation participant.
  api_instance.patch_emails_email_id_participants_participant_id_attributes(email_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->patch_emails_email_id_participants_participant_id_attributes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**ParticipantAttributes**](ParticipantAttributes.html)| Participant attributes | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_callbacks"></a>

## -[**CreateCallbackResponse**](CreateCallbackResponse.html) post_callbacks(body)

Create a Callback



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

body = PureCloud::CreateCallbackCommand.new # CreateCallbackCommand | Callback


begin
  #Create a Callback
  result = api_instance.post_callbacks(body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_callbacks: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreateCallbackCommand**](CreateCallbackCommand.html)| Callback | 
{: class="table table-striped"}


### Return type

[**CreateCallbackResponse**](CreateCallbackResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_callbacks_callback_id_participants_participant_id_replace"></a>

## - post_callbacks_callback_id_participants_participant_id_replace(callback_id, participant_id, body)

Replace this participant with the specified user and/or address



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

callback_id = "callback_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::TransferRequest.new # TransferRequest | Transfer request


begin
  #Replace this participant with the specified user and/or address
  api_instance.post_callbacks_callback_id_participants_participant_id_replace(callback_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_callbacks_callback_id_participants_participant_id_replace: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **callback_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**TransferRequest**](TransferRequest.html)| Transfer request | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_calls"></a>

## -[**CreateCallResponse**](CreateCallResponse.html) post_calls(body)

Create a call conversation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

body = PureCloud::CreateCallRequest.new # CreateCallRequest | Call request


begin
  #Create a call conversation
  result = api_instance.post_calls(body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_calls: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreateCallRequest**](CreateCallRequest.html)| Call request | 
{: class="table table-striped"}


### Return type

[**CreateCallResponse**](CreateCallResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_calls_call_id"></a>

## -[**Conversation**](Conversation.html) post_calls_call_id(call_id, body)

Add a new call to a conversation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

body = PureCloud::CallCommand.new # CallCommand | Conversation


begin
  #Add a new call to a conversation
  result = api_instance.post_calls_call_id(call_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_calls_call_id: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **body** | [**CallCommand**](CallCommand.html)| Conversation | 
{: class="table table-striped"}


### Return type

[**Conversation**](Conversation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_calls_call_id_participants"></a>

## -[**Conversation**](Conversation.html) post_calls_call_id_participants(call_id, body)

Add participants to a conversation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

body = PureCloud::Conversation.new # Conversation | Conversation


begin
  #Add participants to a conversation
  result = api_instance.post_calls_call_id_participants(call_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_calls_call_id_participants: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **body** | [**Conversation**](Conversation.html)| Conversation | 
{: class="table table-striped"}


### Return type

[**Conversation**](Conversation.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_calls_call_id_participants_participant_id_consult"></a>

## -[**ConsultTransferResponse**](ConsultTransferResponse.html) post_calls_call_id_participants_participant_id_consult(call_id, participant_id, body)

Initiate and update consult transfer



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::ConsultTransfer.new # ConsultTransfer | Destination address & initial speak to


begin
  #Initiate and update consult transfer
  result = api_instance.post_calls_call_id_participants_participant_id_consult(call_id, participant_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_calls_call_id_participants_participant_id_consult: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**ConsultTransfer**](ConsultTransfer.html)| Destination address &amp; initial speak to | 
{: class="table table-striped"}


### Return type

[**ConsultTransferResponse**](ConsultTransferResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_calls_call_id_participants_participant_id_monitor"></a>

## - post_calls_call_id_participants_participant_id_monitor(call_id, participant_id)

Listen in on the conversation from the point of view of a given participant.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

participant_id = "participant_id_example" # String | 


begin
  #Listen in on the conversation from the point of view of a given participant.
  api_instance.post_calls_call_id_participants_participant_id_monitor(call_id, participant_id)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_calls_call_id_participants_participant_id_monitor: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **participant_id** | **String**|  | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_calls_call_id_participants_participant_id_replace"></a>

## - post_calls_call_id_participants_participant_id_replace(call_id, participant_id, body)

Replace this participant with the specified user and/or address



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

call_id = "call_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::TransferRequest.new # TransferRequest | Transfer request


begin
  #Replace this participant with the specified user and/or address
  api_instance.post_calls_call_id_participants_participant_id_replace(call_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_calls_call_id_participants_participant_id_replace: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **call_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**TransferRequest**](TransferRequest.html)| Transfer request | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_chats_chat_id_participants_participant_id_replace"></a>

## - post_chats_chat_id_participants_participant_id_replace(chat_id, participant_id, body)

Replace this participant with the specified user and/or address



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

chat_id = "chat_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::TransferRequest.new # TransferRequest | Transfer request


begin
  #Replace this participant with the specified user and/or address
  api_instance.post_chats_chat_id_participants_participant_id_replace(chat_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_chats_chat_id_participants_participant_id_replace: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **chat_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**TransferRequest**](TransferRequest.html)| Transfer request | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_conversation_id_participants_participant_id_callbacks"></a>

## - post_conversation_id_participants_participant_id_callbacks(conversation_id, participant_id, opts)

Create a new callback for the specified participant on the conversation.



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

conversation_id = "conversation_id_example" # String | conversation ID

participant_id = "participant_id_example" # String | participant ID

opts = { 
  body: PureCloud::CreateCallbackCommand.new # CreateCallbackCommand | 
}

begin
  #Create a new callback for the specified participant on the conversation.
  api_instance.post_conversation_id_participants_participant_id_callbacks(conversation_id, participant_id, opts)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_conversation_id_participants_participant_id_callbacks: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversation ID | 
 **participant_id** | **String**| participant ID | 
 **body** | [**CreateCallbackCommand**](CreateCallbackCommand.html)|  | [optional] 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_conversation_id_participants_participant_id_replace"></a>

## - post_conversation_id_participants_participant_id_replace(conversation_id, participant_id, body)

Replace this participant with the specified user and/or address



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

conversation_id = "conversation_id_example" # String | conversation ID

participant_id = "participant_id_example" # String | participant ID

body = PureCloud::TransferRequest.new # TransferRequest | Transfer request


begin
  #Replace this participant with the specified user and/or address
  api_instance.post_conversation_id_participants_participant_id_replace(conversation_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_conversation_id_participants_participant_id_replace: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversation ID | 
 **participant_id** | **String**| participant ID | 
 **body** | [**TransferRequest**](TransferRequest.html)| Transfer request | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_conversations_aggregates_query"></a>

## -[**AggregateQueryResponse**](AggregateQueryResponse.html) post_conversations_aggregates_query(body)

Query for conversation aggregates



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

body = PureCloud::AggregationQuery.new # AggregationQuery | query


begin
  #Query for conversation aggregates
  result = api_instance.post_conversations_aggregates_query(body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_conversations_aggregates_query: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**AggregationQuery**](AggregationQuery.html)| query | 
{: class="table table-striped"}


### Return type

[**AggregateQueryResponse**](AggregateQueryResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_conversations_conversation_id_details_properties"></a>

## -[**PropertyIndexRequest**](PropertyIndexRequest.html) post_conversations_conversation_id_details_properties(conversation_id, body)

Index conversation properties



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

conversation_id = "conversation_id_example" # String | conversationId

body = PureCloud::PropertyIndexRequest.new # PropertyIndexRequest | request


begin
  #Index conversation properties
  result = api_instance.post_conversations_conversation_id_details_properties(conversation_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_conversations_conversation_id_details_properties: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **conversation_id** | **String**| conversationId | 
 **body** | [**PropertyIndexRequest**](PropertyIndexRequest.html)| request | 
{: class="table table-striped"}


### Return type

[**PropertyIndexRequest**](PropertyIndexRequest.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_conversations_details_query"></a>

## -[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html) post_conversations_details_query(body)

Query for conversation details



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

body = PureCloud::ConversationQuery.new # ConversationQuery | query


begin
  #Query for conversation details
  result = api_instance.post_conversations_details_query(body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_conversations_details_query: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ConversationQuery**](ConversationQuery.html)| query | 
{: class="table table-striped"}


### Return type

[**AnalyticsConversationQueryResponse**](AnalyticsConversationQueryResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_emails_email_id_messages"></a>

## -[**EmailMessage**](EmailMessage.html) post_emails_email_id_messages(email_id, body)

Send an email reply



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 

body = PureCloud::EmailMessage.new # EmailMessage | Reply


begin
  #Send an email reply
  result = api_instance.post_emails_email_id_messages(email_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_emails_email_id_messages: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
 **body** | [**EmailMessage**](EmailMessage.html)| Reply | 
{: class="table table-striped"}


### Return type

[**EmailMessage**](EmailMessage.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_emails_email_id_participants_participant_id_replace"></a>

## - post_emails_email_id_participants_participant_id_replace(email_id, participant_id, body)

Replace this participant with the specified user and/or address



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 

participant_id = "participant_id_example" # String | 

body = PureCloud::TransferRequest.new # TransferRequest | Transfer request


begin
  #Replace this participant with the specified user and/or address
  api_instance.post_emails_email_id_participants_participant_id_replace(email_id, participant_id, body)
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_emails_email_id_participants_participant_id_replace: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
 **participant_id** | **String**|  | 
 **body** | [**TransferRequest**](TransferRequest.html)| Transfer request | 
{: class="table table-striped"}


### Return type

nil (empty response body)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="post_faxes"></a>

## -[**FaxSendResponse**](FaxSendResponse.html) post_faxes(body)

Create Fax Conversation



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

body = PureCloud::FaxSendRequest.new # FaxSendRequest | Fax


begin
  #Create Fax Conversation
  result = api_instance.post_faxes(body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->post_faxes: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**FaxSendRequest**](FaxSendRequest.html)| Fax | 
{: class="table table-striped"}


### Return type

[**FaxSendResponse**](FaxSendResponse.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json



<a name="put_emails_email_id_messages_draft"></a>

## -[**EmailMessage**](EmailMessage.html) put_emails_email_id_messages_draft(email_id, body)

Update conversation draft reply



### Example
~~~ruby
# load the gem
require 'purecloud'
# setup authorization
@secret = ENV['PURECLOUD_SECRET']
@id = ENV['PURECLOUD_CLIENT_ID']
environment = "mypurecloud.com"

@authToken = PureCloud.authenticate_with_client_credentials @id, @secret, environment

PureCloud.configure do |config|
  config.access_token = @authToken
end

api_instance = PureCloud::ConversationsApi.new

email_id = "email_id_example" # String | 

body = PureCloud::EmailMessage.new # EmailMessage | Draft


begin
  #Update conversation draft reply
  result = api_instance.put_emails_email_id_messages_draft(email_id, body)
  p result
rescue PureCloud::ApiError => e
  puts "Exception when calling ConversationsApi->put_emails_email_id_messages_draft: #{e}"
end
~~~

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **email_id** | **String**|  | 
 **body** | [**EmailMessage**](EmailMessage.html)| Draft | 
{: class="table table-striped"}


### Return type

[**EmailMessage**](EmailMessage.html)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json