# ps.module.BlacklistNumberApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**apiVersionBlacklistnumberInboundGet**](BlacklistNumberApi.md#apiVersionBlacklistnumberInboundGet) | **GET** /api/{version}/blacklistnumber/inbound | [Inbound] List blacklist number
[**apiVersionBlacklistnumberInboundIdDelete**](BlacklistNumberApi.md#apiVersionBlacklistnumberInboundIdDelete) | **DELETE** /api/{version}/blacklistnumber/inbound/{id} | [Inbound] Delete blacklist number
[**apiVersionBlacklistnumberInboundIdPut**](BlacklistNumberApi.md#apiVersionBlacklistnumberInboundIdPut) | **PUT** /api/{version}/blacklistnumber/inbound/{id} | [Inbound] Update blacklist number
[**apiVersionBlacklistnumberInboundPost**](BlacklistNumberApi.md#apiVersionBlacklistnumberInboundPost) | **POST** /api/{version}/blacklistnumber/inbound | [Inbound] Create blacklist number
[**apiVersionBlacklistnumberOutboundGet**](BlacklistNumberApi.md#apiVersionBlacklistnumberOutboundGet) | **GET** /api/{version}/blacklistnumber/outbound | [Outbound] List blacklist number
[**apiVersionBlacklistnumberOutboundIdDelete**](BlacklistNumberApi.md#apiVersionBlacklistnumberOutboundIdDelete) | **DELETE** /api/{version}/blacklistnumber/outbound/{id} | [Outbound] Delete blacklist number
[**apiVersionBlacklistnumberOutboundIdPut**](BlacklistNumberApi.md#apiVersionBlacklistnumberOutboundIdPut) | **PUT** /api/{version}/blacklistnumber/outbound/{id} | [Outbound] Update blacklist number
[**apiVersionBlacklistnumberOutboundPost**](BlacklistNumberApi.md#apiVersionBlacklistnumberOutboundPost) | **POST** /api/{version}/blacklistnumber/outbound | [Outbound] Create blacklist number
[**apiVersionBlacklistnumberOutboundSyncPost**](BlacklistNumberApi.md#apiVersionBlacklistnumberOutboundSyncPost) | **POST** /api/{version}/blacklistnumber/outbound/sync | [Outbound] Sync blacklist number

<a name="apiVersionBlacklistnumberInboundGet"></a>
# **apiVersionBlacklistnumberInboundGet**
> apiVersionBlacklistnumberInboundGet(version, opts)

[Inbound] List blacklist number

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BlacklistNumberApi();
let version = "version_example"; // String | 
let opts = { 
  'sortBy': "sortBy_example", // String | 
  'direction': new ps.module.PhoneSpeakEntitiesEnumsListDirection(), // PhoneSpeakEntitiesEnumsListDirection | 
  'search': "search_example", // String | 
  'limit': 56, // Number | 
  'pageNum': 56 // Number | 
};
apiInstance.apiVersionBlacklistnumberInboundGet(version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **sortBy** | **String**|  | [optional] 
 **direction** | [**PhoneSpeakEntitiesEnumsListDirection**](.md)|  | [optional] 
 **search** | **String**|  | [optional] 
 **limit** | **Number**|  | [optional] 
 **pageNum** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionBlacklistnumberInboundIdDelete"></a>
# **apiVersionBlacklistnumberInboundIdDelete**
> apiVersionBlacklistnumberInboundIdDelete(id, version)

[Inbound] Delete blacklist number

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BlacklistNumberApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionBlacklistnumberInboundIdDelete(id, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionBlacklistnumberInboundIdPut"></a>
# **apiVersionBlacklistnumberInboundIdPut**
> apiVersionBlacklistnumberInboundIdPut(idversion)

[Inbound] Update blacklist number

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BlacklistNumberApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionBlacklistnumberInboundIdPut(idversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreBlacklistNumbersInboundUpdateBlacklistNumberQuery**](PhoneSpeakServiceCoreBlacklistNumbersInboundUpdateBlacklistNumberQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionBlacklistnumberInboundPost"></a>
# **apiVersionBlacklistnumberInboundPost**
> apiVersionBlacklistnumberInboundPost(version)

[Inbound] Create blacklist number

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BlacklistNumberApi();
let version = "version_example"; // String | 

apiInstance.apiVersionBlacklistnumberInboundPost(version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreBlacklistNumbersInboundCreateBlacklistNumberQuery**](PhoneSpeakServiceCoreBlacklistNumbersInboundCreateBlacklistNumberQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionBlacklistnumberOutboundGet"></a>
# **apiVersionBlacklistnumberOutboundGet**
> apiVersionBlacklistnumberOutboundGet(version, opts)

[Outbound] List blacklist number

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BlacklistNumberApi();
let version = "version_example"; // String | 
let opts = { 
  'tenantId': "tenantId_example", // String | 
  'blacklistType': new ps.module.PhoneSpeakEntitiesEnumsBlacklistType(), // PhoneSpeakEntitiesEnumsBlacklistType | 
  'sortBy': "sortBy_example", // String | 
  'direction': new ps.module.PhoneSpeakEntitiesEnumsListDirection(), // PhoneSpeakEntitiesEnumsListDirection | 
  'search': "search_example", // String | 
  'limit': 56, // Number | 
  'pageNum': 56 // Number | 
};
apiInstance.apiVersionBlacklistnumberOutboundGet(version, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **tenantId** | **String**|  | [optional] 
 **blacklistType** | [**PhoneSpeakEntitiesEnumsBlacklistType**](.md)|  | [optional] 
 **sortBy** | **String**|  | [optional] 
 **direction** | [**PhoneSpeakEntitiesEnumsListDirection**](.md)|  | [optional] 
 **search** | **String**|  | [optional] 
 **limit** | **Number**|  | [optional] 
 **pageNum** | **Number**|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionBlacklistnumberOutboundIdDelete"></a>
# **apiVersionBlacklistnumberOutboundIdDelete**
> apiVersionBlacklistnumberOutboundIdDelete(id, version)

[Outbound] Delete blacklist number

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BlacklistNumberApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionBlacklistnumberOutboundIdDelete(id, version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="apiVersionBlacklistnumberOutboundIdPut"></a>
# **apiVersionBlacklistnumberOutboundIdPut**
> apiVersionBlacklistnumberOutboundIdPut(idversion)

[Outbound] Update blacklist number

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BlacklistNumberApi();
let id = "id_example"; // String | 
let version = "version_example"; // String | 

apiInstance.apiVersionBlacklistnumberOutboundIdPut(idversion, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **id** | **String**|  | 
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreBlacklistNumbersOutboundUpdateBlacklistNumberQuery**](PhoneSpeakServiceCoreBlacklistNumbersOutboundUpdateBlacklistNumberQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionBlacklistnumberOutboundPost"></a>
# **apiVersionBlacklistnumberOutboundPost**
> apiVersionBlacklistnumberOutboundPost(version)

[Outbound] Create blacklist number

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BlacklistNumberApi();
let version = "version_example"; // String | 

apiInstance.apiVersionBlacklistnumberOutboundPost(version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreBlacklistNumbersOutboundCreateBlacklistNumberQuery**](PhoneSpeakServiceCoreBlacklistNumbersOutboundCreateBlacklistNumberQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined

<a name="apiVersionBlacklistnumberOutboundSyncPost"></a>
# **apiVersionBlacklistnumberOutboundSyncPost**
> apiVersionBlacklistnumberOutboundSyncPost(version)

[Outbound] Sync blacklist number

### Example
```javascript
import ps.module from 'phonespeakv2_api';
let defaultClient = ps.module.ApiClient.instance;

// Configure OAuth2 access token for authorization: oauth2
let oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

let apiInstance = new ps.module.BlacklistNumberApi();
let version = "version_example"; // String | 

apiInstance.apiVersionBlacklistnumberOutboundSyncPost(version, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **version** | **String**|  | 
 **body** | [**PhoneSpeakServiceCoreBlacklistNumbersOutboundSyncBlacklistNumberQuery**](PhoneSpeakServiceCoreBlacklistNumbersOutboundSyncBlacklistNumberQuery.md)|  | [optional] 

### Return type

null (empty response body)

### Authorization

[oauth2](../README.md#oauth2)

### HTTP request headers

 - **Content-Type**: audio/x-wav, text/plain, application/octet-stream, application/json-patch+json, application/json, text/json, application/_*+json, application/xml, text/xml, application/_*+xml
 - **Accept**: Not defined