ProvidersGET

List provider regions

Returns the regions a provider is rolled out to. supported reports whether the provider runs in the region at all; allocatable reports whether new accounts can currently be bound there.

https://api.unifyport.ai/v1/providers/{provider}/regions

Headers

X-Api-Key

stringrequired

Workspace API key. The workspace is resolved from this header.

Path parameters

provider

stringrequired

Identifier used in the providers route.

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp_protocol, x, x_client, twitter_client

Request body

This endpoint does not require a JSON request body.

Response body

provider

string

Provider whose regional availability is returned.

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp_protocol

regions[]

object[]

Region list; each entry contains supported and allocatable flags.

region

string

Provider deployment region identifier.

supported

boolean

Whether the provider runs in this region.

allocatable

boolean

Whether new accounts can currently be allocated in this region.

Responses

200

200 OK

Request succeeded. See the example response body.

400

Bad Request

The request body, path, or parameters are invalid.

401

Unauthorized

The X-Api-Key header is missing or invalid.

500

Internal Server Error

The service encountered an unexpected error.

Request

curl -X GET https://api.unifyport.ai/v1/providers/{provider}/regions \
  -H "X-Api-Key: <YOUR_API_KEY>"

Response

{
  "data": {
    "provider": "telegram",
    "regions": [
      {
        "region": "global",
        "supported": true,
        "allocatable": true
      }
    ]
  }
}