Available Regions

You can use the Available Regions API to list all of the regions that have numbers assigned to a project.

List available regions

Lists all regions for numbers provided for the project ID.

SecurityBasic or OAuth2.0

Request

projectId

required

string

Found on your Sinch Customer Dashboard. Settings > Projects.

Example: YOUR_projectId

types

Array of strings

Only return regions for which numbers are provided with the given types v1: MOBILE, LOCAL or TOLL_FREE.

NUMBER_TYPE_UNSPECIFIED: Null value
MOBILE: Numbers that belong to a specific range.
LOCAL: Numbers that are assigned to a specific geographic region.
TOLL_FREE: Number that are free of charge for the calling party but billed for all arriving calls.

Items Enum: "NUMBER_TYPE_UNSPECIFIED" "MOBILE" "LOCAL" "TOLL_FREE"

Responses

200

A successful response.

Array of objects (List of regions for which numbers are provided.)

Array

regionCode

string

ISO 3166-1 alpha-2 region code. Examples: US, UK or SE.

regionName

string

Display name of the region. Examples: United States, United Kingdom or Sweden.

types

Array of strings (Type)

A list of the different number types available. Examples: MOBILE or LOCAL.

Items Enum:	Description
MOBILE	Numbers that belong to a specific range.
LOCAL	Numbers that are assigned to a specific geographic region.
TOLL_FREE	Numbers that are free of charge for the calling party but billed for all arriving calls.

400

400 Invalid Argument error

404

404 Not Found error

500

500 Internal Server error

get/v1/projects/{projectId}/availableRegions

Request samples

Response samples

application/json

{"availableRegions": [{"regionCode": "US",
"regionName": "United States",
"types": ["MOBILE"
]
}
]
}