BlacklistApi.md

BlacklistApi

All URIs are relative to https://api.messente.com/v1

Method	HTTP request	Description
addToBlacklist	POST /phonebook/blacklist
fetchBlacklist	GET /phonebook/blacklist
isBlacklisted	GET /phonebook/blacklist/{phone_number}
removeFromBlacklist	DELETE /phonebook/blacklist/{phone_number}

addToBlacklist

addToBlacklist(numberToBlacklist)

Adds a phone number to the blacklist.

Example

// Import classes:
//import com.messente.ApiClient;
//import com.messente.ApiException;
//import com.messente.Configuration;
//import com.messente.auth.*;
//import com.messente.phonebook.BlacklistApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

BlacklistApi apiInstance = new BlacklistApi();
NumberToBlacklist numberToBlacklist = new NumberToBlacklist(); // NumberToBlacklist | Phone number to be blacklisted
try {
    apiInstance.addToBlacklist(numberToBlacklist);
} catch (ApiException e) {
    System.err.println("Exception when calling BlacklistApi#addToBlacklist");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
numberToBlacklist	NumberToBlacklist	Phone number to be blacklisted

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

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

fetchBlacklist

FetchBlacklistSuccess fetchBlacklist()

Returns all blacklisted phone numbers.

Example

// Import classes:
//import com.messente.ApiClient;
//import com.messente.ApiException;
//import com.messente.Configuration;
//import com.messente.auth.*;
//import com.messente.phonebook.BlacklistApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

BlacklistApi apiInstance = new BlacklistApi();
try {
    FetchBlacklistSuccess result = apiInstance.fetchBlacklist();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling BlacklistApi#fetchBlacklist");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

FetchBlacklistSuccess

Authorization

basicAuth

HTTP request headers

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

isBlacklisted

isBlacklisted(phoneNumber)

Checks if a phone number is blacklisted.

Example

// Import classes:
//import com.messente.ApiClient;
//import com.messente.ApiException;
//import com.messente.Configuration;
//import com.messente.auth.*;
//import com.messente.phonebook.BlacklistApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

BlacklistApi apiInstance = new BlacklistApi();
String phoneNumber = "phoneNumber_example"; // String | A phone number
try {
    apiInstance.isBlacklisted(phoneNumber);
} catch (ApiException e) {
    System.err.println("Exception when calling BlacklistApi#isBlacklisted");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
phoneNumber	String	A phone number

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

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

removeFromBlacklist

removeFromBlacklist(phoneNumber)

Removes a phone number from the blacklist.

Example

// Import classes:
//import com.messente.ApiClient;
//import com.messente.ApiException;
//import com.messente.Configuration;
//import com.messente.auth.*;
//import com.messente.phonebook.BlacklistApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure HTTP basic authorization: basicAuth
HttpBasicAuth basicAuth = (HttpBasicAuth) defaultClient.getAuthentication("basicAuth");
basicAuth.setUsername("YOUR USERNAME");
basicAuth.setPassword("YOUR PASSWORD");

BlacklistApi apiInstance = new BlacklistApi();
String phoneNumber = "phoneNumber_example"; // String | A phone number
try {
    apiInstance.removeFromBlacklist(phoneNumber);
} catch (ApiException e) {
    System.err.println("Exception when calling BlacklistApi#removeFromBlacklist");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
phoneNumber	String	A phone number

Return type

null (empty response body)

Authorization

basicAuth

HTTP request headers

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