Phone Numbers - List Phone Numbers

참조

Service:: Communication

API Version:: 2021-03-07

구매한 모든 전화 번호 목록을 가져옵니다.

GET {endpoint}/phoneNumbers?api-version=2021-03-07

With optional parameters:

GET {endpoint}/phoneNumbers?skip={skip}&top={top}&api-version=2021-03-07

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpoint	path	True	string	통신 리소스(예 https://resourcename.communication.azure.com: )입니다.
api-version	query	True	string	호출할 API의 버전입니다.
skip	query		integer int32	페이지 매김을 위해 건너뛸 항목 수에 대한 선택적 매개 변수입니다. 기본값은 0입니다.
top	query		integer int32	페이지 매김을 위해 반환할 항목 수에 대한 선택적 매개 변수입니다. 기본값은 100입니다.

응답

Name	형식	Description
200 OK	PurchasedPhoneNumbers	Success
Other Status Codes	CommunicationErrorResponse	실패

예제

List purchased phone numbers

Sample Request

HTTP

GET https://resourcename.communication.azure.com//phoneNumbers?api-version=2021-03-07

Sample Response

Status code:: 200

{
  "phoneNumbers": [
    {
      "id": "11234567890",
      "phoneNumber": "+11234567890",
      "countryCode": "US",
      "assignmentType": "user",
      "phoneNumberType": "geographic",
      "capabilities": {
        "calling": "inbound+outbound",
        "sms": "inbound"
      },
      "purchaseDate": "2020-11-19T16:31:49.048Z",
      "cost": {
        "amount": 0.8,
        "currencyCode": "USD",
        "billingFrequency": "monthly"
      }
    }
  ]
}

정의

Name	Description
BillingFrequency	비용이 청구되는 빈도입니다.
CommunicationError	Communication Services 오류입니다.
CommunicationErrorResponse	Communication Services 오류입니다.
PhoneNumberAssignmentType	검색할 전화 번호의 할당 유형입니다. 전화 번호는 사람 또는 애플리케이션에 할당할 수 있습니다.
PhoneNumberCapabilities	전화 번호의 기능입니다.
PhoneNumberCapabilityType	호출에 대한 기능 값입니다.
PhoneNumberCost	단일 전화 번호에 대해 발생하는 비용입니다.
PhoneNumberType	검색할 전화 번호 유형(예: 지리적 또는 tollFree)입니다.
PurchasedPhoneNumber	구매한 전화 번호를 나타냅니다.
PurchasedPhoneNumbers	구매한 전화 번호 목록입니다.

BillingFrequency

비용이 청구되는 빈도입니다.

Name	형식	Description
monthly	string

CommunicationError

Communication Services 오류입니다.

Name	형식	Description
code	string	오류 코드입니다.
details	CommunicationError[]	이 오류로 이어진 특정 오류에 대한 자세한 내용입니다.
innererror	CommunicationError	내부 오류(있는 경우)입니다.
message	string	오류 메시지입니다.
target	string	오류 대상입니다.

CommunicationErrorResponse

Communication Services 오류입니다.

Name	형식	Description
error	CommunicationError	Communication Services 오류입니다.

PhoneNumberAssignmentType

검색할 전화 번호의 할당 유형입니다. 전화 번호는 사람 또는 애플리케이션에 할당할 수 있습니다.

Name	형식	Description
application	string
person	string

PhoneNumberCapabilities

전화 번호의 기능입니다.

Name	형식	Description
calling	PhoneNumberCapabilityType	호출에 대한 기능 값입니다.
sms	PhoneNumberCapabilityType	SMS의 기능 값입니다.

PhoneNumberCapabilityType

호출에 대한 기능 값입니다.

Name	형식	Description
inbound	string
inbound+outbound	string
none	string
outbound	string

PhoneNumberCost

단일 전화 번호에 대해 발생하는 비용입니다.

Name	형식	Description
amount	number	비용 금액입니다.
billingFrequency	BillingFrequency	비용이 청구되는 빈도입니다.
currencyCode	string	비용 금액(예: USD)에 대한 ISO 4217 통화 코드입니다.

PhoneNumberType

검색할 전화 번호 유형(예: 지리적 또는 tollFree)입니다.

Name	형식	Description
geographic	string
tollFree	string

PurchasedPhoneNumber

구매한 전화 번호를 나타냅니다.

Name	형식	Description
assignmentType	PhoneNumberAssignmentType	전화 번호의 할당 유형입니다. 전화 번호는 사람 또는 애플리케이션에 할당할 수 있습니다.
capabilities	PhoneNumberCapabilities	전화 번호의 기능입니다.
cost	PhoneNumberCost	단일 전화 번호에 대해 발생하는 비용입니다.
countryCode	string	전화 번호 국가(예: 미국)의 ISO 3166-2 코드입니다.
id	string	전화 번호의 ID(예: 11234567890)입니다.
phoneNumber	string	전화 번호의 E.164 형식(예: +11234567890)의 문자열입니다.
phoneNumberType	PhoneNumberType	전화 번호 유형(예: 지리적, TollFree)입니다.
purchaseDate	string	전화 번호를 구매한 날짜 및 시간입니다.

PurchasedPhoneNumbers

구매한 전화 번호 목록입니다.

Name	형식	Description
nextLink	string	전화 번호 결과의 다음 페이지에 대한 URL 링크를 나타냅니다.
phoneNumbers	PurchasedPhoneNumber[]	전화 번호 목록을 나타냅니다.