Skip to content

ConversationApi.md

Latest commit

 

History

History
221 lines (154 loc) · 5.69 KB

ConversationApi.md

File metadata and controls

221 lines (154 loc) · 5.69 KB
Raw

ConversationApi

All URIs are relative to https://app.statflo.com

Method HTTP request Description
conversationGet GET /v4/api/conversation/{id}
conversationSearch GET /v4/api/conversation
conversationUpdate PUT /v4/api/conversation/{id}
postV4ApiConversationSearch POST /v4/api/conversation

conversationGet

Conversation conversationGet(id)

Retrieve a conversation.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.ConversationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConversationApi apiInstance = new ConversationApi();
String id = "id_example"; // String | 
try {
    Conversation result = apiInstance.conversationGet(id);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConversationApi#conversationGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

Conversation

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

conversationSearch

ConversationPaginationResponse conversationSearch(filter, query, page, perPage, sort)

Search conversations.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.ConversationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConversationApi apiInstance = new ConversationApi();
java.util.HashMap filter = new java.util.HashMap(); // java.util.HashMap | 
String query = "query_example"; // String | 
Integer page = 56; // Integer | 
Integer perPage = 56; // Integer | 
String sort = "sort_example"; // String | 
try {
    ConversationPaginationResponse result = apiInstance.conversationSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConversationApi#conversationSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
filter java.util.HashMap [optional]
query String [optional]
page Integer [optional]
perPage Integer [optional]
sort String [optional]

Return type

ConversationPaginationResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

conversationUpdate

Conversation conversationUpdate(id, body)

Update a conversation.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.ConversationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConversationApi apiInstance = new ConversationApi();
String id = "id_example"; // String | 
ConversationUpdate body = new ConversationUpdate(); // ConversationUpdate | 
try {
    Conversation result = apiInstance.conversationUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConversationApi#conversationUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body ConversationUpdate [optional]

Return type

Conversation

Authorization

Bearer

HTTP request headers

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

postV4ApiConversationSearch

Conversation postV4ApiConversationSearch(body)

Create a conversation.

Example

// Import classes:
//import com.statflo.client.ApiClient;
//import com.statflo.client.ApiException;
//import com.statflo.client.Configuration;
//import com.statflo.client.auth.*;
//import com.statflo.client.api.ConversationApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


ConversationApi apiInstance = new ConversationApi();
ConversationCreate body = new ConversationCreate(); // ConversationCreate | 
try {
    Conversation result = apiInstance.postV4ApiConversationSearch(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling ConversationApi#postV4ApiConversationSearch");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body ConversationCreate [optional]

Return type

Conversation

Authorization

Bearer

HTTP request headers

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