Phone Numbers - List Available Localities

服务:

Communication

API 版本:

2022-12-01

获取具有可用电话号码的城镇列表。

GET {endpoint}/availablePhoneNumbers/countries/{countryCode}/localities?api-version=2022-12-01

具有可选参数:

GET {endpoint}/availablePhoneNumbers/countries/{countryCode}/localities?skip={skip}&maxPageSize={maxPageSize}&administrativeDivision={administrativeDivision}&api-version=2022-12-01

URI 参数

名称	在	必需	类型	说明
countryCode	path	True	string	ISO 3166-2 国家/地区代码，例如美国。
endpoint	path	True	string (url)	通信资源，例如 https://resourcename.communication.azure.com
api-version	query	True	string	要调用的 API 版本
administrativeDivision	query		string	要在其中搜索区号的州或省的名称的可选参数。
maxPageSize	query		integer (int32)	用于返回的条目数的可选参数，用于分页目的。 默认值为 100。
skip	query		integer (int32)	一个可选参数，用于用于分页目的要跳过的条目数。 默认值为 0。

请求头

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

响应

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

示例

Get PhoneNumber Search Result

示例请求

HTTP

GET https://resourcename.communication.azure.com//availablePhoneNumbers/countries/CA/localities?api-version=2022-12-01

示例响应

状态代码:

200

{
  "phoneNumberLocalities": [
    {
      "localizedName": "Vancouver",
      "administrativeDivision": {
        "localizedName": "British Columbia",
        "abbreviatedName": "BC"
      }
    },
    {
      "localizedName": "Toronto",
      "administrativeDivision": {
        "localizedName": "Ontario",
        "abbreviatedName": "ON"
      }
    }
  ]
}

定义

名称	说明
CommunicationError	通信服务错误。
CommunicationErrorResponse	通信服务错误。
PhoneNumberAdministrativeDivision	表示行政分区。 例如州或省/
PhoneNumberLocalities	表示城市或城镇列表周围的包装器。
PhoneNumberLocality	表示一个区域。

CommunicationError

Object

通信服务错误。

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

CommunicationErrorResponse

Object

通信服务错误。

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

PhoneNumberAdministrativeDivision

Object

表示行政分区。 例如州或省/

名称	类型	说明
abbreviatedName	string	表示地方行政分区的缩写名称。 例如州或省缩写，如西澳大利亚州（华盛顿）。
localizedName	string	表示区域管理分区的本地化名称。 例如州或省本地化名称。

PhoneNumberLocalities

Object

表示城市或城镇列表周围的包装器。

名称	类型	说明
nextLink	string	表示指向下一页的 URL 链接。
phoneNumberLocalities	PhoneNumberLocality[]	表示地方的基础列表，例如城市或城镇。

PhoneNumberLocality

Object

表示一个区域。

名称	类型	说明
administrativeDivision	PhoneNumberAdministrativeDivision	表示行政分区。 例如州或省/
localizedName	string	表示本地化的区域名称。