> For a complete documentation index, fetch https://docs.voximplant.ai/llms.txt

# GetPstnBlackList

POST https://api.voximplant.com/platform_api/GetPstnBlackList

Get the whole PSTN blacklist.

Allowed roles: `Owner`, `Admin`.

Reference: https://docs.voximplant.ai/api-reference/management-api/reference/pstn-blacklist/get-pstn-black-list

## Authentication

- `Authorization` header (bearer token, required) — Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the `Authorization` header as a Bearer value: ``` Authorization: Bearer $VOXIMPLANT_TOKEN ``` See [Authorization](/api-reference/management-api/authorization) for ready-to-copy snippets in bash, Python, Node.js and Go that turn your `credentials.json` into a token.

## Request

### Query parameters

- `pstn_blacklist_id` (integer, optional) — The PSTN black list item ID for filter
- `pstn_blacklist_phone` (string, optional) — The phone number in format e164 for filter
- `count` (integer, optional, default: 20) — The max returning record count
- `offset` (integer, optional, default: 0) — The first **N** records are skipped in the output

## Response

### 200

Successful response

- `result` (list of PstnBlackListInfoType, optional)
- `total_count` (integer, optional) — The total found phone numbers count
- `count` (integer, optional) — The returned phone numbers count

## Types

### PstnBlackListInfoType

The PSTN black list item info.

- `pstn_blacklist_id` (integer, optional) — The black list item ID
- ` pstn_blacklist_phone  ` (string, optional) — The phone number
- `pstn_blacklist_phone` (string, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "result": [
    {
      "pstn_blacklist_id": 1024,
      "pstn_blacklist_phone": "+14155552671"
    },
    {
      "pstn_blacklist_id": 1025,
      "pstn_blacklist_phone": "+442071838750"
    },
    {
      "pstn_blacklist_id": 1026,
      "pstn_blacklist_phone": "+819012345678"
    }
  ],
  "total_count": 3,
  "count": 3
}
```

**SDK Code**

```python Example 1
import requests

url = "https://api.voximplant.com/platform_api/GetPstnBlackList"

querystring = {"pstn_blacklist_id":"1024","pstn_blacklist_phone":"+14155552671","count":"20","offset":"0"}

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers, params=querystring)

print(response.json())
```

```javascript Example 1
const url = 'https://api.voximplant.com/platform_api/GetPstnBlackList?pstn_blacklist_id=1024&pstn_blacklist_phone=%2B14155552671&count=20&offset=0';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Example 1
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.voximplant.com/platform_api/GetPstnBlackList?pstn_blacklist_id=1024&pstn_blacklist_phone=%2B14155552671&count=20&offset=0"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Example 1
require 'uri'
require 'net/http'

url = URI("https://api.voximplant.com/platform_api/GetPstnBlackList?pstn_blacklist_id=1024&pstn_blacklist_phone=%2B14155552671&count=20&offset=0")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java Example 1
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.voximplant.com/platform_api/GetPstnBlackList?pstn_blacklist_id=1024&pstn_blacklist_phone=%2B14155552671&count=20&offset=0")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php Example 1
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.voximplant.com/platform_api/GetPstnBlackList?pstn_blacklist_id=1024&pstn_blacklist_phone=%2B14155552671&count=20&offset=0', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Example 1
using RestSharp;

var client = new RestClient("https://api.voximplant.com/platform_api/GetPstnBlackList?pstn_blacklist_id=1024&pstn_blacklist_phone=%2B14155552671&count=20&offset=0");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Example 1
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.voximplant.com/platform_api/GetPstnBlackList?pstn_blacklist_id=1024&pstn_blacklist_phone=%2B14155552671&count=20&offset=0")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```