Phone Numbers - List Available Countries

服务:

Communication

API 版本:

2025-02-11

获取支持的国家/地区列表。

GET {endpoint}/availablePhoneNumbers/countries?api-version=2025-02-11

具有可选参数:

GET {endpoint}/availablePhoneNumbers/countries?skip={skip}&maxPageSize={maxPageSize}&api-version=2025-02-11

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (url)	通信资源，例如 https://resourcename.communication.azure.com
api-version	query	True	string	要调用的 API 版本
maxPageSize	query		integer (int32)	用于返回的条目数的可选参数，用于分页目的。 默认值为 100。
skip	query		integer (int32)	一个可选参数，用于用于分页目的要跳过的条目数。 默认值为 0。

请求头

名称	必需	类型	说明
accept-language		string	响应中要显示在本地化字段中的区域设置。 例如“en-US”

响应

名称	类型	说明
200 OK	PhoneNumberCountries	成功
Other Status Codes	CommunicationErrorResponse	失败

示例

Get countries

示例请求

HTTP

GET https://resourcename.communication.azure.com//availablePhoneNumbers/countries?api-version=2025-02-11

示例响应

状态代码:

200

{
  "countries": [
    {
      "localizedName": "Canada",
      "countryCode": "CA"
    },
    {
      "localizedName": "United States",
      "countryCode": "US"
    }
  ]
}

定义

名称	说明
CommunicationError	通信服务错误。
CommunicationErrorResponse	通信服务错误。
PhoneNumberCountries	表示国家/地区列表周围的包装器。
PhoneNumberCountry	表示国家/地区。

CommunicationError

Object

通信服务错误。

名称	类型	说明
code	string	错误代码。
details	CommunicationError[]	有关导致此错误的特定错误的更多详细信息。
innererror	CommunicationError	内部错误（如果有）。
message	string	错误消息。
target	string	错误目标。

CommunicationErrorResponse

Object

通信服务错误。

名称	类型	说明
error	CommunicationError	通信服务错误。

PhoneNumberCountries

Object

表示国家/地区列表周围的包装器。

名称	类型	说明
countries	PhoneNumberCountry[]	表示国家/地区的基础列表。
nextLink	string	表示指向下一页的 URL 链接

PhoneNumberCountry

Object

表示国家/地区。

名称	类型	说明
countryCode	string	表示国家/地区的缩写名称。
localizedName	string	表示国家/地区的名称。