Accounts - Get Number

服务:

Voice Services

API 版本:

2024-02-29-preview

获取数字。
使用特定号码的电话号码获取特定号码的详细信息。

GET https:///accounts/{accountName}/numbers/{telephoneNumber}?api-version=2024-02-29-preview

URI 参数

名称	在	必需	类型	说明
accountName	path	True	string minLength: 1 maxLength: 100 pattern: ^([A-Za-z0-9_-]+)$	帐户的名称。
telephoneNumber	path	True	string minLength: 1 maxLength: 16 pattern: ^\+[1-9]\d+$	E.164 格式的电话号码。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求头

名称	必需	类型	说明
If-Match		string	仅当实体与此字符串匹配时，请求才应继续。
If-None-Match		string	仅当没有实体与此字符串匹配时，请求才应继续。
If-Unmodified-Since		string (date-time)	仅当此时间之后未修改实体时，请求才应继续。
If-Modified-Since		string (date-time)	仅当此时间之后修改实体时，请求才应继续。
x-ms-client-request-id		string (uuid)	请求的不透明、全局唯一的客户端生成的字符串标识符。

响应

名称	类型	说明
200 OK	NumberResource	请求已成功。 标头 ETag: string x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	意外的错误响应。 标头 x-ms-error-code: string

安全性

OAuth2Auth

类型: oauth2
流向: application
令牌 URL: https://login.microsoftonline.com/common/oauth2/v2.0/token

作用域

名称	说明
https://func-voiceservice-rp-prod-eastuseuap.azurewebsites.net/.default

示例

Get a Number from an Account.

示例请求

HTTP

GET https:///accounts/contoso/numbers/+15105850321?api-version=2024-02-29-preview

示例响应

状态代码:

200

{
  "telephoneNumber": "+15105850321",
  "accountName": "contoso",
  "serviceDetails": {
    "teamsOperatorConnect": {
      "enabled": true,
      "assignmentStatus": "assigned",
      "configuration": {
        "usage": "CallingUserAssignment",
        "choosableCapabilities": [
          "InboundCalling"
        ]
      }
    }
  },
  "configuration": {
    "customSipHeader": "contoso-commsgw"
  },
  "serviceProvisioningStatus": "synced",
  "serviceProvisioningErrors": []
}

定义

名称	说明
Azure.Core.Foundations.Error	错误对象。
Azure.Core.Foundations.ErrorResponse	包含错误详细信息的响应。
Azure.Core.Foundations.InnerError	包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。
AzureOperatorCallProtectionNumberDetails	有关此号码的 Azure 操作员呼叫保护服务的详细信息。
NumberConfiguration	此数字的配置。
NumberResource	Azure 通信网关中预配的电话号码的配置。
NumberServiceDetails	为电话号码配置后端服务。
ServiceProvisioningStatus	任何相关后端服务上对象的预配状态。
TeamsDirectRoutingNumberDetails	此号码上的 Teams 直接路由服务的详细信息。
TeamsOperatorConnectNumberConfig	Teams 操作员连接电话号码的电话号码配置。
TeamsOperatorConnectNumberDetails	此号码上的 Teams 操作员连接服务的详细信息。
TeamsPhoneMobileNumberConfig	Teams 电话移动电话号码的电话号码配置。
TeamsPhoneMobileNumberDetails	此号码上的 Teams 电话移动服务的详细信息。
TelephoneNumberAssignmentStatus	指示是否为用户分配数字。
ZoomPhoneCloudPeeringNumberDetails	此号码上的 Zoom Phone 云对等互连服务的详细信息。

Azure.Core.Foundations.Error

Object

错误对象。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
details	Azure.Core.Foundations.Error[]	导致此报告错误的特定错误的详细信息数组。
innererror	Azure.Core.Foundations.InnerError	包含与当前对象有关错误的更具体信息的对象。
message	string	错误的人工可读表示形式。
target	string	错误的目标。

Azure.Core.Foundations.ErrorResponse

Object

包含错误详细信息的响应。

名称	类型	说明
error	Azure.Core.Foundations.Error	错误对象。

Azure.Core.Foundations.InnerError

Object

包含有关错误的更具体信息的对象。 根据Microsoft一个 API 指南 - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors。

名称	类型	说明
code	string	服务器定义的错误代码集之一。
innererror	Azure.Core.Foundations.InnerError	内部错误。

AzureOperatorCallProtectionNumberDetails

Object

有关此号码的 Azure 操作员呼叫保护服务的详细信息。

名称	类型	说明
enabled	boolean	指示是否在此数字上启用服务的布尔值。

NumberConfiguration

Object

此数字的配置。

名称	类型	说明
customSipHeader	string minLength: 1 maxLength: 100 pattern: ^([A-Za-z0-9_-])+$	要用于此数字的自定义 SIP 标头的内容。 只能包含字母、数字、下划线和短划线。 长度可达 100 个字符。 自定义标头的名称设置为 Azure 通信网关上的预配平台配置的一部分。

NumberResource

Object

Azure 通信网关中预配的电话号码的配置。

名称	类型	说明
accountName	string minLength: 1 maxLength: 100 pattern: ^([A-Za-z0-9_-]+)$	帐户的名称。 只能包含字母、数字、下划线和短划线，并且区分大小写。 长度可达 100 个字符。
configuration	NumberConfiguration	此数字的配置。
serviceDetails	NumberServiceDetails	为此数字配置单个后端服务。
serviceProvisioningErrors	Azure.Core.Foundations.Error[]	与此资源的预配相关的任何错误。
serviceProvisioningStatus	ServiceProvisioningStatus	与此资源关联的预配操作的状态。
telephoneNumber	string minLength: 1 maxLength: 16 pattern: ^\+[1-9]\d+$	E.164 格式的电话号码。

NumberServiceDetails

Object

为电话号码配置后端服务。

名称	类型	说明
azureOperatorCallProtection	AzureOperatorCallProtectionNumberDetails	有关此号码的 Azure 操作员呼叫保护服务的详细信息。
teamsDirectRouting	TeamsDirectRoutingNumberDetails	此号码上的 Teams 直接路由服务的详细信息。
teamsOperatorConnect	TeamsOperatorConnectNumberDetails	此号码上的 Teams 操作员连接服务的详细信息。
teamsPhoneMobile	TeamsPhoneMobileNumberDetails	此号码上的 Teams 电话移动服务的详细信息。
zoomPhoneCloudPeering	ZoomPhoneCloudPeeringNumberDetails	此号码上的 Zoom Phone 云对等互连服务的详细信息。

ServiceProvisioningStatus

枚举

任何相关后端服务上对象的预配状态。

值	说明
failed	对象预配操作与相关的后端服务失败。
pending	对象正在等待预配。
synced	该对象已与相关的后端服务同步。

TeamsDirectRoutingNumberDetails

Object

此号码上的 Teams 直接路由服务的详细信息。

名称	类型	说明
enabled	boolean	指示是否在此数字上启用服务的布尔值。

TeamsOperatorConnectNumberConfig

Object

Teams 操作员连接电话号码的电话号码配置。

名称	类型	默认值	说明
acquiredCapabilities	string[]		此电话号码的获取功能。
additionalUsages	string[]		此电话号码的其他用法。
allowTenantAddressUpdate	boolean	False	如果允许企业更新此电话号码的地址。
availableCapabilities	string[]		此电话号码的可用功能。
choosableCapabilities	string[]		此电话号码的可选功能。
civicAddressId	string		要用作此电话号码紧急地址的公民地址的 ID。
displayedCountryCode	string		要使用此电话号码显示的国家/地区代码
locationId	string		要用作此电话号码紧急地址的位置的 ID。
usage	string		此电话号码的用法。

TeamsOperatorConnectNumberDetails

Object

此号码上的 Teams 操作员连接服务的详细信息。

名称	类型	说明
assignmentStatus	TelephoneNumberAssignmentStatus	此数字的分配状态。
configuration	TeamsOperatorConnectNumberConfig	此号码上 Teams 操作员 Connect 的配置。
enabled	boolean	指示是否在此数字上启用服务的布尔值。

TeamsPhoneMobileNumberConfig

Object

Teams 电话移动电话号码的电话号码配置。

名称	类型	默认值	说明
acquiredCapabilities	string[]		此电话号码的获取功能。
additionalUsages	string[]		此电话号码的其他用法。
allowTenantAddressUpdate	boolean	False	如果允许企业更新此电话号码的地址。
availableCapabilities	string[]		此电话号码的可用功能。
choosableCapabilities	string[]		此电话号码的可选功能。
civicAddressId	string		要用作此电话号码紧急地址的公民地址的 ID。
displayedCountryCode	string		要使用此电话号码显示的国家/地区代码
locationId	string		要用作此电话号码紧急地址的位置的 ID。
usage	string		此电话号码的用法。

TeamsPhoneMobileNumberDetails

Object

此号码上的 Teams 电话移动服务的详细信息。

名称	类型	说明
assignmentStatus	TelephoneNumberAssignmentStatus	此数字的分配状态。
configuration	TeamsPhoneMobileNumberConfig	此号码上 Teams Phone Mobile 的配置。
enabled	boolean	指示是否在此数字上启用服务的布尔值。

TelephoneNumberAssignmentStatus

枚举

指示是否为用户分配数字。

值	说明
assigned	电话号码分配给用户。
unassigned	电话号码未分配给用户。

ZoomPhoneCloudPeeringNumberDetails

Object

此号码上的 Zoom Phone 云对等互连服务的详细信息。

名称	类型	说明
enabled	boolean	指示是否在此数字上启用服务的布尔值。