GetZIPCodes

POST

https://api.voximplant.com/platform_api/GetZIPCodes

POST

/platform_api/GetZIPCodes

curl -X POST "https://api.voximplant.com/platform_api/GetZIPCodes?country_code=DE&phone_region_code=49&count=10&offset=0" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Example 1

{
  "result": [
    {
      "city": "Berlin",
      "zip_code": "10115"
    },
    {
      "city": "Munich",
      "zip_code": "80331"
    },
    {
      "city": "Hamburg",
      "zip_code": "20095"
    },
    {
      "city": "Cologne",
      "zip_code": "50667"
    },
    {
      "city": "Frankfurt am Main",
      "zip_code": "60311"
    },
    {
      "city": "Stuttgart",
      "zip_code": "70173"
    },
    {
      "city": "Düsseldorf",
      "zip_code": "40213"
    },
    {
      "city": "Dortmund",
      "zip_code": "44135"
    },
    {
      "city": "Essen",
      "zip_code": "45127"
    },
    {
      "city": "Leipzig",
      "zip_code": "04109"
    }
  ],
  "count": 10
}

Searches for available zip codes.

Allowed roles: Owner, Admin, Accountant.

Example request: Search for zip codes in Germany.

Authentication

AuthorizationBearer

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 for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

country_codestringRequired

The country code according to the ISO 3166-1 alpha-2

phone_region_codestringOptional

The phone region code

countintegerOptionalDefaults to 20

The max returning record count

offsetintegerOptionalDefaults to 0

The first N records are skipped in the output

Response

Successful response

resultlist of objectsOptional

The ZipCode records

countintegerOptional

The returned zip codes count