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

# GetRegions

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

Gets available regions in a country.

Allowed roles: `Owner`, `Admin`, `Accountant`.

**Example request:** Get regions with city AACHEN.

Reference: https://docs.voximplant.ai/api-reference/management-api/reference/regulation-address/get-regions

## 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

- `country_code` (string, required) — The country code according to the **ISO 3166-1 alpha-2**
- `phone_category_name` (string, required) — The phone category name. See the [GetPhoneNumberCategories] method
- `city_name` (string, optional) — The pattern of city's name
- `count` (integer, optional) — The returned regions count
- `offset` (integer, optional) — The first **N** records are skipped in the output

## Response

### 200

Successful response

- `result` (list of RegulationRegionRecord, optional)
- `count` (integer, optional)

## Types

### RegulationRegionRecord

The [GetRegions] function result.

- `phone_region_id` (integer, optional) — The regulation address ID
- `phone_region_name` (string, optional) — The region name
- `phone_region_code` (string, optional) — The phone region code
- `is_need_regulation_address` (boolean, optional) — Whether need to confirm the address
- `regulation_address_type` (string, optional) — The regulation address type. Available: LOCAL, NATIONAL, WORLDWIDE

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "result": [
    {
      "phone_region_id": 101,
      "phone_region_name": "AACHEN",
      "phone_region_code": "0241",
      "is_need_regulation_address": true,
      "regulation_address_type": "LOCAL"
    }
  ],
  "count": 1
}
```

**SDK Code**

```python Example 1
import requests

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

querystring = {"country_code":"DE","phone_category_name":"mobile","city_name":"AACHEN","count":"10","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/GetRegions?country_code=DE&phone_category_name=mobile&city_name=AACHEN&count=10&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/GetRegions?country_code=DE&phone_category_name=mobile&city_name=AACHEN&count=10&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/GetRegions?country_code=DE&phone_category_name=mobile&city_name=AACHEN&count=10&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/GetRegions?country_code=DE&phone_category_name=mobile&city_name=AACHEN&count=10&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/GetRegions?country_code=DE&phone_category_name=mobile&city_name=AACHEN&count=10&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/GetRegions?country_code=DE&phone_category_name=mobile&city_name=AACHEN&count=10&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/GetRegions?country_code=DE&phone_category_name=mobile&city_name=AACHEN&count=10&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()
```