Skip to content

MessageMediaApi.md

Latest commit

 

History

History
271 lines (188 loc) · 6.74 KB

MessageMediaApi.md

File metadata and controls

271 lines (188 loc) · 6.74 KB
Raw

MessageMediaApi

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

Method HTTP request Description
messageMediaCreate POST /v4/api/message-media
messageMediaDelete DELETE /v4/api/message-media/{id}
messageMediaGet GET /v4/api/message-media/{id}
messageMediaSearch GET /v4/api/message-media
messageMediaUpdate PUT /v4/api/message-media/{id}

messageMediaCreate

MessageMedia messageMediaCreate(body)

Create a message media.

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.MessageMediaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessageMediaApi apiInstance = new MessageMediaApi();
MessageMediaCreate body = new MessageMediaCreate(); // MessageMediaCreate | 
try {
    MessageMedia result = apiInstance.messageMediaCreate(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessageMediaApi#messageMediaCreate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body MessageMediaCreate [optional]

Return type

MessageMedia

Authorization

Bearer

HTTP request headers

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

messageMediaDelete

messageMediaDelete(id)

Remove a Message Media.

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.MessageMediaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessageMediaApi apiInstance = new MessageMediaApi();
String id = "id_example"; // String | 
try {
    apiInstance.messageMediaDelete(id);
} catch (ApiException e) {
    System.err.println("Exception when calling MessageMediaApi#messageMediaDelete");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String

Return type

null (empty response body)

Authorization

Bearer

HTTP request headers

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

messageMediaGet

MessageMedia messageMediaGet(id)

Retrieve message media.

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.MessageMediaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


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

Parameters

Name Type Description Notes
id String

Return type

MessageMedia

Authorization

Bearer

HTTP request headers

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

messageMediaSearch

MessageMediaPaginationResponse messageMediaSearch(filter, query, page, perPage, sort)

Search message media.

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.MessageMediaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessageMediaApi apiInstance = new MessageMediaApi();
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 {
    MessageMediaPaginationResponse result = apiInstance.messageMediaSearch(filter, query, page, perPage, sort);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessageMediaApi#messageMediaSearch");
    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

MessageMediaPaginationResponse

Authorization

Bearer

HTTP request headers

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

messageMediaUpdate

MessageMedia messageMediaUpdate(id, body)

Update a message media.

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.MessageMediaApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();


MessageMediaApi apiInstance = new MessageMediaApi();
String id = "id_example"; // String | 
MessageMediaUpdate body = new MessageMediaUpdate(); // MessageMediaUpdate | 
try {
    MessageMedia result = apiInstance.messageMediaUpdate(id, body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling MessageMediaApi#messageMediaUpdate");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
id String
body MessageMediaUpdate [optional]

Return type

MessageMedia

Authorization

Bearer

HTTP request headers

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